Udostępnij za pośrednictwem


Manage orders - Get customer's subscriptions

Pobiera wszystkie subskrypcje dla klienta partnera według identyfikatora dzierżawy usługi Active Directory.

GET https://api.partnercenter.microsoft.com/v{version}/customers/{customer_id}/subscriptions
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żawy usługi Active Directory klienta.

version
path True

string

mpn_id
query

string

Identyfikator partnera (mpn). Opcjonalny parametr. Filtruj subskrypcje według identyfikatora partnera. Nie można połączyć tego parametru z identyfikatorem zamówienia.

order_id
query

string

Identyfikator zamówienia. Opcjonalny parametr. Filtruj subskrypcje według identyfikatora zamówienia. Nie można połączyć tego parametru z identyfikatorem partnera.

product_subtype
query

string

Podtyp produktu. Opcjonalny parametr. Filtruj subskrypcje według typu produktu i podtypu produktu.

product_type
query

string

Typ produktu. Opcjonalny parametr. Filtruj 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 śledzenia żądań wewnętrznie. Jeśli nie podano identyfikatora ms-correlationid, serwer wygeneruje nowy dla każdego żądania

ms-cv

string

Służy do śledzenia żądań wewnętrznie. Jeśli nie podano ms-cv, serwer wygeneruje nowy dla każdego żądania

ms-requestid

string

Służy do idempotentności żądań. Jeśli nie podano identyfikatora ms-requestid, serwer wygeneruje nowy dla każdego żądania

Odpowiedzi

Nazwa Typ Opis
200 OK

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

Żą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
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]
Nazwa Typ Opis
body

string

headers

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

method

string

uri

string

Microsoft.Partner.Core.Collections.ResourceAttributes

Nazwa Typ Opis
etag

string

objectType

string

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

Nazwa Typ Opis
attributes

Microsoft.Partner.Core.Collections.ResourceAttributes

items

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

links

Microsoft.Partner.Core.Collections.ResourceLinks

totalCount

integer

Nazwa Typ Opis
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

Nazwa Typ Opis
displayName

string

id

string

subType

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

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

Nazwa Typ Opis
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

Nazwa Typ Opis
amount

number

currency

string

grain

string

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

Nazwa Typ Opis
details

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

totalQuantity

integer

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

Nazwa Typ Opis
allowedUntilDateTime

string

quantity

integer

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

Nazwa Typ Opis
expiresAt

string

type

string

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

Nazwa Typ Opis
customTermEndDate

string

product

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

quantity

integer

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

Nazwa Typ Opis
entitlementId

string

managementGroupId

string

resourceGroupId

string

subscriptionId

string

type

string

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

Nazwa Typ Opis
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

Nazwa Typ Opis
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
Nazwa Typ Opis
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]

Nazwa Typ Opis
key

string

value

string