Manage orders - Get customer subscriptions

Dienst:: Partner Center Rest

API-Version:: v1

Ruft Abonnements für einen Partnerkunden über die Microsoft Entra-Mieterkennung ab.

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

Mit optionalen Parametern:

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}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
customer_id	path	True	string	Die Microsoft Entra-Mieterkennung des Kunden.
version	path	True	string	Die Partner Center API-Version. Verwende Version 1.
mpn_id	query		string	Filtert Abonnements nach der PartnerID des Händlers. Dieser Parameter kann nicht mit order_id kombiniert werden.
order_id	query		string	Filtert Abonnements nach Bestellkennung. Dieser Parameter kann nicht mit mpn_id, product_type oder product_subtype kombiniert werden.
product_subtype	query		string	Filtert Abonnements nach Produkt-Subtyp. Verwenden Sie mit product_type.
product_type	query		string	Filtert Abonnements nach Produkttyp.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Authorization	True	string	Autorisierungsbearertoken.
ms-correlationid		string	Wird intern zum Nachverfolgen von Anforderungen verwendet Wenn keine ms-correlationid angegeben wird, generiert der Server für jede Anforderung eine neue.
ms-cv		string	Wird intern zum Nachverfolgen von Anforderungen verwendet Wenn kein ms-cv bereitgestellt wird, generiert der Server für jede Anforderung eine neue.
ms-requestid		string	Wird für die Idempotenz von Anforderungen verwendet Wenn keine ms-requestid angegeben wird, generiert der Server für jede Anforderung eine neue anforderung.

Antworten

Name	Typ	Beschreibung
200 OK	SubscriptionCollection	Die Anfrage war erfolgreich. Der Antworttext enthält die Abonnements. Media Types: "application/json", "text/json"
400 Bad Request		Es fehlte eine oder eine ungültige Eingabe. Der Antworttext enthält die Fehlerdetails. Media Types: "application/json", "text/json"
401 Unauthorized		Die Anforderung wurde nicht authentifiziert. Der Client muss sich zuerst beim Partner-API-Dienst authentifizieren. Media Types: "application/json", "text/json"
403 Forbidden		Die Anforderung wurde authentifiziert, wurde aber abgelehnt, da der Aufrufer nicht über die Rechte zum Aufrufen verfügt. Media Types: "application/json", "text/json"
404 Not Found		Die Ressource wurde mit den angegebenen Eingabeparametern nicht gefunden oder nicht verfügbar. Media Types: "application/json", "text/json"
500 Internal Server Error		Der Partner-API-Dienst oder eine seiner Abhängigkeiten konnte die Anforderung nicht erfüllen. Anrufer versuchen dies möglicherweise erneut. Media Types: "application/json", "text/json"

Definitionen

Name	Beschreibung
BenefitScheduledNextTermInstructions	Repräsentiert die Anweisungen, die zu Beginn des nächsten Semesters auf eine Leistung angewendet werden.
ItemType	Repräsentiert eine Ressource des Gegenstandstyps.
Link	Stellt eine Linkressource dar.
NextChargeInstructions	Stellt Abrechnungsanweisungen dar, die zu Beginn des nächsten Abonnements gelten sollen.
PriceBenefit	Stellt einen Preisvorteil dar, der auf eine Zeile oder ein Abonnement angewendet wird. Heute ist die einzige Vorteilsart eine CSP-Wachstumsmarge, die durch eine Art Wachstumsmarge angezeigt wird; die Ressource ist so gestaltet, dass sie in zukünftigen Veröffentlichungen zusätzliche Leistungsarten tragen kann. Preisvorteile werden vom Service automatisch angewendet und sind schreibgeschützt, sodass jeder auf einer Anfrage angegebene Wert überschrieben wird. Die monetäre Wirkung des Nutzens spiegelt sich in den bestehenden Preiseigenschaften wider; diese Ressource identifiziert lediglich, welches Rabattprodukt angewendet wurde.
PurchaseCommitment	Stellt eine Ressource für eine Kaufbindung dar.
RefundableQuantity	Stellt eine erstattungsfähige Menge dar.
RefundableQuantityDetail	Stellt eine erstattungsfähige Informationsquelle für Mengen dar.
RefundOption	Stellt eine Ressource für Rückerstattung dar.
ResourceAttributes	Repräsentiert eine Ressource mit Ressourcenattributen.
ResourceLinks	Repräsentiert eine Ressource, die eine Ressource verknüpft.
ScheduledAction	Repräsentiert eine geplante Aktionsressource.
Scope	Stellt eine Ressourcenquelle für den Umfang dar.
StringStringKeyValuePair	Repräsentiert eine Schlüssel-Wertpaar-Ressource.
Subscription	Stellt eine Abonnementressource dar.
SubscriptionCollection	Repräsentiert eine Ressourcensammlungsressource.
SubscriptionLineItemDetail	Stellt eine Ressource zur Detailgenauigkeit von Abonnementartikeln dar.
SubscriptionLinks	Stellt eine Ressource für Abonnementlinks dar.
SubscriptionProductTerm	Repräsentiert eine Produktbegriffsressource.
SubscriptionScheduledNextTermInstructions	Repräsentiert eine geplante Anleitung für die nächste Semester-Instruktion.

BenefitScheduledNextTermInstructions

Objekt

Repräsentiert die Anweisungen, die zu Beginn des nächsten Semesters auf eine Leistung angewendet werden.

Name	Typ	Beschreibung
billingCycle	enum: annual biennial monthly none one_time quadrennial quinquennial triennial unknown	Der Abrechnungszyklus, um mich für das nächste Semester zu bewerben. Mögliche Werte sind: 'unbekannt', 'monatlich', 'jährlich', 'keine', 'one_time', 'dreijährlich', 'zweijährlich', 'vierjährig', 'fünfjährig'.
productCode	string	Der Produktcode für das Produkt, das für das nächste Trimester gekauft werden soll.
productId	string	Die Kennung für das Produkt, das für das nächste Semester gekauft werden soll.
purchaseCommitment	PurchaseCommitment	Die Kaufverpflichtung, sich für die nächste Amtszeit zu bewerben.
skuId	string	Die Kennung für die SKU, die für das nächste Semester gekauft werden soll.
termDuration	string	Die Dauer des nächsten Semesters im ISO-8601-Format.

ItemType

Objekt

Repräsentiert eine Ressource des Gegenstandstyps.

Name	Typ	Beschreibung
displayName	string	Der Anzeigename, der den Partnern angezeigt wird.
id	string	Eindeutige Kennung für den Gegenstandstyp. Value ist typischerweise ein GUID.
skuCategories	string[]	Die SKU-Kategorien, die dem Produkttyp zugeordnet sind.
subType	ItemType	Zusätzlicher Untertyp, der mit dem Item-Typ assoziiert ist.

Link

Objekt

Stellt eine Linkressource dar.

Name	Typ	Beschreibung
body	string	Der Körper für die Verbindung.
headers	StringStringKeyValuePair[]	Die Sammlung von Headern, die mit diesem Link verbunden sind.
method	string	Die Methode für den Link.
uri	string	Die URI für die zugehörige Ressource.

NextChargeInstructions

Objekt

Stellt Abrechnungsanweisungen dar, die zu Beginn des nächsten Abonnements gelten sollen.

Name	Typ	Beschreibung
product	SubscriptionProductTerm	Das Produkt und der Abrechnungszeitraum sollen im nächsten Zeitraum berechnet werden.
quantity	integer (int32)	Der Betrag, der im nächsten Semester abgerechnet werden soll.

PriceBenefit

Objekt

Stellt einen Preisvorteil dar, der auf eine Zeile oder ein Abonnement angewendet wird. Heute ist die einzige Vorteilsart eine CSP-Wachstumsmarge, die durch eine Art Wachstumsmarge angezeigt wird; die Ressource ist so gestaltet, dass sie in zukünftigen Veröffentlichungen zusätzliche Leistungsarten tragen kann. Preisvorteile werden vom Service automatisch angewendet und sind schreibgeschützt, sodass jeder auf einer Anfrage angegebene Wert überschrieben wird. Die monetäre Wirkung des Nutzens spiegelt sich in den bestehenden Preiseigenschaften wider; diese Ressource identifiziert lediglich, welches Rabattprodukt angewendet wurde.

Name	Typ	Beschreibung
availabilityId	string	Die Verfügbarkeitskennung des Preis-Vorteil-Rabattprodukts. Identifiziert den spezifischen Rabattpreispunkt, der angewendet wurde.
productCode	string	Der universelle Produktname (UPN) des Preisvorteil-Rabattprodukts.
productId	string	Die Produktkennung des Preis-Nutzen-Rabatt-Produkts.
skuId	string	Die SKU-Kennung des Preisvorteil-Rabattprodukts.
type	string	Die Art des Preisvorteils. Heute wird nur GrowthMargin unterstützt.

PurchaseCommitment

Objekt

Stellt eine Ressource für eine Kaufbindung dar.

Name	Typ	Beschreibung
amount	number (double)	Der Geldbetrag.
currency	string	Der dreibuchstabige ISO-Währungscode.
grain	string	Das für diesen Wert verwendete Messkorn.

RefundableQuantity

Objekt

Stellt eine erstattungsfähige Menge dar.

Name	Typ	Beschreibung
details	RefundableQuantityDetail[]	Die Sammlung von Details zu diesem erstattungsfähigen Betrag.
totalQuantity	integer (int32)	Die Gesamtmenge für die erstattungsfähige Menge.

RefundableQuantityDetail

Objekt

Stellt eine erstattungsfähige Informationsquelle für Mengen dar.

Name	Typ	Beschreibung
allowedUntilDateTime	string (date-time)	Die erlaubte bis zum Datum Zeit für die Details zur erstattungsfähigen Menge. Verwendet das ISO 8601 Datum-Zeit-Format.
quantity	integer (int32)	Die Anzahl der Einheiten.

RefundOption

Objekt

Stellt eine Ressource für Rückerstattung dar.

Name	Typ	Beschreibung
expiresAt	string (date-time)	Die Rückerstattungsoption läuft ab. Verwendet das ISO 8601 Datum-Zeit-Format.
type	string	Die Art einer Rückerstattungsoption.

ResourceAttributes

Objekt

Repräsentiert eine Ressource mit Ressourcenattributen.

Name	Typ	Beschreibung
etag	string	Das Entitätstag, das für die Konkurrenzsteuerung verwendet wird.
objectType	string	Der Objekttyp für die Ressourcenattribute.

ResourceLinks

Objekt

Repräsentiert eine Ressource, die eine Ressource verknüpft.

Name	Typ	Beschreibung
next	Link	Zusätzliches ist mit den Ressourcenlinks verbunden.
previous	Link	Zusätzliche Vorgeschichte ist mit den Ressourcenlinks verbunden.
self	Link	Zusätzliche Selbstverbindungen zu den Ressourcenlinks.

ScheduledAction

Objekt

Repräsentiert eine geplante Aktionsressource.

Name	Typ	Beschreibung
actionType	enum: Cancel RenewToExtendedServiceTerm RenewToNewTerm Transition	Die auszuführende Aktion. Unterstützte Werte sind RenewToExtendedServiceTerm, Cancel, RenewToNewTerm und Transition.
effectiveDate	string (date-time)	Das Datum und die Uhrzeit, an der eine geplante CustomDate-Aktion in Kraft tritt, im ISO-8601-Format.
instructions	BenefitScheduledNextTermInstructions	Die Produkt-, Mengen- und Laufzeitanweisungen für die geplante Änderung. Nicht für Stornieren verwendet.
scheduleType	enum: BillingCycleEnd CustomDate TermEnd	Wenn die Aktion wirkt. Unterstützte Werte sind TermEnd, BillingCycleEnd und CustomDate.

Scope

Objekt

Stellt eine Ressourcenquelle für den Umfang dar.

Name	Typ	Beschreibung
entitlementId	string	Die eindeutige Kennung des Anspruchs. Value ist typischerweise ein GUID.
managementGroupId	string	Die eindeutige Kennung der Managementgruppe. Value ist typischerweise ein GUID.
resourceGroupId	string	Die eindeutige Kennung der Ressourcengruppe. Value ist typischerweise ein GUID.
subscriptionId	string	Die eindeutige Kennung (GUID) des Abonnements. Value ist typischerweise ein GUID.
type	string	Die Art eines Ziellosfernrohrs.

StringStringKeyValuePair

Objekt

Repräsentiert eine Schlüssel-Wertpaar-Ressource.

Name	Typ	Beschreibung
key	string	Der Schlüssel für das Schlüssel-Wert-Paar.
value	string	Der Wert für das Schlüsselwertpaar.

Subscription

Objekt

Stellt eine Abonnementressource dar.

Name	Typ	Beschreibung
actionTaken	boolean	Ob diese Abonnementmaßnahme ergriffen wurde.
actions	string[]	Die Sammlung der Aktionen, die mit diesem Abonnement verbunden sind.
additionalPartnerIds	string[]	Zusätzliche Reseller-PartnerIDs, die von Distributoren in den EU/EFTA-Märkten dem Abonnement zugewiesen werden.
attentionNeeded	boolean	Ob diese Abonnement-Aufmerksamkeit nötig ist.
attentionReason	string	Der Grund für das Abonnement.
attributes	ResourceAttributes	Zusätzliche Attribute, die mit dem Abonnement verbunden sind.
autoRenewEnabled	boolean	Ob dieses Abonnement automatisch verlängert wurde.
billingCycle	enum: annual biennial monthly none one_time quadrennial quinquennial triennial unknown	Die Abrechnungshäufigkeit. Unterstützte Werte sind unbekannt: monatlich, jährlich, kein, one_time, dreijährlich, zweijährlich, vierjährlich und fünfjährlich.
billingCycleEndDate	string (date-time)	Das Abrechnungszyklus-Enddatum für das Abonnement ist im ISO-8601-Format.
billingCycleEndDateTime	string (date-time)	Das Abrechnungszyklus-Enddatum und die Uhrzeit des Abonnements sind im ISO-8601-Format.
billingType	enum: benefit license none usage	Der Abrechnungstyp für das Abonnement. Mögliche Werte sind: 'keine', 'Nutzung', 'Lizenz', 'Nutzen'.
cancellationAllowedUntilDate	string (date-time)	Das letzte Datum und die letzte Uhrzeit, an der die Kündigung erlaubt ist, im ISO 8601-Format.
commitmentEndDate	string (date-time)	Das Datum, an dem die aktuelle Verpflichtung endet, im ISO-8601-Format. Verwendet das ISO 8601 Datum-Zeit-Format.
commitmentEndDateTime	string (date-time)	Das Datum und die Uhrzeit, an der die aktuelle Abonnementbindung endet, im ISO-8601-Format.
commitmentStartDate	string (date-time)	Das Datum und die Uhrzeit, an der die aktuelle Abonnementbindung beginnt, im ISO-8601-Format.
consumptionType	string	Der Konsumtyp, der mit dem Abonnement verbunden ist.
contractType	enum: product_key redemption_code subscription	Der Vertragstyp für das Abonnement. Mögliche Werte sind: 'Abonnement', 'product_key', 'redemption_code'.
creationDate	string (date-time)	Das Datum und die Uhrzeit, an der das Abonnement erstellt wurde, im ISO-8601-Format. Verwendet das ISO 8601 Datum-Zeit-Format.
effectiveStartDate	string (date-time)	Das wirksame Startdatum des Abonnements. Verwendet das ISO 8601 Datum-Zeit-Format.
entitlementId	string	Die eindeutige Kennung des Anspruchs. Value ist typischerweise ein GUID.
friendlyName	string	Ein freundlicher Display-Name für diesen Artikel.
gracePeriodEndDate	string (date-time)	Das Enddatum der Schonfrist, wenn das Abonnement nicht verlängert wird, im ISO-8601-Format.
hasPurchasableAddons	boolean	Ob es kaufbare Add-ons gibt.
id	string	Eindeutige ID für das Abonnement. Value ist typischerweise ein GUID.
isMicrosoftProduct	boolean	Ob Microsoft-Produkt ist.
isTrial	boolean	Ob es ein Prozess ist.
lineItems	SubscriptionLineItemDetail[]	Die Sammlung von Artikeln, die mit diesem Abonnement verbunden sind.
links	SubscriptionLinks	Links zu verwandten Ressourcen.
migratedFromSubscriptionId	string	Die eindeutige Identifikatorin des vom Abonnement übertragenen Modells. Value ist typischerweise ein GUID.
migratedToSubscriptionId	string	Die Kennung des Abonnements, auf das dieses Abonnement migriert wurde.
nextChargeInstructions	NextChargeInstructions	Die Abrechnungsanweisung gilt zu Beginn des nächsten Semesters, wenn eine Änderung des Abrechnungszeitraums aussteht.
offerId	string	Die Angebots-ID Für neue Handelsabonnements handelt es sich typischerweise um eine Produkt:SKU:availability-Katalog-Artikelkennung.
offerName	string	Der Angebotsname für das Abonnement.
orderId	string	Die Kennung der Ordnung, die das Abonnement erstellt hat.
parentSubscriptionId	string	Die eindeutige Kennung des übergeordneten Abonnements. Value ist typischerweise ein GUID.
partnerId	string	Die PartnerID des Resellers of Record im indirekten Partnermodell.
priceBenefits	PriceBenefit[]	Die Preisvorteile gelten für dieses Abonnement für die laufende Laufzeit. Preisvorteile werden vom Service automatisch angewendet und sind schreibgeschützt, sodass jeder auf einer Anfrage angegebene Wert überschrieben wird. Diese Immobilie wird weggelassen, wenn kein Preisvorteil gilt, und höchstens ein Eintrag wird heute zurückgegeben.
productOrderId	string	Die Kennung der Produktbestellung, wie z. B. eine Reservierung oder eine Bestellung des Azure-Sparplans.
productType	ItemType	Zusätzlicher Produkttyp, der mit dem Abonnement verbunden ist.
promotionId	string	Die auf das Abonnement verwendete Aktionskennung war typischerweise eine Produkt:SKU:verfügbarkeit-Komposit-Kennung.
publisherName	string	Der Verlagsname für das Abonnement.
quantity	integer (int32)	Die Anzahl der Einheiten.
refundOptions	RefundOption[]	Die Sammlung der Rückerstattungsoptionen, die mit diesem Abonnement verbunden sind.
refundableQuantity	RefundableQuantity	Zusätzlich erstattungsfähiger Betrag, der mit dem Abonnement verbunden ist.
renewalTermDuration	string	Die Verlängerungslaufzeit für das Abonnement.
scheduledActions	ScheduledAction[]	Die Sammlung geplanter Aktionen, die mit diesem Abonnement verbunden sind.
scheduledNextTermInstructions	SubscriptionScheduledNextTermInstructions	Weitere geplante Anweisungen für das nächste Semester im Zusammenhang mit dem Abonnement.
status	enum: active deleted disabled expired none pending suspended	Der aktuelle Abonnementstatus. Mögliche Werte sind: 'keine', 'aktiv', 'ausstehend', 'ausgesetzt', 'abgelaufen', 'deaktiviert', 'gelöscht'.
suspensionReasons	string[]	Die Sammlung der Aussetzungsgründe, die mit diesem Abonnement verbunden sind.
termDuration	string	Die Laufzeit der Abonnementlaufzeit (zum Beispiel P1M für monatlich oder P1Y für jährlich).
termLifeCycleState	string	Der Begriff Lebenszykluszustand für das Abonnement.
unitType	string	Der Einheitstyp für das Abonnement.

SubscriptionCollection

Objekt

Repräsentiert eine Ressourcensammlungsressource.

Name	Typ	Beschreibung
attributes	ResourceAttributes	Zusätzliche Attribute, die mit der Ressourcensammlung verbunden sind.
items	Subscription[]	Die Sammlung von Objekten, die mit dieser Ressourcensammlung verbunden sind.
links	ResourceLinks	Links zu verwandten Ressourcen.
totalCount	integer (int32)	Die Gesamtzahl der im Ergebnissatz verfügbaren Items.

SubscriptionLineItemDetail

Objekt

Stellt eine Ressource zur Detailgenauigkeit von Abonnementartikeln dar.

Name	Typ	Beschreibung
autoRenewEnabled	boolean	Ob die automatische Verlängerung dieser Abonnement aktiviert ist.
friendlyName	string	Ein freundlicher Display-Name für diesen Artikel.
id	string	Eindeutige Kennung für die Laufzeit des Abonnements. Value ist typischerweise ein GUID.
purchaseCommitment	PurchaseCommitment	Die mit diesem Artikel verbundene Kaufverpflichtung.
quantity	integer (int32)	Die Anzahl der Einheiten.
scope	Scope	Zusätzlicher Umfang im Zusammenhang mit dem Detail der Abonnementzeilen.
status	enum: active deleted disabled expired none pending suspended	Der aktuelle Abonnementstatus. Mögliche Werte sind: 'keine', 'aktiv', 'ausstehend', 'ausgesetzt', 'abgelaufen', 'deaktiviert', 'gelöscht'.

SubscriptionLinks

Objekt

Stellt eine Ressource für Abonnementlinks dar.

Name	Typ	Beschreibung
activationLinks	Link	Zusätzliche Aktivierungslinks, die mit den Abonnement-Links verbunden sind.
availability	Link	Zusätzliche Verfügbarkeit, die mit den Abonnement-Links verbunden ist.
entitlement	Link	Zusätzlicher Anspruch auf die Abonnement-Links.
next	Link	Zusätzliches ist mit den Abonnement-Links verbunden.
offer	Link	Zusätzliches Angebot für die Abonnement-Links.
parentSubscription	Link	Zusätzliches Elternabonnement, das mit den Abonnement-Links verbunden ist.
pendingChanges	Link	Weitere ausstehende Änderungen im Zusammenhang mit den Abonnement-Links.
previous	Link	Zusätzliche Vorgeschichten sind mit den Abonnement-Links verbunden.
product	Link	Zusätzliches Produkt, das mit den Abonnement-Links verbunden ist.
self	Link	Zusätzliche Selbstverknüpfungen zu den Abonnement-Links.
sku	Link	Zusätzliche SKU, die mit den Abonnement-Links verknüpft ist.

SubscriptionProductTerm

Objekt

Repräsentiert eine Produktbegriffsressource.

Name	Typ	Beschreibung
availabilityId	string	Die Verfügbarkeitskennung innerhalb des Produkts und der SKU.
billingCycle	enum: annual biennial monthly none one_time quadrennial quinquennial triennial unknown	Die Abrechnungshäufigkeit. Unterstützte Werte sind unbekannt: monatlich, jährlich, kein, one_time, dreijährlich, zweijährlich, vierjährlich und fünfjährlich.
productId	string	Die Produktkennung für den nächsten Term.
promotionId	string	Die im nächsten Zeitraum anzuwendende Promotionskennung ist typischerweise eine Produkt:SKU:availability Composite-Identifikator.
skuId	string	Die SKU-Kennung innerhalb des Produkts.
termDuration	string	Die Laufzeit der Abonnementlaufzeit (zum Beispiel P1M für monatlich oder P1Y für jährlich).

SubscriptionScheduledNextTermInstructions

Objekt

Repräsentiert eine geplante Anleitung für die nächste Semester-Instruktion.

Name	Typ	Beschreibung
customTermEndDate	string (date-time)	Das benutzerdefinierte Enddatum für den Begriff im ISO-8601-Format. Verwendet das ISO 8601 Datum-Zeit-Format.
priceBenefits	PriceBenefit[]	Die Preisvorteile, die bei der geplanten Änderung angewendet werden. Preisvorteile werden vom Service automatisch angewendet und sind schreibgeschützt, sodass jeder auf einer Anfrage angegebene Wert überschrieben wird. Diese Immobilie wird weggelassen, wenn kein Preisvorteil gilt, und höchstens ein Eintrag wird heute zurückgegeben.
product	SubscriptionProductTerm	Zusätzliches Produkt im Zusammenhang mit den geplanten Anweisungen für das nächste Semester.
quantity	integer (int32)	Die Anzahl der Einheiten.