Manage orders - Get customer's subscriptions

Service:

Partner Center Rest

API-versie:

v1

Haalt alle abonnementen voor de klant van een partner op met de active directory-tenant-id.

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

Met optionele parameters:

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-parameters

Name	In	Vereist	Type	Description
customer_id	path	True	string	De Active Directory-tenant-id van de klant.
version	path	True	string
mpn_id	query		string	De partner-id (mpn). Optionele parameter. Filter abonnementen op 'partner-id'. Deze parameter kan niet worden gecombineerd met 'order-id'.
order_id	query		string	De order-id. Optionele parameter. Filter abonnementen op 'order-id'. Deze parameter kan niet worden gecombineerd met 'partner-id'.
product_subtype	query		string	Het subtype van het product. Optionele parameter. Filter abonnementen op 'producttype' en 'productsubtype'.
product_type	query		string	Het producttype. Optionele parameter. Filter abonnementen op producttype.

Aanvraagkoptekst

Name	Vereist	Type	Description
Authorization	True	string	Bearer-token voor autorisatie
ms-correlationid		string	Wordt intern gebruikt voor het bijhouden van aanvragen. Als er geen ms-correlationid is opgegeven, genereert de server een nieuwe voor elke aanvraag
ms-cv		string	Wordt intern gebruikt voor het bijhouden van aanvragen. Als er geen ms-cv is opgegeven, genereert de server een nieuwe voor elke aanvraag
ms-requestid		string	Wordt gebruikt voor idempotentie van aanvragen. Als er geen ms-requestid is opgegeven, genereert de server een nieuwe voor elke aanvraag

Antwoorden

Name	Type	Description
200 OK	Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Services.Subscriptions.V1.Models.Subscription]	De aanvraag is geslaagd. De hoofdtekst van het antwoord bevat de abonnementen. Media Types: "application/json", "text/json"
400 Bad Request		Er is een ontbrekende of ongeldige invoer. De hoofdtekst van het antwoord bevat de foutdetails. Media Types: "application/json", "text/json"
401 Unauthorized		De aanvraag is niet geverifieerd. De client moet eerst worden geverifieerd met de partner-API-service. Media Types: "application/json", "text/json"
403 Forbidden		De aanvraag is geverifieerd, maar is geweigerd omdat de beller niet over de rechten beschikt om deze aan te roepen. Media Types: "application/json", "text/json"
404 Not Found		De resource is niet gevonden of niet beschikbaar met de opgegeven invoerparameters. Media Types: "application/json", "text/json"
500 Internal Server Error		De partner-API-service of een van de bijbehorende afhankelijkheden kan niet voldoen aan de aanvraag. Bellers kunnen dit opnieuw proberen. Media Types: "application/json", "text/json"

Definities

Name	Description
Microsoft.Partner.Core.Collections.Link
Microsoft.Partner.Core.Collections.ResourceAttributes
Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Services.Subscriptions.V1.Models.Subscription]
Microsoft.Partner.Core.Collections.ResourceLinks
Microsoft.Partner.Services.Subscriptions.V1.Models.ItemType
Microsoft.Partner.Services.Subscriptions.V1.Models.ProductTerm
Microsoft.Partner.Services.Subscriptions.V1.Models.PurchaseCommitment
Microsoft.Partner.Services.Subscriptions.V1.Models.RefundableQuantity
Microsoft.Partner.Services.Subscriptions.V1.Models.RefundableQuantityDetail
Microsoft.Partner.Services.Subscriptions.V1.Models.RefundOption
Microsoft.Partner.Services.Subscriptions.V1.Models.ScheduledNextTermInstructions
Microsoft.Partner.Services.Subscriptions.V1.Models.Scope
Microsoft.Partner.Services.Subscriptions.V1.Models.Subscription
Microsoft.Partner.Services.Subscriptions.V1.Models.SubscriptionLineItemDetail
Microsoft.Partner.Services.Subscriptions.V1.Models.SubscriptionLinks
System.Collections.Generic.KeyValuePair[System.String,System.String]

Microsoft.Partner.Core.Collections.Link

Name	Type	Description
body	string
headers	System.Collections.Generic.KeyValuePair[System.String,System.String][]
method	string
uri	string

Microsoft.Partner.Core.Collections.ResourceAttributes

Name	Type	Description
etag	string
objectType	string

Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Services.Subscriptions.V1.Models.Subscription]

Name	Type	Description
attributes	Microsoft.Partner.Core.Collections.ResourceAttributes
items	Microsoft.Partner.Services.Subscriptions.V1.Models.Subscription[]
links	Microsoft.Partner.Core.Collections.ResourceLinks
totalCount	integer

Microsoft.Partner.Core.Collections.ResourceLinks

Name	Type	Description
next	Microsoft.Partner.Core.Collections.Link
previous	Microsoft.Partner.Core.Collections.Link
self	Microsoft.Partner.Core.Collections.Link

Microsoft.Partner.Services.Subscriptions.V1.Models.ItemType

Name	Type	Description
displayName	string
id	string
subType	Microsoft.Partner.Services.Subscriptions.V1.Models.ItemType

Microsoft.Partner.Services.Subscriptions.V1.Models.ProductTerm

Name	Type	Description
availabilityId	string
billingCycle	enum: annual biennial monthly none one_time triennial unknown
productId	string
skuId	string
termDuration	string

Microsoft.Partner.Services.Subscriptions.V1.Models.PurchaseCommitment

Name	Type	Description
amount	number
currency	string
grain	string

Microsoft.Partner.Services.Subscriptions.V1.Models.RefundableQuantity

Name	Type	Description
details	Microsoft.Partner.Services.Subscriptions.V1.Models.RefundableQuantityDetail[]
totalQuantity	integer

Microsoft.Partner.Services.Subscriptions.V1.Models.RefundableQuantityDetail

Name	Type	Description
allowedUntilDateTime	string
quantity	integer

Microsoft.Partner.Services.Subscriptions.V1.Models.RefundOption

Name	Type	Description
expiresAt	string
type	string

Microsoft.Partner.Services.Subscriptions.V1.Models.ScheduledNextTermInstructions

Name	Type	Description
customTermEndDate	string
product	Microsoft.Partner.Services.Subscriptions.V1.Models.ProductTerm
quantity	integer

Microsoft.Partner.Services.Subscriptions.V1.Models.Scope

Name	Type	Description
entitlementId	string
managementGroupId	string
resourceGroupId	string
subscriptionId	string
type	string

Microsoft.Partner.Services.Subscriptions.V1.Models.Subscription

Name	Type	Description
actionTaken	boolean
actions	string[]
attentionNeeded	boolean
attentionReason	string
attributes	Microsoft.Partner.Core.Collections.ResourceAttributes
autoRenewEnabled	boolean
billingCycle	enum: annual monthly none one_time triennial unknown
billingType	enum: benefit license none usage
commitmentEndDate	string
contractType	enum: product_key redemption_code subscription
creationDate	string
effectiveStartDate	string
entitlementId	string
friendlyName	string
hasPurchasableAddons	boolean
id	string
isMicrosoftProduct	boolean
isTrial	boolean
lineItems	Microsoft.Partner.Services.Subscriptions.V1.Models.SubscriptionLineItemDetail[]
links	Microsoft.Partner.Services.Subscriptions.V1.Models.SubscriptionLinks
migratedFromSubscriptionId	string
offerId	string
offerName	string
orderId	string
parentSubscriptionId	string
partnerId	string
productOrderId	string
productType	Microsoft.Partner.Services.Subscriptions.V1.Models.ItemType
promotionId	string
publisherName	string
quantity	integer
refundOptions	Microsoft.Partner.Services.Subscriptions.V1.Models.RefundOption[]
refundableQuantity	Microsoft.Partner.Services.Subscriptions.V1.Models.RefundableQuantity
renewalTermDuration	string
scheduledNextTermInstructions	Microsoft.Partner.Services.Subscriptions.V1.Models.ScheduledNextTermInstructions
status	enum: active deleted disabled expired none pending suspended
suspensionReasons	string[]
termDuration	string
unitType	string

Microsoft.Partner.Services.Subscriptions.V1.Models.SubscriptionLineItemDetail

Name	Type	Description
autoRenewEnabled	boolean
friendlyName	string
id	string
purchaseCommitment	Microsoft.Partner.Services.Subscriptions.V1.Models.PurchaseCommitment
quantity	integer
scope	Microsoft.Partner.Services.Subscriptions.V1.Models.Scope
status	enum: active deleted expired expired none pending suspended

Microsoft.Partner.Services.Subscriptions.V1.Models.SubscriptionLinks

Name	Type	Description
activationLinks	Microsoft.Partner.Core.Collections.Link
availability	Microsoft.Partner.Core.Collections.Link
entitlement	Microsoft.Partner.Core.Collections.Link
next	Microsoft.Partner.Core.Collections.Link
offer	Microsoft.Partner.Core.Collections.Link
parentSubscription	Microsoft.Partner.Core.Collections.Link
pendingChanges	Microsoft.Partner.Core.Collections.Link
previous	Microsoft.Partner.Core.Collections.Link
product	Microsoft.Partner.Core.Collections.Link
self	Microsoft.Partner.Core.Collections.Link
sku	Microsoft.Partner.Core.Collections.Link

System.Collections.Generic.KeyValuePair[System.String,System.String]

Name	Type	Description
key	string
value	string