Condividi tramite


Manage orders - Get customer's subscriptions

Recupera tutte le sottoscrizioni per il cliente di un partner in base all'identificatore del tenant di 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}

Parametri dell'URI

Nome In Necessario Tipo Descrizione
customer_id
path True

string

Identificatore del tenant di Active Directory del cliente.

version
path True

string

mpn_id
query

string

Identificatore partner (mpn). Parametro facoltativo. Filtrare le sottoscrizioni in base a 'id partner'. Questo parametro non può essere combinato con 'order id'.

order_id
query

string

Identificatore dell'ordine. Parametro facoltativo. Filtrare le sottoscrizioni in base a 'order id'. Questo parametro non può essere combinato con 'id partner'.

product_subtype
query

string

Sottotipo di prodotto. Parametro facoltativo. Filtrare le sottoscrizioni in base al tipo di prodotto e al sottotipo di prodotto.

product_type
query

string

Tipo di prodotto. Parametro facoltativo. Filtrare le sottoscrizioni in base al tipo di prodotto.

Intestazione della richiesta

Nome Necessario Tipo Descrizione
Authorization True

string

Token di connessione dell'autorizzazione

ms-correlationid

string

Usato per tenere traccia delle richieste internamente. Se non viene specificato un ms-correlationid, il server genererà un nuovo elemento per ogni richiesta

ms-cv

string

Usato per tenere traccia delle richieste internamente. Se non viene specificata una ms-cv, il server genererà un nuovo per ogni richiesta

ms-requestid

string

Usato per l'idempotenza delle richieste. Se non viene specificato un ms-requestid, il server genererà un nuovo per ogni richiesta

Risposte

Nome Tipo Descrizione
200 OK

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

La richiesta ha avuto esito positivo. Il corpo della risposta contiene le sottoscrizioni.

Media Types: "application/json", "text/json"

400 Bad Request

Non è presente un input mancante o non valido. Il corpo della risposta fornirà i dettagli dell'errore.

Media Types: "application/json", "text/json"

401 Unauthorized

La richiesta non è stata autenticata. Il client deve prima eseguire l'autenticazione con il servizio API partner.

Media Types: "application/json", "text/json"

403 Forbidden

La richiesta è stata autenticata ma è stata rifiutata perché il chiamante non dispone dei diritti per richiamarlo.

Media Types: "application/json", "text/json"

404 Not Found

La risorsa non viene trovata o non è disponibile con i parametri di input specificati.

Media Types: "application/json", "text/json"

500 Internal Server Error

Il servizio API partner o una delle relative dipendenze non è riuscito a soddisfare la richiesta. I chiamanti possono riprovare.

Media Types: "application/json", "text/json"

Definizioni

Nome Descrizione
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]
Nome Tipo Descrizione
body

string

headers

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

method

string

uri

string

Microsoft.Partner.Core.Collections.ResourceAttributes

Nome Tipo Descrizione
etag

string

objectType

string

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

Nome Tipo Descrizione
attributes

Microsoft.Partner.Core.Collections.ResourceAttributes

items

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

links

Microsoft.Partner.Core.Collections.ResourceLinks

totalCount

integer

Nome Tipo Descrizione
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

Nome Tipo Descrizione
displayName

string

id

string

subType

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

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

Nome Tipo Descrizione
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

Nome Tipo Descrizione
amount

number

currency

string

grain

string

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

Nome Tipo Descrizione
details

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

totalQuantity

integer

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

Nome Tipo Descrizione
allowedUntilDateTime

string

quantity

integer

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

Nome Tipo Descrizione
expiresAt

string

type

string

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

Nome Tipo Descrizione
customTermEndDate

string

product

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

quantity

integer

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

Nome Tipo Descrizione
entitlementId

string

managementGroupId

string

resourceGroupId

string

subscriptionId

string

type

string

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

Nome Tipo Descrizione
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

Nome Tipo Descrizione
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
Nome Tipo Descrizione
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]

Nome Tipo Descrizione
key

string

value

string