Manage orders - Get customer's subscriptions

Servicio:

Partner Center Rest

Versión de la API:

v1

Recupera todas las suscripciones para el cliente de un asociado por su identificador de inquilino de Active Directory.

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

Con parámetros opcionales:

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 identificador URI

Nombre	En	Requerido	Tipo	Description
customer_id	path	True	string	Identificador de inquilino de Active Directory del cliente.
version	path	True	string
mpn_id	query		string	Identificador de asociado (mpn). Parámetro opcional. Filtre las suscripciones por "id. de asociado". Este parámetro no se puede combinar con "order id".
order_id	query		string	Identificador de pedido. Parámetro opcional. Filtre las suscripciones por "id. de pedido". Este parámetro no se puede combinar con "partner id".
product_subtype	query		string	Subtipo del producto. Parámetro opcional. Filtre las suscripciones por "tipo de producto" y "subtipo de producto".
product_type	query		string	Tipo de producto. Parámetro opcional. Filtre las suscripciones por "tipo de producto".

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Authorization	True	string	Token de portador de autorización
ms-correlationid		string	Se usa para realizar el seguimiento de las solicitudes internamente. Si no se proporciona un ms-correlationid, el servidor generará uno nuevo para cada solicitud.
ms-cv		string	Se usa para realizar el seguimiento de las solicitudes internamente. Si no se proporciona un ms-cv, el servidor generará uno nuevo para cada solicitud.
ms-requestid		string	Se usa para la idempoencia de las solicitudes. Si no se proporciona un ms-requestid, el servidor generará uno nuevo para cada solicitud.

Respuestas

Nombre	Tipo	Description
200 OK	Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Services.Subscriptions.V1.Models.Subscription]	La solicitud se realizó correctamente. El cuerpo de la respuesta contiene las suscripciones. Media Types: "application/json", "text/json"
400 Bad Request		Faltaba o faltaba una entrada no válida. El cuerpo de la respuesta proporcionará los detalles del error. Media Types: "application/json", "text/json"
401 Unauthorized		La solicitud no se autenticó. El cliente debe autenticarse primero con el servicio de API del asociado. Media Types: "application/json", "text/json"
403 Forbidden		La solicitud se autenticó pero se rechazó, ya que el autor de la llamada no tiene los derechos para invocarla. Media Types: "application/json", "text/json"
404 Not Found		El recurso no se encuentra o no está disponible con los parámetros de entrada especificados. Media Types: "application/json", "text/json"
500 Internal Server Error		El servicio de API del asociado o una de sus dependencias no pudieron cumplir la solicitud. Los autores de llamadas pueden volver a intentarlo. Media Types: "application/json", "text/json"

Definiciones

Nombre	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]

Microsoft.Partner.Core.Collections.Link

Nombre	Tipo	Description
body	string
headers	System.Collections.Generic.KeyValuePair[System.String,System.String][]
method	string
uri	string

Microsoft.Partner.Core.Collections.ResourceAttributes

Nombre	Tipo	Description
etag	string
objectType	string

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

Nombre	Tipo	Description
attributes	Microsoft.Partner.Core.Collections.ResourceAttributes
items	Microsoft.Partner.Services.Subscriptions.V1.Models.Subscription[]
links	Microsoft.Partner.Core.Collections.ResourceLinks
totalCount	integer

Microsoft.Partner.Core.Collections.ResourceLinks

Nombre	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

Nombre	Tipo	Description
displayName	string
id	string
subType	Microsoft.Partner.Services.Subscriptions.V1.Models.ItemType

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

Nombre	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

Nombre	Tipo	Description
amount	number
currency	string
grain	string

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

Nombre	Tipo	Description
details	Microsoft.Partner.Services.Subscriptions.V1.Models.RefundableQuantityDetail[]
totalQuantity	integer

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

Nombre	Tipo	Description
allowedUntilDateTime	string
quantity	integer

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

Nombre	Tipo	Description
expiresAt	string
type	string

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

Nombre	Tipo	Description
customTermEndDate	string
product	Microsoft.Partner.Services.Subscriptions.V1.Models.ProductTerm
quantity	integer

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

Nombre	Tipo	Description
entitlementId	string
managementGroupId	string
resourceGroupId	string
subscriptionId	string
type	string

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

Nombre	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

Nombre	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

Microsoft.Partner.Services.Subscriptions.V1.Models.SubscriptionLinks

Nombre	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]

Nombre	Tipo	Description
key	string
value	string