Manage orders - Get customer subscriptions

Servicio:: Partner Center Rest

Versión de la API:: v1

Recupera suscripciones para un cliente socio mediante el identificador de inquilino Microsoft Entra.

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	El identificador de tenant Microsoft Entra del cliente.
version	path	True	string	La versión de la API de Partner Center. Usa la v1.
mpn_id	query		string	Filtra las suscripciones por el PartnerID del revendedor. Este parámetro no puede combinarse con order_id.
order_id	query		string	Filtra las suscripciones por identificador de orden. Este parámetro no puede combinarse con mpn_id, product_type ni product_subtype.
product_subtype	query		string	Filtra suscripciones por subtipo de producto. Úsalo con product_type.
product_type	query		string	Filtra las suscripciones por tipo de producto.

Encabezado de 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	SubscriptionCollection	La solicitud fue exitosa. 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. Quienes llaman pueden intentarlo de nuevo. Media Types: "application/json", "text/json"

Definiciones

Nombre	Description
BenefitScheduledNextTermInstructions	Representa las instrucciones que se aplican a un beneficio al inicio de su siguiente término.
ItemType	Representa un recurso de tipo objeto.
Link	Representa un recurso de enlace.
NextChargeInstructions	Representa instrucciones de facturación que deben aplicar al inicio del siguiente periodo de la suscripción.
PriceBenefit	Representa un beneficio de precio aplicado a una partida o suscripción. Hoy en día, el único tipo de beneficio es un Margen de Crecimiento CSP, indicado por un tipo de Margen de Crecimiento; el recurso está diseñado para poder llevar tipos de beneficios adicionales en futuras versiones. Los beneficios de precio se aplican automáticamente por el servicio y son de solo lectura, por lo que cualquier valor proporcionado en una solicitud queda sobrescrito. El efecto monetario del beneficio se refleja en las propiedades de precios existentes; este recurso solo identifica qué producto de descuento se aplicó.
PurchaseCommitment	Representa un recurso de compromiso de compra.
RefundableQuantity	Representa un recurso de cantidad reembolsable.
RefundableQuantityDetail	Representa un recurso de información de cantidad reembolsable.
RefundOption	Representa una opción de reembolso.
ResourceAttributes	Representa un recurso de atributos de recurso.
ResourceLinks	Representa un recurso de enlaces de recursos.
ScheduledAction	Representa un recurso de acción programada.
Scope	Representa un recurso de alcance.
StringStringKeyValuePair	Representa un recurso de par de valor clave.
Subscription	Representa un recurso de suscripción.
SubscriptionCollection	Representa un recurso de recolección de recursos.
SubscriptionLineItemDetail	Representa un recurso de detalle de partidas de suscripción.
SubscriptionLinks	Representa un recurso de enlaces de suscripción.
SubscriptionProductTerm	Representa un producto de término recurso.
SubscriptionScheduledNextTermInstructions	Representa un recurso de instrucciones de siguiente término programado.

BenefitScheduledNextTermInstructions

Objeto

Representa las instrucciones que se aplican a un beneficio al inicio de su siguiente término.

Nombre	Tipo	Description
billingCycle	enum: annual biennial monthly none one_time quadrennial quinquennial triennial unknown	El ciclo de facturación para solicitar el siguiente plazo. Los valores posibles incluyen: 'desconocido', 'mensual', 'anual', 'ninguno', 'one_time', 'trienal', 'bienal', 'cuadrienal', 'quinquenal'.
productCode	string	El código del producto para comprar el siguiente trimestre.
productId	string	El identificador del producto para comprar en el siguiente periodo.
purchaseCommitment	PurchaseCommitment	El compromiso de compra para solicitar el siguiente plazo.
skuId	string	El identificador para el SKU que debes comprar para el siguiente periodo.
termDuration	string	La duración del siguiente periodo, en formato ISO 8601.

ItemType

Objeto

Representa un recurso de tipo objeto.

Nombre	Tipo	Description
displayName	string	El nombre mostrado a los socios.
id	string	Identificador único para el tipo de artículo. El valor suele ser un GUID.
skuCategories	string[]	Las categorías de SKU asociadas al tipo de producto.
subType	ItemType	Subtipo adicional asociado al tipo de objeto.

Link

Objeto

Representa un recurso de enlace.

Nombre	Tipo	Description
body	string	El cuerpo del enlace.
headers	StringStringKeyValuePair[]	La colección de cabeceras asociada a este enlace.
method	string	El método para el enlace.
uri	string	El URI del recurso relacionado.

NextChargeInstructions

Objeto

Representa instrucciones de facturación que deben aplicar al inicio del siguiente periodo de la suscripción.

Nombre	Tipo	Description
product	SubscriptionProductTerm	El producto y el plazo de facturación para cobrar en el siguiente trimestre.
quantity	integer (int32)	La cantidad a facturar en el siguiente trimestre.

PriceBenefit

Objeto

Representa un beneficio de precio aplicado a una partida o suscripción. Hoy en día, el único tipo de beneficio es un Margen de Crecimiento CSP, indicado por un tipo de Margen de Crecimiento; el recurso está diseñado para poder llevar tipos de beneficios adicionales en futuras versiones. Los beneficios de precio se aplican automáticamente por el servicio y son de solo lectura, por lo que cualquier valor proporcionado en una solicitud queda sobrescrito. El efecto monetario del beneficio se refleja en las propiedades de precios existentes; este recurso solo identifica qué producto de descuento se aplicó.

Nombre	Tipo	Description
availabilityId	string	El identificador de disponibilidad del producto de descuento precio-beneficio. Identifica el precio específico de descuento que se aplicó.
productCode	string	El nombre universal del producto (UPN) del producto de descuento por precio y beneficios.
productId	string	El identificador del producto de descuento precio y beneficio.
skuId	string	El identificador SKU del producto de descuento precio y beneficio.
type	string	Tipo de ventaja de precio. Hoy solo se sostiene GrowthMargin.

PurchaseCommitment

Objeto

Representa un recurso de compromiso de compra.

Nombre	Tipo	Description
amount	number (double)	La cantidad monetaria.
currency	string	El código de moneda ISO de tres letras.
grain	string	El grano de medición utilizado para este valor.

RefundableQuantity

Objeto

Representa un recurso de cantidad reembolsable.

Nombre	Tipo	Description
details	RefundableQuantityDetail[]	La recopilación de datos asociados a esta cantidad reembolsable.
totalQuantity	integer (int32)	La cantidad total para la cantidad reembolsable.

RefundableQuantityDetail

Objeto

Representa un recurso de información de cantidad reembolsable.

Nombre	Tipo	Description
allowedUntilDateTime	string (date-time)	Permiten hasta la fecha límite para el detalle de la cantidad reembolsable. Utiliza el formato de fecha y hora ISO 8601.
quantity	integer (int32)	Número de unidades.

RefundOption

Objeto

Representa una opción de reembolso.

Nombre	Tipo	Description
expiresAt	string (date-time)	Expira en para la opción de reembolso. Utiliza el formato de fecha y hora ISO 8601.
type	string	El tipo de opción de reembolso.

ResourceAttributes

Objeto

Representa un recurso de atributos de recurso.

Nombre	Tipo	Description
etag	string	La etiqueta de entidad utilizada para el control de concurrencia.
objectType	string	El tipo de objeto para los atributos de recurso.

ResourceLinks

Objeto

Representa un recurso de enlaces de recursos.

Nombre	Tipo	Description
next	Link	Más información relacionada con los enlaces de recursos.
previous	Link	Otros anteriores asociados con los enlaces de recursos.
self	Link	Otros vínculos de recursos asociados.

ScheduledAction

Objeto

Representa un recurso de acción programada.

Nombre	Tipo	Description
actionType	enum: Cancel RenewToExtendedServiceTerm RenewToNewTerm Transition	La acción a realizar. Los valores soportados son RenewToExtendedServiceTerm, Cancel, RenewToNewTerm y Transition.
effectiveDate	string (date-time)	La fecha y hora en que entra en vigor una acción programada por Fecha de Custom, en formato ISO 8601.
instructions	BenefitScheduledNextTermInstructions	Las instrucciones de producto, cantidad y plazo para el cambio programado. No se usa para Cancelar.
scheduleType	enum: BillingCycleEnd CustomDate TermEnd	Cuando la acción tenga efecto. Los valores soportados son TermEnd, BillingCycleEnd y CustomDate.

Scope

Objeto

Representa un recurso de alcance.

Nombre	Tipo	Description
entitlementId	string	El identificador único del derecho. El valor suele ser un GUID.
managementGroupId	string	El identificador único del grupo de gestión. El valor suele ser un GUID.
resourceGroupId	string	El identificador único del grupo de recursos. El valor suele ser un GUID.
subscriptionId	string	El identificador único (GUID) de la suscripción. El valor suele ser un GUID.
type	string	El tipo de mira.

StringStringKeyValuePair

Objeto

Representa un recurso de par de valor clave.

Nombre	Tipo	Description
key	string	La clave para el par clave-valor.
value	string	El valor para el par clave-valor.

Subscription

Objeto

Representa un recurso de suscripción.

Nombre	Tipo	Description
actionTaken	boolean	Si esta suscripción se ha tomado.
actions	string[]	La colección de acciones asociadas a esta suscripción.
additionalPartnerIds	string[]	PartnersIDs adicionales de revendedores asignados a la suscripción por distribuidores en los mercados UE/EFTA.
attentionNeeded	boolean	Si esta suscripción necesitaba atención.
attentionReason	string	La razón de la atención de la suscripción.
attributes	ResourceAttributes	Atributos adicionales asociados a la suscripción.
autoRenewEnabled	boolean	Si esta suscripción se renueva automáticamente está activada.
billingCycle	enum: annual biennial monthly none one_time quadrennial quinquennial triennial unknown	Frecuencia de facturación. Los valores apoyados son desconocidos: mensual, anual, ninguno, one_time, trienal, bienal, cuadrienal y quinquenal.
billingCycleEndDate	string (date-time)	La fecha de finalización del ciclo de facturación de la suscripción, en formato ISO 8601.
billingCycleEndDateTime	string (date-time)	La fecha y hora de finalización del ciclo de facturación para la suscripción, en formato ISO 8601.
billingType	enum: benefit license none usage	El tipo de facturación de la suscripción. Los valores posibles incluyen: 'ninguno', 'uso', 'licencia', 'beneficio'.
cancellationAllowedUntilDate	string (date-time)	La última fecha y hora en que se permite la cancelación, en formato ISO 8601.
commitmentEndDate	string (date-time)	La fecha en que finaliza el compromiso actual, en formato ISO 8601. Utiliza el formato de fecha y hora ISO 8601.
commitmentEndDateTime	string (date-time)	La fecha y hora en que finaliza el compromiso de suscripción actual, en formato ISO 8601.
commitmentStartDate	string (date-time)	La fecha y hora en que comienza el compromiso de suscripción actual, en formato ISO 8601.
consumptionType	string	El tipo de consumo asociado a la suscripción.
contractType	enum: product_key redemption_code subscription	El tipo de contrato para la suscripción. Los valores posibles incluyen: 'suscripción', 'product_key', 'redemption_code'.
creationDate	string (date-time)	La fecha y hora en que se creó la suscripción, en formato ISO 8601. Utiliza el formato de fecha y hora ISO 8601.
effectiveStartDate	string (date-time)	La fecha de inicio efectiva de la suscripción. Utiliza el formato de fecha y hora ISO 8601.
entitlementId	string	El identificador único del derecho. El valor suele ser un GUID.
friendlyName	string	Un nombre de exhibición amigable para este artículo.
gracePeriodEndDate	string (date-time)	La fecha de finalización del periodo de gracia cuando la suscripción no se renueva, en formato ISO 8601.
hasPurchasableAddons	boolean	Si tiene complementos comprables.
id	string	Identificador único de la suscripción. El valor suele ser un GUID.
isMicrosoftProduct	boolean	Si es producto de Microsoft.
isTrial	boolean	Si es juicio.
lineItems	SubscriptionLineItemDetail[]	La colección de partidas asociadas a esta suscripción.
links	SubscriptionLinks	Enlaces a recursos relacionados.
migratedFromSubscriptionId	string	El identificador único de la migración de suscripción. El valor suele ser un GUID.
migratedToSubscriptionId	string	El identificador de la suscripción a la que se migró dicha suscripción.
nextChargeInstructions	NextChargeInstructions	Las instrucciones de facturación deben aplicarse al inicio del siguiente periodo cuando un cambio en el ciclo de facturación esté pendiente.
offerId	string	El identificador de la oferta. Para nuevas suscripciones de comercio, esto suele ser un identificador compuesto de artículo de catálogo producto:SKU:disponibilidad.
offerName	string	El nombre de la oferta para la suscripción.
orderId	string	El identificador del orden que creó la suscripción.
parentSubscriptionId	string	El identificador único de la suscripción principal. El valor suele ser un GUID.
partnerId	string	El PartnerID del revendedor registrado en el modelo de socio indirecto.
priceBenefits	PriceBenefit[]	Los beneficios de precio se aplicaban a esta suscripción para el periodo actual. Los beneficios de precio se aplican automáticamente por el servicio y son de solo lectura, por lo que cualquier valor proporcionado en una solicitud queda sobrescrito. Esta propiedad se omite cuando no se aplica ningún beneficio de precio, y como máximo se devuelve una entrada hoy.
productOrderId	string	El identificador de la orden de compra del producto, como una reserva o una orden de plan de ahorro de Azure.
productType	ItemType	Tipo de producto adicional asociado a la suscripción.
promotionId	string	El identificador de promoción se aplicaba a la suscripción, normalmente un identificador compuesto product:SKU:availability.
publisherName	string	El nombre de la editorial de la suscripción.
quantity	integer (int32)	Número de unidades.
refundOptions	RefundOption[]	La colección de opciones de reembolso asociadas a esta suscripción.
refundableQuantity	RefundableQuantity	Cantidad adicional reembolsable asociada a la suscripción.
renewalTermDuration	string	La duración del plazo de renovación de la suscripción.
scheduledActions	ScheduledAction[]	La colección de acciones programadas asociadas a esta suscripción.
scheduledNextTermInstructions	SubscriptionScheduledNextTermInstructions	Instrucciones adicionales programadas para el próximo trimestre asociadas a la suscripción.
status	enum: active deleted disabled expired none pending suspended	El estado actual de la suscripción. Los valores posibles incluyen: 'ninguno', 'activo', 'pendiente', 'suspendido', 'expirado', 'deshabilitado', 'eliminado'.
suspensionReasons	string[]	La colección de motivos de suspensión asociados a esta suscripción.
termDuration	string	La duración del plazo de suscripción (por ejemplo, P1M para mensual o P1Y para anual).
termLifeCycleState	string	El término ciclo de vida indica la suscripción.
unitType	string	El tipo de unidad para la suscripción.

SubscriptionCollection

Objeto

Representa un recurso de recolección de recursos.

Nombre	Tipo	Description
attributes	ResourceAttributes	Atributos adicionales asociados a la colección de recursos.
items	Subscription[]	La colección de objetos asociados a esta colección de recursos.
links	ResourceLinks	Enlaces a recursos relacionados.
totalCount	integer (int32)	El número total de elementos disponibles en el conjunto de resultados.

SubscriptionLineItemDetail

Objeto

Representa un recurso de detalle de partidas de suscripción.

Nombre	Tipo	Description
autoRenewEnabled	boolean	Si esta suscripción de detalle de línea está activada para renovar automáticamente.
friendlyName	string	Un nombre de exhibición amigable para este artículo.
id	string	Identificador único para el detalle de la línea de la suscripción. El valor suele ser un GUID.
purchaseCommitment	PurchaseCommitment	El compromiso de compra asociado a este artículo.
quantity	integer (int32)	Número de unidades.
scope	Scope	Ámbito adicional asociado al detalle de la línea de la suscripción.
status	enum: active deleted disabled expired none pending suspended	El estado actual de la suscripción. Los valores posibles incluyen: 'ninguno', 'activo', 'pendiente', 'suspendido', 'expirado', 'deshabilitado', 'eliminado'.

SubscriptionLinks

Objeto

Representa un recurso de enlaces de suscripción.

Nombre	Tipo	Description
activationLinks	Link	Enlaces adicionales de activación asociados a los enlaces de suscripción.
availability	Link	Disponibilidad adicional asociada a los enlaces de suscripción.
entitlement	Link	Derechos adicionales asociados a los enlaces de suscripción.
next	Link	Más información relacionada con los enlaces de suscripción.
offer	Link	Oferta adicional asociada a los enlaces de suscripción.
parentSubscription	Link	Suscripción adicional a los padres asociados a los enlaces de suscripción.
pendingChanges	Link	Cambios adicionales pendientes asociados con los enlaces de suscripción.
previous	Link	Información adicional previa relacionada con los enlaces de suscripción.
product	Link	Productos adicionales asociados con los enlaces de suscripción.
self	Link	Otros enlaces de suscripción a los demás.
sku	Link	Sku adicional asociado a los enlaces de suscripción.

SubscriptionProductTerm

Objeto

Representa un producto de término recurso.

Nombre	Tipo	Description
availabilityId	string	El identificador de disponibilidad dentro del producto y SKU.
billingCycle	enum: annual biennial monthly none one_time quadrennial quinquennial triennial unknown	Frecuencia de facturación. Los valores apoyados son desconocidos: mensual, anual, ninguno, one_time, trienal, bienal, cuadrienal y quinquenal.
productId	string	El identificador del producto para el siguiente término.
promotionId	string	El identificador de promoción que se aplicará en el siguiente término, normalmente un identificador compuesto product:SKU:availability.
skuId	string	El identificador SKU dentro del producto.
termDuration	string	La duración del plazo de suscripción (por ejemplo, P1M para mensual o P1Y para anual).

SubscriptionScheduledNextTermInstructions

Objeto

Representa un recurso de instrucciones de siguiente término programado.

Nombre	Tipo	Description
customTermEndDate	string (date-time)	La fecha de finalización personalizada del término, en formato ISO 8601. Utiliza el formato de fecha y hora ISO 8601.
priceBenefits	PriceBenefit[]	Los beneficios de precio que se aplicarán en el cambio programado. Los beneficios de precio se aplican automáticamente por el servicio y son de solo lectura, por lo que cualquier valor proporcionado en una solicitud queda sobrescrito. Esta propiedad se omite cuando no se aplica ningún beneficio de precio, y como máximo se devuelve una entrada hoy.
product	SubscriptionProductTerm	Producto adicional relacionado con las instrucciones programadas para el próximo trimestre.
quantity	integer (int32)	Número de unidades.