Manage orders - Get customer subscriptions

Service:: Partner Center Rest

Versione API:: v1

Recupera le iscrizioni per un cliente partner tramite l'identificatore tenant Microsoft Entra.

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

Con parametri facoltativi:

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	L'identificatore tenant Microsoft Entra del cliente.
version	path	True	string	La versione API del Partner Center. Usa la v1.
mpn_id	query		string	Filtra gli abbonamenti tramite il rivenditore PartnerID. Questo parametro non può essere combinato con order_id.
order_id	query		string	Filtra gli abbonamenti per identificatore d'ordine. Questo parametro non può essere combinato con mpn_id, product_type o product_subtype.
product_subtype	query		string	Filtra gli abbonamenti per sottotipo di prodotto. Usa con product_type.
product_type	query		string	Filtra gli abbonamenti per tipo di prodotto.

Intestazione di richiesta

Nome	Necessario	Tipo	Descrizione
Authorization	True	string	Token di autorizzazione Bearer
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	SubscriptionCollection	La richiesta ha avuto successo. 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
BenefitScheduledNextTermInstructions	Rappresenta le istruzioni applicate a un beneficio all'inizio del suo prossimo mandato.
ItemType	Rappresenta una risorsa di tipo oggetto.
Link	Rappresenta una risorsa link.
NextChargeInstructions	Rappresenta le istruzioni di fatturazione da applicare all'inizio del prossimo periodo dell'abbonamento.
PriceBenefit	Rappresenta un vantaggio di prezzo applicato a una voce o a un abbonamento. Oggi l'unico tipo di beneficio è un CSP Growth Margin, indicato da un tipo di GrowthMargin; la risorsa è modellata in modo da poter trasportare ulteriori tipi di benefici nelle future versioni. I benefici di prezzo sono applicati automaticamente dal servizio e sono in sola lettura, quindi qualsiasi valore fornito su una richiesta viene sovrascritto. L'effetto monetario del beneficio si riflette attraverso le proprietà di prezzo esistenti; questa risorsa identifica solo quale prodotto scontato è stato applicato.
PurchaseCommitment	Rappresenta una risorsa di impegno di acquisto.
RefundableQuantity	Rappresenta una risorsa di quantità rimborsabile.
RefundableQuantityDetail	Rappresenta una risorsa rimborsabile per la quantità di dettagli.
RefundOption	Rappresenta una risorsa per l'opzione di rimborso.
ResourceAttributes	Rappresenta una risorsa attributi.
ResourceLinks	Rappresenta una risorsa di link di risorsa.
ScheduledAction	Rappresenta una risorsa di azione programmata.
Scope	Rappresenta una risorsa di ambito.
StringStringKeyValuePair	Rappresenta una risorsa di coppie chiave-valore.
Subscription	Rappresenta una risorsa per abbonamento.
SubscriptionCollection	Rappresenta una risorsa per la raccolta di risorse.
SubscriptionLineItemDetail	Rappresenta una risorsa di dettaglio delle linee per abbonamento.
SubscriptionLinks	Rappresenta una risorsa per link per abbonamenti.
SubscriptionProductTerm	Rappresenta un termine prodotto, risorsa.
SubscriptionScheduledNextTermInstructions	Rappresenta una risorsa di istruzioni per il prossimo termine programmato.

BenefitScheduledNextTermInstructions

Oggetto

Rappresenta le istruzioni applicate a un beneficio all'inizio del suo prossimo mandato.

Nome	Tipo	Descrizione
billingCycle	enum: annual biennial monthly none one_time quadrennial quinquennial triennial unknown	Il ciclo di fatturazione per fare domanda per il prossimo periodo. I valori possibili includono: 'sconosciuto', 'mensile', 'annuale', 'nessuno', 'one_time'', 'triennale', 'biennale', 'quadriennale', 'quinquennale'.
productCode	string	Il codice prodotto per il prodotto da acquistare per il prossimo periodo.
productId	string	L'identificativo del prodotto da acquistare per il prossimo periodo.
purchaseCommitment	PurchaseCommitment	L'impegno di acquisto per fare domanda per il prossimo semestre.
skuId	string	L'identificativo per lo SKU da acquistare per il prossimo periodo.
termDuration	string	La durata del semestre successivo, in formato ISO 8601.

ItemType

Oggetto

Rappresenta una risorsa di tipo oggetto.

Nome	Tipo	Descrizione
displayName	string	Il nome visualizzato ai partner.
id	string	Identificatore unico per il tipo di articolo. Il valore è tipicamente un GUID.
skuCategories	string[]	Le categorie SKU associate al tipo di prodotto.
subType	ItemType	Sottotipo aggiuntivo associato al tipo di oggetto.

Link

Oggetto

Rappresenta una risorsa link.

Nome	Tipo	Descrizione
body	string	Il corpo per il collegamento.
headers	StringStringKeyValuePair[]	La raccolta di intestazioni associata a questo link.
method	string	Il metodo per il link.
uri	string	L'URI della risorsa correlata.

NextChargeInstructions

Oggetto

Rappresenta le istruzioni di fatturazione da applicare all'inizio del prossimo periodo dell'abbonamento.

Nome	Tipo	Descrizione
product	SubscriptionProductTerm	Il prodotto e il termine di fatturazione da addebitare nel prossimo periodo.
quantity	integer (int32)	La quantità da fatturare nel prossimo semestre.

PriceBenefit

Oggetto

Rappresenta un vantaggio di prezzo applicato a una voce o a un abbonamento. Oggi l'unico tipo di beneficio è un CSP Growth Margin, indicato da un tipo di GrowthMargin; la risorsa è modellata in modo da poter trasportare ulteriori tipi di benefici nelle future versioni. I benefici di prezzo sono applicati automaticamente dal servizio e sono in sola lettura, quindi qualsiasi valore fornito su una richiesta viene sovrascritto. L'effetto monetario del beneficio si riflette attraverso le proprietà di prezzo esistenti; questa risorsa identifica solo quale prodotto scontato è stato applicato.

Nome	Tipo	Descrizione
availabilityId	string	L'identificatore di disponibilità del prodotto scontato prezzo-beneficio. Identifica il prezzo scontato specifico applicato.
productCode	string	Il nome universale del prodotto (UPN) del prodotto scontato a prezzo e beneficio.
productId	string	L'identificatore del prodotto del prodotto scontato prezzo-beneficio.
skuId	string	L'identificatore SKU del prodotto scontato a prezzo e beneficio.
type	string	Tipo di vantaggio del prezzo. Oggi solo GrowthMargin è supportato.

PurchaseCommitment

Oggetto

Rappresenta una risorsa di impegno di acquisto.

Nome	Tipo	Descrizione
amount	number (double)	L'importo in denaro.
currency	string	Il codice valuta ISO a tre lettere.
grain	string	Il grano di misura utilizzato per questo valore.

RefundableQuantity

Oggetto

Rappresenta una risorsa di quantità rimborsabile.

Nome	Tipo	Descrizione
details	RefundableQuantityDetail[]	La raccolta di informazioni associate a questa somma rimborsabile.
totalQuantity	integer (int32)	L'importo totale per l'importo rimborsabile.

RefundableQuantityDetail

Oggetto

Rappresenta una risorsa rimborsabile per la quantità di dettagli.

Nome	Tipo	Descrizione
allowedUntilDateTime	string (date-time)	Il limite consentito per la data di pagamento del dettaglio della quantità rimborsabile. Utilizza il formato data-ora ISO 8601.
quantity	integer (int32)	Numero di unità.

RefundOption

Oggetto

Rappresenta una risorsa per l'opzione di rimborso.

Nome	Tipo	Descrizione
expiresAt	string (date-time)	Scade a per l'opzione di rimborso. Utilizza il formato data-ora ISO 8601.
type	string	Il tipo di opzione di rimborso.

ResourceAttributes

Oggetto

Rappresenta una risorsa attributi.

Nome	Tipo	Descrizione
etag	string	Il tag dell'entità utilizzato per il controllo della concorrenza.
objectType	string	Il tipo di oggetto per gli attributi risorsa.

ResourceLinks

Oggetto

Rappresenta una risorsa di link di risorsa.

Nome	Tipo	Descrizione
next	Link	Ulteriori dettagli legati ai link di risorse.
previous	Link	Ulteriori precedenti associati ai link alle risorse.
self	Link	Ulteriori sé associati ai link delle risorse.

ScheduledAction

Oggetto

Rappresenta una risorsa di azione programmata.

Nome	Tipo	Descrizione
actionType	enum: Cancel RenewToExtendedServiceTerm RenewToNewTerm Transition	L'azione da eseguire. I valori supportati sono RenewToExtendedServiceTerm, Cancel, RenewToNewterm e Transition.
effectiveDate	string (date-time)	La data e l'ora in cui un'azione programmata CustomDate entra in vigore, in formato ISO 8601.
instructions	BenefitScheduledNextTermInstructions	Le istruzioni per prodotto, quantità e termine per il cambiamento programmato. Non usato per Cancel.
scheduleType	enum: BillingCycleEnd CustomDate TermEnd	Quando l'azione avrà effetto. I valori supportati sono TermEnd, BillingCycleEnd e CustomDate.

Scope

Oggetto

Rappresenta una risorsa di ambito.

Nome	Tipo	Descrizione
entitlementId	string	L'identificatore unico del diritto. Il valore è tipicamente un GUID.
managementGroupId	string	L'identificatore unico del gruppo di gestione. Il valore è tipicamente un GUID.
resourceGroupId	string	L'identificatore univoco del gruppo risorsa. Il valore è tipicamente un GUID.
subscriptionId	string	L'identificatore univoco (GUID) dell'abbonamento. Il valore è tipicamente un GUID.
type	string	Il tipo di mirino.

StringStringKeyValuePair

Oggetto

Rappresenta una risorsa di coppie chiave-valore.

Nome	Tipo	Descrizione
key	string	La chiave per la coppia chiave-valore.
value	string	Il valore per la coppia chiave-valore.

Subscription

Oggetto

Rappresenta una risorsa per abbonamento.

Nome	Tipo	Descrizione
actionTaken	boolean	Se questa azione di abbonamento è stata presa.
actions	string[]	La raccolta delle azioni associate a questo abbonamento.
additionalPartnerIds	string[]	PartnerID aggiuntivi dei rivenditori assegnati all'abbonamento dai distributori nei mercati UE/EFTA.
attentionNeeded	boolean	Se questa attenzione in abonamento fosse necessaria.
attentionReason	string	Il motivo dell'attenzione per l'abbonamento.
attributes	ResourceAttributes	Attributi aggiuntivi associati all'abbonamento.
autoRenewEnabled	boolean	Se questo abbonamento si rinovela automaticamente attivamente.
billingCycle	enum: annual biennial monthly none one_time quadrennial quinquennial triennial unknown	Frequenza di fatturazione. I valori supportati sono sconosciuti: mensile, annuale, nessuno, one_time, triennale, biennale, quadriennale e quinquennale.
billingCycleEndDate	string (date-time)	La data di fine ciclo di fatturazione per l'abbonamento, in formato ISO 8601.
billingCycleEndDateTime	string (date-time)	La data e l'ora di fine ciclo di fatturazione per l'abbonamento, in formato ISO 8601.
billingType	enum: benefit license none usage	Il tipo di fatturazione per l'abbonamento. I valori possibili includono: 'nessuno', 'utilizzo', 'licenza', 'beneficio'.
cancellationAllowedUntilDate	string (date-time)	L'ultima data e ora in cui è consentita la cancellazione, in formato ISO 8601.
commitmentEndDate	string (date-time)	La data in cui termina l'impegno attuale, in formato ISO 8601. Utilizza il formato data-ora ISO 8601.
commitmentEndDateTime	string (date-time)	La data e l'ora in cui l'attuale impegno di abbonamento termina, in formato ISO 8601.
commitmentStartDate	string (date-time)	La data e l'ora in cui inizia l'attuale impegno di abbonamento, in formato ISO 8601.
consumptionType	string	Il tipo di consumo associato all'abbonamento.
contractType	enum: product_key redemption_code subscription	Il tipo di contratto per l'abbonamento. I valori possibili includono: 'abbonamento', 'product_key', 'redemption_code'.
creationDate	string (date-time)	La data e l'ora in cui l'abbonamento è stato creato, in formato ISO 8601. Utilizza il formato data-ora ISO 8601.
effectiveStartDate	string (date-time)	La data di inizio effettiva dell'abbonamento. Utilizza il formato data-ora ISO 8601.
entitlementId	string	L'identificatore unico del diritto. Il valore è tipicamente un GUID.
friendlyName	string	Un nome amichevole per questo oggetto.
gracePeriodEndDate	string (date-time)	La data di fine del periodo di grazia in cui l'abbonamento non viene rinnovato, in formato ISO 8601.
hasPurchasableAddons	boolean	Se ha addon acquistabili.
id	string	Identificatore univoco per la sottoscrizione. Il valore è tipicamente un GUID.
isMicrosoftProduct	boolean	Se sia un prodotto Microsoft.
isTrial	boolean	Se è processo.
lineItems	SubscriptionLineItemDetail[]	La raccolta di voci associate a questo abbonamento.
links	SubscriptionLinks	Collegamenti a risorse correlate.
migratedFromSubscriptionId	string	L'identificatore univoco del migrato da abbonamento. Il valore è tipicamente un GUID.
migratedToSubscriptionId	string	L'identificatore dell'abbonamento a cui è stato migrato tale abbonamento.
nextChargeInstructions	NextChargeInstructions	Le istruzioni di fatturazione da applicare all'inizio del prossimo periodo quando è in sospeso un cambiamento del ciclo di fatturazione.
offerId	string	Identificatore dell'offerta. Per le nuove abbonazioni al commercio, questo è tipicamente un identificatore composito di articoli del catalogo prodotto:SKU:disponibilità.
offerName	string	Il nome dell'offerta per l'abbonamento.
orderId	string	L'identificatore dell'ordine che ha creato l'abbonamento.
parentSubscriptionId	string	L'identificatore univoco dell'abbonamento genitore. Il valore è tipicamente un GUID.
partnerId	string	Il PartnerID del rivenditore registrato nel modello del partner indiretto.
priceBenefits	PriceBenefit[]	I benefici sul prezzo si applicavano a questo abbonamento per il periodo corrente. I benefici di prezzo sono applicati automaticamente dal servizio e sono in sola lettura, quindi qualsiasi valore fornito su una richiesta viene sovrascritto. Questa proprietà viene omessa quando non si applica alcun beneficio di prezzo, e al massimo una voce viene restituita oggi.
productOrderId	string	L'identificatore dell'ordine di acquisto del prodotto, come una prenotazione o un ordine di piano di risparmio Azure.
productType	ItemType	Tipo di prodotto aggiuntivo associato all'abbonamento.
promotionId	string	L'identificatore promozionale si applicava all'abbonamento, tipicamente un identificatore composito product:SKU:availability.
publisherName	string	Il nome dell'editore per l'abbonamento.
quantity	integer (int32)	Numero di unità.
refundOptions	RefundOption[]	La collezione di opzioni di rimborso associate a questo abbonamento.
refundableQuantity	RefundableQuantity	Importo rimborsabile aggiuntivo associato all'abbonamento.
renewalTermDuration	string	La durata del rinnovo per l'abbonamento.
scheduledActions	ScheduledAction[]	La raccolta delle azioni programmate associate a questo abbonamento.
scheduledNextTermInstructions	SubscriptionScheduledNextTermInstructions	Ulteriori istruzioni programmate per il prossimo semestre associate all'abbonamento.
status	enum: active deleted disabled expired none pending suspended	Lo stato attuale dell'abbonamento. I valori possibili includono: 'nessuno', 'attivo', 'in sospeso', 'sospeso', 'scaduto', 'disabilitato', 'eliminato'.
suspensionReasons	string[]	La raccolta di motivi di sospensione associati a questa iscrizione.
termDuration	string	La durata del periodo di abbonamento (ad esempio, P1M per il mensile o P1Y per l'annuale).
termLifeCycleState	string	Il termine ciclo di vita indica l'abbonamento.
unitType	string	Il tipo di unità per l'abbonamento.

SubscriptionCollection

Oggetto

Rappresenta una risorsa per la raccolta di risorse.

Nome	Tipo	Descrizione
attributes	ResourceAttributes	Attributi aggiuntivi associati alla raccolta delle risorse.
items	Subscription[]	La raccolta di oggetti associati a questa raccolta di risorse.
links	ResourceLinks	Collegamenti a risorse correlate.
totalCount	integer (int32)	Il numero totale di elementi disponibili nel set di risultati.

SubscriptionLineItemDetail

Oggetto

Rappresenta una risorsa di dettaglio delle linee per abbonamento.

Nome	Tipo	Descrizione
autoRenewEnabled	boolean	Se questo dettaglio di linea di abbonamento è abilitato, il rinnovo automatico.
friendlyName	string	Un nome amichevole per questo oggetto.
id	string	Identificatore unico per i dettagli della voce di abbonamento. Il valore è tipicamente un GUID.
purchaseCommitment	PurchaseCommitment	L'impegno di acquisto associato a questo articolo.
quantity	integer (int32)	Numero di unità.
scope	Scope	Ambito aggiuntivo associato al dettaglio della linea di abbonamento.
status	enum: active deleted disabled expired none pending suspended	Lo stato attuale dell'abbonamento. I valori possibili includono: 'nessuno', 'attivo', 'in sospeso', 'sospeso', 'scaduto', 'disabilitato', 'eliminato'.

SubscriptionLinks

Oggetto

Rappresenta una risorsa per link per abbonamenti.

Nome	Tipo	Descrizione
activationLinks	Link	Ulteriori link di attivazione associati ai link di abbonamento.
availability	Link	Disponibilità aggiuntiva associata ai link di abbonamento.
entitlement	Link	Ulteriori diritti associati ai link di abbonamento.
next	Link	Ulteriori link per l'abbonamento.
offer	Link	Offerta aggiuntiva associata ai link di abbonamento.
parentSubscription	Link	Abbonamento genitore aggiuntivo associato ai link di abbonamento.
pendingChanges	Link	Ulteriori modifiche in sospeso associate ai link di abbonamento.
previous	Link	Ulteriori precedenti associati ai link di abbonamento.
product	Link	Prodotto aggiuntivo associato ai link di abbonamento.
self	Link	Ulteriori link di abbonamento associati ai link di abbonamento.
sku	Link	SKU aggiuntivi associati ai link di abbonamento.

SubscriptionProductTerm

Oggetto

Rappresenta un termine prodotto, risorsa.

Nome	Tipo	Descrizione
availabilityId	string	L'identificatore di disponibilità all'interno del prodotto e dello SKU.
billingCycle	enum: annual biennial monthly none one_time quadrennial quinquennial triennial unknown	Frequenza di fatturazione. I valori supportati sono sconosciuti: mensile, annuale, nessuno, one_time, triennale, biennale, quadriennale e quinquennale.
productId	string	L'identificatore del prodotto per il prossimo termine.
promotionId	string	L'identificatore promozionale da applicare nel termine successivo, tipicamente un identificatore composito product:SKU:availability.
skuId	string	L'identificatore SKU all'interno del prodotto.
termDuration	string	La durata del periodo di abbonamento (ad esempio, P1M per il mensile o P1Y per l'annuale).

SubscriptionScheduledNextTermInstructions

Oggetto

Rappresenta una risorsa di istruzioni per il prossimo termine programmato.

Nome	Tipo	Descrizione
customTermEndDate	string (date-time)	La data di fine personalizzata del termine, in formato ISO 8601. Utilizza il formato data-ora ISO 8601.
priceBenefits	PriceBenefit[]	I benefici sul prezzo che verranno applicati al cambio programmato. I benefici di prezzo sono applicati automaticamente dal servizio e sono in sola lettura, quindi qualsiasi valore fornito su una richiesta viene sovrascritto. Questa proprietà viene omessa quando non si applica alcun beneficio di prezzo, e al massimo una voce viene restituita oggi.
product	SubscriptionProductTerm	Ulteriori prodotti associati alle istruzioni programmate per il prossimo semestre.
quantity	integer (int32)	Numero di unità.