Compartilhar via

Manage orders - Get customer's subscriptions

  • Referência
Serviço:
Partner Center Rest
Versão da API:
v1

Recupera todas as assinaturas para o cliente de um parceiro pelo identificador de locatário do Active Directory.

GET https://api.partnercenter.microsoft.com/v{version}/customers/{customer_id}/subscriptions
Com parâmetros opcionais: 
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}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
customer_id
 path True

string

O identificador de locatário do active directory do cliente.
version
 path True

string

mpn_id
 query

string

O identificador do parceiro (mpn). Parâmetro opcional. Filtrar assinaturas por 'id do parceiro'. Esse parâmetro não pode ser combinado com 'id de pedido'.
order_id
 query

string

O identificador da ordem. Parâmetro opcional. Filtrar assinaturas por 'id do pedido'. Esse parâmetro não pode ser combinado com 'id do parceiro'.
product_subtype
 query

string

O subtipo do produto. Parâmetro opcional. Filtrar assinaturas por "tipo de produto" e "subtipo de produto".
product_type
 query

string

O tipo de produto. Parâmetro opcional. Filtrar assinaturas por "tipo de produto".

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
Authorization True

string

Token de portador de autorização
ms-correlationid

string

Usado para acompanhar solicitações internamente. Se um ms-correlationid não for fornecido, o servidor gerará um novo para cada solicitação
ms-cv

string

Usado para acompanhar solicitações internamente. Se um ms-cv não for fornecido, o servidor gerará um novo para cada solicitação
ms-requestid

string

Usado para idempotency de solicitações. Se uma ms-requestid não for fornecida, o servidor gerará uma nova para cada solicitação

Respostas

Nome Tipo Description
200 OK

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

A solicitação foi bem-sucedida. O corpo da resposta contém as assinaturas.

Media Types: "application/json", "text/json"
400 Bad Request

Havia uma entrada ausente ou inválida. O corpo da resposta fornecerá os detalhes do erro.

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

A solicitação não foi autenticada. Primeiro, o cliente precisa se autenticar com o serviço de API do parceiro.

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

A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la.

Media Types: "application/json", "text/json"
404 Not Found

O recurso não foi encontrado ou não está disponível com os parâmetros de entrada especificados.

Media Types: "application/json", "text/json"
500 Internal Server Error

O serviço de API do parceiro ou uma de suas dependências não conseguiu atender à solicitação. Os chamadores podem repetir isso.

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

Definições

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

string

headers

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

method

string

uri

string

Microsoft.Partner.Core.Collections.ResourceAttributes

Nome Tipo Description
etag

string

objectType

string

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

Nome Tipo Description
attributes

Microsoft.Partner.Core.Collections.ResourceAttributes

items

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

links

Microsoft.Partner.Core.Collections.ResourceLinks

totalCount

integer

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

Nome Tipo Description
displayName

string

id

string

subType

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

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

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

Nome Tipo Description
amount

number

currency

string

grain

string

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

Nome Tipo Description
details

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

totalQuantity

integer

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

Nome Tipo Description
allowedUntilDateTime

string

quantity

integer

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

Nome Tipo Description
expiresAt

string

type

string

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

Nome Tipo Description
customTermEndDate

string

product

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

quantity

integer

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

Nome Tipo Description
entitlementId

string

managementGroupId

string

resourceGroupId

string

subscriptionId

string

type

string

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

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

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

Nome Tipo Description
key

string

value

string