Manage orders - Get customer subscriptions

Usługa:: Partner Center Rest

Wersja interfejsu API:: v1

Pobiera subskrypcje dla klienta partnera za pomocą identyfikatora tenant Microsoft Entra.

GET https://api.partnercenter.microsoft.com/v{version}/customers/{customer_id}/subscriptions

Z parametrami opcjonalnymi:

GET https://api.partnercenter.microsoft.com/v{version}/customers/{customer_id}/subscriptions?order_id={order_id}&mpn_id={mpn_id}&product_type={product_type}&product_subtype={product_subtype}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
customer_id	path	True	string	Identyfikator dzierżawcy Microsoft Entra klienta.
version	path	True	string	Wersja API Partner Center. Użyj v1.
mpn_id	query		string	Filtruje subskrypcje według PartnerID resellera. Ten parametr nie może być łączony z order_id.
order_id	query		string	Filtruje subskrypcje według identyfikatora zamówienia. Ten parametr nie może być łączony z mpn_id, product_type ani product_subtype.
product_subtype	query		string	Filtruje subskrypcje według podtypu produktu. Użycie z product_type.
product_type	query		string	Filtruje subskrypcje według typu produktu.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Authorization	True	string	Token elementu nośnego autoryzacji
ms-correlationid		string	Służy do wewnętrznego śledzenia żądań. Jeśli nie podano identyfikatora ms-correlationid, serwer wygeneruje nowy dla każdego żądania
ms-cv		string	Służy do wewnętrznego śledzenia żądań. Jeśli nie podano ms-cv, serwer wygeneruje nowy dla każdego żądania
ms-requestid		string	Służy do zapewnienia idempotentności żądań. Jeśli nie podano identyfikatora ms-requestid, serwer wygeneruje nowy dla każdego żądania

Odpowiedzi

Nazwa	Typ	Opis
200 OK	SubscriptionCollection	Żądanie zakończyło się pomyślnie. Treść odpowiedzi zawiera subskrypcje. Media Types: "application/json", "text/json"
400 Bad Request		Brak danych wejściowych lub nieprawidłowy. Treść odpowiedzi udostępni szczegóły błędu. Media Types: "application/json", "text/json"
401 Unauthorized		Żądanie nie zostało uwierzytelnione. Klient musi najpierw uwierzytelnić się za pomocą usługi interfejsu API partnera. Media Types: "application/json", "text/json"
403 Forbidden		Żądanie zostało uwierzytelnione, ale zostało odrzucone, ponieważ obiekt wywołujący nie ma praw do jego wywołania. Media Types: "application/json", "text/json"
404 Not Found		Zasób nie został znaleziony lub niedostępny z podanymi parametrami wejściowymi. Media Types: "application/json", "text/json"
500 Internal Server Error		Usługa interfejsu API partnera lub jedna z jego zależności nie spełniła żądania. Osoby wywołujące mogą ponowić próbę. Media Types: "application/json", "text/json"

Definicje

Nazwa	Opis
BenefitScheduledNextTermInstructions	Reprezentuje instrukcje stosowane do świadczenia na początku następnego okresu.
ItemType	Reprezentuje zasób typu przedmiotu.
Link	Reprezentuje zasób linkowy.
NextChargeInstructions	Oznacza instrukcje rozliczeniowe, które mają zostać zastosowane na początku następnego semestru subskrypcji.
PriceBenefit	Oznacza korzyść cenową zastosowaną do pozycji liniowej lub subskrypcji. Obecnie jedynym rodzajem korzyści jest CSP Growth Margin, wskazywana przez rodzaj GrowthMargin; surowiec jest ukształtowany tak, aby mógł przenosić dodatkowe rodzaje korzyści w przyszłych wydaniach. Korzyści cenowe są automatycznie stosowane przez usługę i są tylko do odczytu, więc każda wartość podana na żądaniu jest nadpisywana. Efekt pieniężny korzyści odzwierciedla się w istniejących właściwościach cenowych; to źródło wskazuje jedynie, który produkt dyskontowy został zastosowany.
PurchaseCommitment	Reprezentuje zasób zobowiązania zakupowego.
RefundableQuantity	Reprezentuje zwrotne zasoby ilościowe.
RefundableQuantityDetail	Reprezentuje źródło informacji o ilościach zwrotnych.
RefundOption	Reprezentuje opcję zwrotu.
ResourceAttributes	Reprezentuje zasób atrybutów zasobów.
ResourceLinks	Reprezentuje zasób powiązany z zasobami.
ScheduledAction	Reprezentuje zasób zaplanowanej akcji.
Scope	Reprezentuje zasób zakresu.
StringStringKeyValuePair	Reprezentuje zasób pary wartości klucz.
Subscription	Reprezentuje zasob subskrypcji.
SubscriptionCollection	Reprezentuje zasób do zbierania zasobów.
SubscriptionLineItemDetail	Reprezentuje zasób szczegółowy dotyczący pozycji subskrypcyjnej.
SubscriptionLinks	Reprezentuje źródło linków do subskrypcji.
SubscriptionProductTerm	Reprezentuje zasób terminowy produktu.
SubscriptionScheduledNextTermInstructions	Reprezentuje zaplanowany zasób instrukcji w następnym semestrze.

BenefitScheduledNextTermInstructions

Objekt

Reprezentuje instrukcje stosowane do świadczenia na początku następnego okresu.

Nazwa	Typ	Opis
billingCycle	enum: annual biennial monthly none one_time quadrennial quinquennial triennial unknown	Cykl rozliczeniowy, aby aplikować na kolejny semestr. Możliwe wartości to: 'nieznane', 'miesięczne', 'roczne', 'brak', 'one_time', 'triennale', 'dwuletnie', 'czteroletnie', 'pięcioroczne'.
productCode	string	Kod produktu do zakupu na kolejny semestr.
productId	string	Identyfikator produktu do zakupu na kolejny semestr.
purchaseCommitment	PurchaseCommitment	Zobowiązanie do zakupu do złożenia wniosku na kolejny okres.
skuId	string	Identyfikator SKU, który można kupić na następny semestr.
termDuration	string	Czas trwania kolejnego semestru, w formacie ISO 8601.

ItemType

Objekt

Reprezentuje zasób typu przedmiotu.

Nazwa	Typ	Opis
displayName	string	Nazwa wyświetlana partnerom.
id	string	Unikalny identyfikator dla typu przedmiotu. Wartość to zazwyczaj GUID.
skuCategories	string[]	Kategorie SKU związane z typem produktu.
subType	ItemType	Dodatkowy podtyp związany z typem przedmiotu.

Link

Objekt

Reprezentuje zasób linkowy.

Nazwa	Typ	Opis
body	string	Ciało do linku.
headers	StringStringKeyValuePair[]	Zbiór nagłówków powiązanych z tym linkiem.
method	string	Metoda linku.
uri	string	URI dla powiązanego źródła.

NextChargeInstructions

Objekt

Oznacza instrukcje rozliczeniowe, które mają zostać zastosowane na początku następnego semestru subskrypcji.

Nazwa	Typ	Opis
product	SubscriptionProductTerm	Produkt i termin rozliczeniowy do naliczenia w następnym terminie.
quantity	integer (int32)	Kwota do rozliczenia w następnym semestrze.

PriceBenefit

Objekt

Oznacza korzyść cenową zastosowaną do pozycji liniowej lub subskrypcji. Obecnie jedynym rodzajem korzyści jest CSP Growth Margin, wskazywana przez rodzaj GrowthMargin; surowiec jest ukształtowany tak, aby mógł przenosić dodatkowe rodzaje korzyści w przyszłych wydaniach. Korzyści cenowe są automatycznie stosowane przez usługę i są tylko do odczytu, więc każda wartość podana na żądaniu jest nadpisywana. Efekt pieniężny korzyści odzwierciedla się w istniejących właściwościach cenowych; to źródło wskazuje jedynie, który produkt dyskontowy został zastosowany.

Nazwa	Typ	Opis
availabilityId	string	Identyfikator dostępności produktu z rabatem z korzyścią cenową. Wskazuje konkretny poziom ceny dyskontowej, który został zastosowany.
productCode	string	Uniwersalna nazwa produktu (UPN) produktu z rabatem z korzyściami cenowymi.
productId	string	Identyfikator produktu produktu z rabatem na korzyści cenowe.
skuId	string	Identyfikator SKU produktu z rabatem z korzyścią cenową.
type	string	Typ korzyści cenowej. Obecnie obsługiwany jest tylko GrowthMargin.

PurchaseCommitment

Objekt

Reprezentuje zasób zobowiązania zakupowego.

Nazwa	Typ	Opis
amount	number (double)	Kwota pieniężna.
currency	string	Trzyliterowy kod walutowy ISO.
grain	string	Ziarno pomiarowe użyte dla tej wartości.

RefundableQuantity

Objekt

Reprezentuje zwrotne zasoby ilościowe.

Nazwa	Typ	Opis
details	RefundableQuantityDetail[]	Zbiór szczegółów związanych z tą zwrotną ilością.
totalQuantity	integer (int32)	Całkowita kwota zwrotna.

RefundableQuantityDetail

Objekt

Reprezentuje źródło informacji o ilościach zwrotnych.

Nazwa	Typ	Opis
allowedUntilDateTime	string (date-time)	Dozwolone do czasu zwrotu dla szczegółu kwoty zwrotnej. Używa formatu data i czasu ISO 8601.
quantity	integer (int32)	Liczba jednostek.

RefundOption

Objekt

Reprezentuje opcję zwrotu.

Nazwa	Typ	Opis
expiresAt	string (date-time)	Termin wygasa w przypadku opcji zwrotu. Używa formatu data i czasu ISO 8601.
type	string	Rodzaj opcji zwrotu pieniędzy.

ResourceAttributes

Objekt

Reprezentuje zasób atrybutów zasobów.

Nazwa	Typ	Opis
etag	string	Tag podmiotu używany do kontroli współbieżności.
objectType	string	Typ obiektu dla atrybutów zasobów.

ResourceLinks

Objekt

Reprezentuje zasób powiązany z zasobami.

Nazwa	Typ	Opis
next	Link	Dodatkowe powiązania to linki do zasobów.
previous	Link	Dodatkowe powiązania z linkami do zasobów.
self	Link	Dodatkowe powiązania z linkami do zasobów.

ScheduledAction

Objekt

Reprezentuje zasób zaplanowanej akcji.

Nazwa	Typ	Opis
actionType	enum: Cancel RenewToExtendedServiceTerm RenewToNewTerm Transition	Akcja, która ma zostać wykonana. Obsługiwane wartości to RenewToExtendedServiceTerm, Cancel, RenewToNewTerm oraz Transition.
effectiveDate	string (date-time)	Data i godzina wejścia w życie zaplanowanej akcji CustomDate, w formacie ISO 8601.
instructions	BenefitScheduledNextTermInstructions	Instrukcje dotyczące produktu, ilości i terminu dla zaplanowanej zmiany. Nie używa się do anulowania.
scheduleType	enum: BillingCycleEnd CustomDate TermEnd	Gdy działanie wejdzie w życie. Obsługiwane wartości to TermEnd, BillingCycleEnd oraz CustomDate.

Scope

Objekt

Reprezentuje zasób zakresu.

Nazwa	Typ	Opis
entitlementId	string	Unikalny identyfikator uprawnień. Wartość to zazwyczaj GUID.
managementGroupId	string	Unikalny identyfikator grupy zarządzającej. Wartość to zazwyczaj GUID.
resourceGroupId	string	Unikalny identyfikator grupy zasobów. Wartość to zazwyczaj GUID.
subscriptionId	string	Unikalny identyfikator (GUID) subskrypcji. Wartość to zazwyczaj GUID.
type	string	Typ lunety.

StringStringKeyValuePair

Objekt

Reprezentuje zasób pary wartości klucz.

Nazwa	Typ	Opis
key	string	Klucz do pary klucz i wartość.
value	string	Wartość pary klucz wartość.

Subscription

Objekt

Reprezentuje zasob subskrypcji.

Nazwa	Typ	Opis
actionTaken	boolean	Czy podjęto tę akcję subskrypcyjną.
actions	string[]	Zbiór działań związanych z tą subskrypcją.
additionalPartnerIds	string[]	Dodatkowe PartnerID resellerów przypisane subskrypcji przez dystrybutorów na rynkach UE/EFTA.
attentionNeeded	boolean	Czy ta subskrypcja potrzebowała uwagi.
attentionReason	string	To jest powód subskrypcji.
attributes	ResourceAttributes	Dodatkowe atrybuty związane z subskrypcją.
autoRenewEnabled	boolean	Czy ta subskrypcja jest automatycznie odnawiana.
billingCycle	enum: annual biennial monthly none one_time quadrennial quinquennial triennial unknown	Częstotliwość rozliczeń. Wartości wspierane to: nieznane, miesięczne, roczne, żadne, one_time, trzyletnie, dwuletnie, czteroletnie i pięcioletnie.
billingCycleEndDate	string (date-time)	Data zakończenia cyklu rozliczeniowego subskrypcji, w formacie ISO 8601.
billingCycleEndDateTime	string (date-time)	Data zakończenia i godzina cyklu rozliczeniowego dla subskrypcji, w formacie ISO 8601.
billingType	enum: benefit license none usage	Typ rozliczeń dla subskrypcji. Możliwe wartości to: "brak", "użycie", "licencja", "korzyść".
cancellationAllowedUntilDate	string (date-time)	Ostatnia data i godzina dopuszczalnego anulowania, w formacie ISO 8601.
commitmentEndDate	string (date-time)	Data zakończenia obecnego zobowiązania, w formacie ISO 8601. Używa formatu data i czasu ISO 8601.
commitmentEndDateTime	string (date-time)	Data i godzina zakończenia obecnego zobowiązania subskrypcyjnego, w formacie ISO 8601.
commitmentStartDate	string (date-time)	Data i godzina rozpoczęcia obecnego zobowiązania subskrypcyjnego, w formacie ISO 8601.
consumptionType	string	Typ konsumpcji związany z subskrypcją.
contractType	enum: product_key redemption_code subscription	Typ umowy na subskrypcję. Możliwe wartości to: 'subskrypcja', 'product_key', 'redemption_code'.
creationDate	string (date-time)	Data i godzina utworzenia subskrypcji w formacie ISO 8601. Używa formatu data i czasu ISO 8601.
effectiveStartDate	string (date-time)	Data rozpoczęcia subskrypcji. Używa formatu data i czasu ISO 8601.
entitlementId	string	Unikalny identyfikator uprawnień. Wartość to zazwyczaj GUID.
friendlyName	string	Przyjazna nazwa wyświetlana dla tego produktu.
gracePeriodEndDate	string (date-time)	Data zakończenia okresu karencji w przypadku nieodnawiania subskrypcji, w formacie ISO 8601.
hasPurchasableAddons	boolean	Czy ma dodatki do kupienia.
id	string	Unikatowy identyfikator subskrypcji. Wartość to zazwyczaj GUID.
isMicrosoftProduct	boolean	Czy to produkt Microsoftu.
isTrial	boolean	Czy to jest proces.
lineItems	SubscriptionLineItemDetail[]	Zbiór pozycji związanych z tą subskrypcją.
links	SubscriptionLinks	Linki do powiązanych źródeł.
migratedFromSubscriptionId	string	Unikalny identyfikator migrowanego z subskrypcji. Wartość to zazwyczaj GUID.
migratedToSubscriptionId	string	Identyfikator subskrypcji, na którą ta subskrypcja została przeniesiona.
nextChargeInstructions	NextChargeInstructions	Instrukcje rozliczeniowe, aby zastosować się na początku następnego semestru, gdy oczekuje zmiana cyklu rozliczeniowego.
offerId	string	Identyfikator oferty. Dla nowych subskrypcji handlowych jest to zazwyczaj identyfikator produktu katalogowego: SKU:availability composite.
offerName	string	Nazwa oferty subskrypcji.
orderId	string	Identyfikator zamówienia, które utworzyło subskrypcję.
parentSubscriptionId	string	Unikalny identyfikator subskrypcji nadrzędnej. Wartość to zazwyczaj GUID.
partnerId	string	PartnerID resellera zarejestrowanego w modelu partnera pośredniego.
priceBenefits	PriceBenefit[]	Korzyści cenowe obejmowały tę subskrypcję na obecny okres. Korzyści cenowe są automatycznie stosowane przez usługę i są tylko do odczytu, więc każda wartość podana na żądaniu jest nadpisywana. Ta nieruchomość jest pomijana, gdy nie ma korzyści cenowych, a dziś zwraca się co najwyżej jeden wpis.
productOrderId	string	Identyfikator zamówienia produktu, na przykład zamówienie rezerwacji lub planu oszczędnościowego Azure.
productType	ItemType	Dodatkowy rodzaj produktu związany z subskrypcją.
promotionId	string	Identyfikator promocyjny był przypisany do subskrypcji, zazwyczaj jako produkt:SKU:availability composite identifier.
publisherName	string	Nazwa wydawcy subskrypcji.
quantity	integer (int32)	Liczba jednostek.
refundOptions	RefundOption[]	Zbiór opcji zwrotu pieniędzy związanych z tą subskrypcją.
refundableQuantity	RefundableQuantity	Dodatkowa kwota zwrotna związana z subskrypcją.
renewalTermDuration	string	Czas trwania odnowienia subskrypcji.
scheduledActions	ScheduledAction[]	Zbiór zaplanowanych działań związanych z tą subskrypcją.
scheduledNextTermInstructions	SubscriptionScheduledNextTermInstructions	Dodatkowe zaplanowane instrukcje na następny semestr związane z subskrypcją.
status	enum: active deleted disabled expired none pending suspended	Aktualny status subskrypcji. Możliwe wartości to: 'brak', 'aktywny', 'w trakcie oczekiwania', 'zawieszony', 'wygasły', 'wyłączony', 'usunięty'.
suspensionReasons	string[]	Zbiór powodów zawieszenia związanych z tą subskrypcją.
termDuration	string	Czas trwania subskrypcji (na przykład P1M dla miesięcznego lub P1Y dla rocznego).
termLifeCycleState	string	Stan cyklu życia terminu subskrypcji.
unitType	string	Typ jednostki dla subskrypcji.

SubscriptionCollection

Objekt

Reprezentuje zasób do zbierania zasobów.

Nazwa	Typ	Opis
attributes	ResourceAttributes	Dodatkowe atrybuty związane z kolekcją zasobów.
items	Subscription[]	Zbiór przedmiotów związanych z tą kolekcją zasobów.
links	ResourceLinks	Linki do powiązanych źródeł.
totalCount	integer (int32)	Całkowita liczba pozycji dostępnych w zestawie wyników.

SubscriptionLineItemDetail

Objekt

Reprezentuje zasób szczegółowy dotyczący pozycji subskrypcyjnej.

Nazwa	Typ	Opis
autoRenewEnabled	boolean	Czy ten szczegół subskrypcji jest włączony do automatycznego odnawiania.
friendlyName	string	Przyjazna nazwa wyświetlana dla tego produktu.
id	string	Unikalny identyfikator szczegółu pozycji subskrypcyjnej. Wartość to zazwyczaj GUID.
purchaseCommitment	PurchaseCommitment	Zobowiązanie zakupowe związane z tym produktem.
quantity	integer (int32)	Liczba jednostek.
scope	Scope	Dodatkowy zakres związany z szczegółami dotyczącymi pozycji subskrypcji.
status	enum: active deleted disabled expired none pending suspended	Aktualny status subskrypcji. Możliwe wartości to: 'brak', 'aktywny', 'w trakcie oczekiwania', 'zawieszony', 'wygasły', 'wyłączony', 'usunięty'.

SubscriptionLinks

Objekt

Reprezentuje źródło linków do subskrypcji.

Nazwa	Typ	Opis
activationLinks	Link	Dodatkowe linki aktywacyjne powiązane z linkami subskrypcyjnymi.
availability	Link	Dodatkowa dostępność związana jest z linkami subskrypcyjnymi.
entitlement	Link	Dodatkowe uprawnienia związane z linkami subskrypcyjnymi.
next	Link	Kolejne powiązania to linki subskrypcyjne.
offer	Link	Dodatkowa oferta powiązana z linkami subskrypcyjnymi.
parentSubscription	Link	Dodatkowa subskrypcja rodziców powiązana z linkami subskrypcyjnymi.
pendingChanges	Link	Dodatkowe oczekujące zmiany związane z linkami do subskrypcji.
previous	Link	Dodatkowe powiązania z linkami subskrypcyjnymi.
product	Link	Dodatkowy produkt powiązany z linkami subskrypcyjnymi.
self	Link	Dodatkowe powiązania z linkami do subskrypcji.
sku	Link	Dodatkowe SKU powiązane z linkami do subskrypcji.

SubscriptionProductTerm

Objekt

Reprezentuje zasób terminowy produktu.

Nazwa	Typ	Opis
availabilityId	string	Identyfikator dostępności w produkcie i SKU.
billingCycle	enum: annual biennial monthly none one_time quadrennial quinquennial triennial unknown	Częstotliwość rozliczeń. Wartości wspierane to: nieznane, miesięczne, roczne, żadne, one_time, trzyletnie, dwuletnie, czteroletnie i pięcioletnie.
productId	string	Identyfikator produktu dla następnego terminu.
promotionId	string	Identyfikator promocy, który ma się zastosować w następnym terminie, zazwyczaj jest to product:SKU:availability composite identifier.
skuId	string	Identyfikator SKU w produkcie.
termDuration	string	Czas trwania subskrypcji (na przykład P1M dla miesięcznego lub P1Y dla rocznego).

SubscriptionScheduledNextTermInstructions

Objekt

Reprezentuje zaplanowany zasób instrukcji w następnym semestrze.

Nazwa	Typ	Opis
customTermEndDate	string (date-time)	Niestandardowa data zakończenia terminu, w formacie ISO 8601. Używa formatu data i czasu ISO 8601.
priceBenefits	PriceBenefit[]	Korzyści cenowe, które zostaną zastosowane przy zaplanowanej zmianie. Korzyści cenowe są automatycznie stosowane przez usługę i są tylko do odczytu, więc każda wartość podana na żądaniu jest nadpisywana. Ta nieruchomość jest pomijana, gdy nie ma korzyści cenowych, a dziś zwraca się co najwyżej jeden wpis.
product	SubscriptionProductTerm	Dodatkowy produkt związany z zaplanowanymi instrukcjami na następny semestr.
quantity	integer (int32)	Liczba jednostek.