Condividi tramite


Manage orders - Get subscription by ID

Recupera una sottoscrizione in base all'identificatore per il cliente di un partner dall'identificatore del tenant di Active Directory.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
customer_id
path True

string

Identificatore del tenant active directory del cliente.

subscription_id
path True

string

L'identificatore della sottoscrizione.

version
path True

string

Intestazione della richiesta

Nome Necessario Tipo Descrizione
Authorization True

string

Token di connessione dell'autorizzazione

ms-correlationid

string

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

ms-cv

string

Usato per il rilevamento delle richieste internamente. Se non viene fornito un ms-cv, il server genererà un nuovo per ogni richiesta

ms-requestid

string

Usato per la idempotenza delle richieste. Se non viene fornito un ms-requestid, il server genererà un nuovo oggetto per ogni richiesta

Risposte

Nome Tipo Descrizione
200 OK

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

La richiesta è stata completata. Il corpo della risposta contiene le informazioni sulla sottoscrizione.

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

400 Bad Request

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

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

401 Unauthorized

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

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

403 Forbidden

La richiesta è stata autenticata, ma è stata rifiutata perché il chiamante non ha i diritti per richiamarlo.

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

404 Not Found

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

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

500 Internal Server Error

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

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

Definizioni

Nome Descrizione
Microsoft.Partner.Core.Collections.Link
Microsoft.Partner.Core.Collections.ResourceAttributes
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.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