Manage orders - Get customer subscriptions

Service:

Partner Center Rest

API Version:

v1

Retrieves subscriptions for a partner customer by Microsoft Entra tenant identifier.

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

With optional parameters:

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}

URI Parameters

Name	In	Required	Type	Description
customer_id	path	True	string	The customer's Microsoft Entra tenant identifier.
version	path	True	string	The Partner Center API version. Use v1.
mpn_id	query		string	Filters subscriptions by the reseller PartnerID. This parameter cannot be combined with order_id.
order_id	query		string	Filters subscriptions by order identifier. This parameter cannot be combined with mpn_id, product_type, or product_subtype.
product_subtype	query		string	Filters subscriptions by product subtype. Use with product_type.
product_type	query		string	Filters subscriptions by product type.

Request Header

Name	Required	Type	Description
Authorization	True	string	Authorization Bearer token
ms-correlationid		string	Used for tracking requests internally. If a ms-correlationid is not provided, the server will generate a new one for each request
ms-cv		string	Used for tracking requests internally. If a ms-cv is not provided, the server will generate a new one for each request
ms-requestid		string	Used for idempotency of requests. If a ms-requestid is not provided, the server will generate a new one for each request

Responses

Name	Type	Description
200 OK	SubscriptionCollection	The request was successful. The response body contains the subscriptions. Media Types: "application/json", "text/json"
400 Bad Request		There was a missing or an invalid input. The response body will provide the error details. Media Types: "application/json", "text/json"
401 Unauthorized		The request was not authenticated. The client needs to authenticate with the partner API service first. Media Types: "application/json", "text/json"
403 Forbidden		The request was authenticated but was refused since the caller does not have the rights to invoke it. Media Types: "application/json", "text/json"
404 Not Found		The resource is not found or not available with the given input parameters. Media Types: "application/json", "text/json"
500 Internal Server Error		The partner API service or one of its dependencies failed to fulfill the request. Callers may retry this. Media Types: "application/json", "text/json"

Definitions

Name	Description
BenefitScheduledNextTermInstructions	Represents the instructions that are applied to a benefit at the start of its next term.
ItemType	Represents a item type resource.
Link	Represents a link resource.
NextChargeInstructions	Represents billing instructions to apply at the start of the subscription's next term.
PriceBenefit	Represents a price benefit applied to a line item or subscription. Today the only benefit kind is a CSP Growth Margin, indicated by a type of GrowthMargin; the resource is shaped so it can carry additional benefit kinds in future releases. Price benefits are auto-applied by the service and are read-only, so any value supplied on a request is overwritten. The monetary effect of the benefit is reflected through the existing pricing properties; this resource only identifies which discount product was applied.
PurchaseCommitment	Represents a purchase commitment resource.
RefundableQuantity	Represents a refundable quantity resource.
RefundableQuantityDetail	Represents a refundable quantity detail resource.
RefundOption	Represents a refund option resource.
ResourceAttributes	Represents a resource attributes resource.
ResourceLinks	Represents a resource links resource.
ScheduledAction	Represents a scheduled action resource.
Scope	Represents a scope resource.
StringStringKeyValuePair	Represents a key value pair resource.
Subscription	Represents a subscription resource.
SubscriptionCollection	Represents a resource collection resource.
SubscriptionLineItemDetail	Represents a subscription line item detail resource.
SubscriptionLinks	Represents a subscription links resource.
SubscriptionProductTerm	Represents a product term resource.
SubscriptionScheduledNextTermInstructions	Represents a scheduled next term instructions resource.

BenefitScheduledNextTermInstructions

Object

Represents the instructions that are applied to a benefit at the start of its next term.

Name	Type	Description
billingCycle	enum: annual biennial monthly none one_time quadrennial quinquennial triennial unknown	The billing cycle to apply for the next term. Possible values include: 'unknown', 'monthly', 'annual', 'none', 'one_time', 'triennial', 'biennial', 'quadrennial', 'quinquennial'.
productCode	string	The product code for the product to purchase for the next term.
productId	string	The identifier for the product to purchase for the next term.
purchaseCommitment	PurchaseCommitment	The purchase commitment to apply for the next term.
skuId	string	The identifier for the SKU to purchase for the next term.
termDuration	string	The duration of the next term, in ISO 8601 format.

ItemType

Object

Represents a item type resource.

Name	Type	Description
displayName	string	The display name shown to partners.
id	string	Unique identifier for the item type. Value is typically a GUID.
skuCategories	string[]	The SKU categories associated with the product type.
subType	ItemType	Additional sub type associated with the item type.

Link

Object

Represents a link resource.

Name	Type	Description
body	string	The body for the link.
headers	StringStringKeyValuePair[]	The collection of headers associated with this link.
method	string	The method for the link.
uri	string	The URI for the related resource.

NextChargeInstructions

Object

Represents billing instructions to apply at the start of the subscription's next term.

Name	Type	Description
product	SubscriptionProductTerm	The product and billing term to charge in the next term.
quantity	integer (int32)	The quantity to bill in the next term.

PriceBenefit

Object

Represents a price benefit applied to a line item or subscription. Today the only benefit kind is a CSP Growth Margin, indicated by a type of GrowthMargin; the resource is shaped so it can carry additional benefit kinds in future releases. Price benefits are auto-applied by the service and are read-only, so any value supplied on a request is overwritten. The monetary effect of the benefit is reflected through the existing pricing properties; this resource only identifies which discount product was applied.

Name	Type	Description
availabilityId	string	The availability identifier of the price benefit discount product. Identifies the specific discount price point that was applied.
productCode	string	The universal product name (UPN) of the price benefit discount product.
productId	string	The product identifier of the price benefit discount product.
skuId	string	The SKU identifier of the price benefit discount product.
type	string	The price benefit type. Only GrowthMargin is supported today.

PurchaseCommitment

Object

Represents a purchase commitment resource.

Name	Type	Description
amount	number (double)	The monetary amount.
currency	string	The three-letter ISO currency code.
grain	string	The measurement grain used for this value.

RefundableQuantity

Object

Represents a refundable quantity resource.

Name	Type	Description
details	RefundableQuantityDetail[]	The collection of details associated with this refundable quantity.
totalQuantity	integer (int32)	The total quantity for the refundable quantity.

RefundableQuantityDetail

Object

Represents a refundable quantity detail resource.

Name	Type	Description
allowedUntilDateTime	string (date-time)	The allowed until date time for the refundable quantity detail. Uses ISO 8601 date-time format.
quantity	integer (int32)	The number of units.

RefundOption

Object

Represents a refund option resource.

Name	Type	Description
expiresAt	string (date-time)	The expires at for the refund option. Uses ISO 8601 date-time format.
type	string	The type of a refund option.

ResourceAttributes

Object

Represents a resource attributes resource.

Name	Type	Description
etag	string	The entity tag used for concurrency control.
objectType	string	The object type for the resource attributes.

ResourceLinks

Object

Represents a resource links resource.

Name	Type	Description
next	Link	Additional next associated with the resource links.
previous	Link	Additional previous associated with the resource links.
self	Link	Additional self associated with the resource links.

ScheduledAction

Object

Represents a scheduled action resource.

Name	Type	Description
actionType	enum: Cancel RenewToExtendedServiceTerm RenewToNewTerm Transition	The action to perform. Supported values are RenewToExtendedServiceTerm, Cancel, RenewToNewTerm, and Transition.
effectiveDate	string (date-time)	The date and time when a CustomDate scheduled action takes effect, in ISO 8601 format.
instructions	BenefitScheduledNextTermInstructions	The product, quantity, and term instructions for the scheduled change. Not used for Cancel.
scheduleType	enum: BillingCycleEnd CustomDate TermEnd	When the action takes effect. Supported values are TermEnd, BillingCycleEnd, and CustomDate.

Scope

Object

Represents a scope resource.

Name	Type	Description
entitlementId	string	The unique identifier of the entitlement. Value is typically a GUID.
managementGroupId	string	The unique identifier of the management group. Value is typically a GUID.
resourceGroupId	string	The unique identifier of the resource group. Value is typically a GUID.
subscriptionId	string	The unique identifier (GUID) of the subscription. Value is typically a GUID.
type	string	The type of a scope.

StringStringKeyValuePair

Object

Represents a key value pair resource.

Name	Type	Description
key	string	The key for the key value pair.
value	string	The value for the key value pair.

Subscription

Object

Represents a subscription resource.

Name	Type	Description
actionTaken	boolean	Whether this subscription action taken.
actions	string[]	The collection of actions associated with this subscription.
additionalPartnerIds	string[]	Additional reseller PartnerIDs assigned to the subscription by distributors in EU/EFTA markets.
attentionNeeded	boolean	Whether this subscription attention needed.
attentionReason	string	The attention reason for the subscription.
attributes	ResourceAttributes	Additional attributes associated with the subscription.
autoRenewEnabled	boolean	Whether this subscription auto renew enabled.
billingCycle	enum: annual biennial monthly none one_time quadrennial quinquennial triennial unknown	The billing frequency. Supported values are unknown, monthly, annual, none, one_time, triennial, biennial, quadrennial, and quinquennial.
billingCycleEndDate	string (date-time)	The billing cycle end date for the subscription, in ISO 8601 format.
billingCycleEndDateTime	string (date-time)	The billing cycle end date and time for the subscription, in ISO 8601 format.
billingType	enum: benefit license none usage	The billing type for the subscription. Possible values include: 'none', 'usage', 'license', 'benefit'.
cancellationAllowedUntilDate	string (date-time)	The last date and time when cancellation is allowed, in ISO 8601 format.
commitmentEndDate	string (date-time)	The date when the current commitment ends, in ISO 8601 format. Uses ISO 8601 date-time format.
commitmentEndDateTime	string (date-time)	The date and time when the current subscription commitment ends, in ISO 8601 format.
commitmentStartDate	string (date-time)	The date and time when the current subscription commitment starts, in ISO 8601 format.
consumptionType	string	The consumption type associated with the subscription.
contractType	enum: product_key redemption_code subscription	The contract type for the subscription. Possible values include: 'subscription', 'product_key', 'redemption_code'.
creationDate	string (date-time)	The date and time when the subscription was created, in ISO 8601 format. Uses ISO 8601 date-time format.
effectiveStartDate	string (date-time)	The effective start date for the subscription. Uses ISO 8601 date-time format.
entitlementId	string	The unique identifier of the entitlement. Value is typically a GUID.
friendlyName	string	A friendly display name for this item.
gracePeriodEndDate	string (date-time)	The end date of the grace period when the subscription does not renew, in ISO 8601 format.
hasPurchasableAddons	boolean	Whether has purchasable addons.
id	string	Unique identifier for the subscription. Value is typically a GUID.
isMicrosoftProduct	boolean	Whether is microsoft product.
isTrial	boolean	Whether is trial.
lineItems	SubscriptionLineItemDetail[]	The collection of line items associated with this subscription.
links	SubscriptionLinks	Links to related resources.
migratedFromSubscriptionId	string	The unique identifier of the migrated from subscription. Value is typically a GUID.
migratedToSubscriptionId	string	The identifier of the subscription to which this subscription was migrated.
nextChargeInstructions	NextChargeInstructions	The billing instructions to apply at the start of the next term when a billing cycle change is pending.
offerId	string	The offer identifier. For new commerce subscriptions, this is typically a product:SKU:availability composite catalog item identifier.
offerName	string	The offer name for the subscription.
orderId	string	The identifier of the order that created the subscription.
parentSubscriptionId	string	The unique identifier of the parent subscription. Value is typically a GUID.
partnerId	string	The PartnerID of the reseller of record in the indirect partner model.
priceBenefits	PriceBenefit[]	The price benefits applied to this subscription for the current term. Price benefits are auto-applied by the service and are read-only, so any value supplied on a request is overwritten. This property is omitted when no price benefit applies, and at most one entry is returned today.
productOrderId	string	The identifier of the product purchase order, such as a reservation or Azure savings plan order.
productType	ItemType	Additional product type associated with the subscription.
promotionId	string	The promotion identifier applied to the subscription, typically a product:SKU:availability composite identifier.
publisherName	string	The publisher name for the subscription.
quantity	integer (int32)	The number of units.
refundOptions	RefundOption[]	The collection of refund options associated with this subscription.
refundableQuantity	RefundableQuantity	Additional refundable quantity associated with the subscription.
renewalTermDuration	string	The renewal term duration for the subscription.
scheduledActions	ScheduledAction[]	The collection of scheduled actions associated with this subscription.
scheduledNextTermInstructions	SubscriptionScheduledNextTermInstructions	Additional scheduled next term instructions associated with the subscription.
status	enum: active deleted disabled expired none pending suspended	The current subscription status. Possible values include: 'none', 'active', 'pending', 'suspended', 'expired', 'disabled', 'deleted'.
suspensionReasons	string[]	The collection of suspension reasons associated with this subscription.
termDuration	string	The duration of the subscription term (for example, P1M for monthly or P1Y for annual).
termLifeCycleState	string	The term life cycle state for the subscription.
unitType	string	The unit type for the subscription.

SubscriptionCollection

Object

Represents a resource collection resource.

Name	Type	Description
attributes	ResourceAttributes	Additional attributes associated with the resource collection.
items	Subscription[]	The collection of items associated with this resource collection.
links	ResourceLinks	Links to related resources.
totalCount	integer (int32)	The total number of items available in the result set.

SubscriptionLineItemDetail

Object

Represents a subscription line item detail resource.

Name	Type	Description
autoRenewEnabled	boolean	Whether this subscription line item detail auto renew enabled.
friendlyName	string	A friendly display name for this item.
id	string	Unique identifier for the subscription line item detail. Value is typically a GUID.
purchaseCommitment	PurchaseCommitment	The purchase commitment associated with this item.
quantity	integer (int32)	The number of units.
scope	Scope	Additional scope associated with the subscription line item detail.
status	enum: active deleted disabled expired none pending suspended	The current subscription status. Possible values include: 'none', 'active', 'pending', 'suspended', 'expired', 'disabled', 'deleted'.

SubscriptionLinks

Object

Represents a subscription links resource.

Name	Type	Description
activationLinks	Link	Additional activation links associated with the subscription links.
availability	Link	Additional availability associated with the subscription links.
entitlement	Link	Additional entitlement associated with the subscription links.
next	Link	Additional next associated with the subscription links.
offer	Link	Additional offer associated with the subscription links.
parentSubscription	Link	Additional parent subscription associated with the subscription links.
pendingChanges	Link	Additional pending changes associated with the subscription links.
previous	Link	Additional previous associated with the subscription links.
product	Link	Additional product associated with the subscription links.
self	Link	Additional self associated with the subscription links.
sku	Link	Additional sku associated with the subscription links.

SubscriptionProductTerm

Object

Represents a product term resource.

Name	Type	Description
availabilityId	string	The availability identifier within the product and SKU.
billingCycle	enum: annual biennial monthly none one_time quadrennial quinquennial triennial unknown	The billing frequency. Supported values are unknown, monthly, annual, none, one_time, triennial, biennial, quadrennial, and quinquennial.
productId	string	The product identifier for the next term.
promotionId	string	The promotion identifier to apply in the next term, typically a product:SKU:availability composite identifier.
skuId	string	The SKU identifier within the product.
termDuration	string	The duration of the subscription term (for example, P1M for monthly or P1Y for annual).

SubscriptionScheduledNextTermInstructions

Object

Represents a scheduled next term instructions resource.

Name	Type	Description
customTermEndDate	string (date-time)	The custom end date for the term, in ISO 8601 format. Uses ISO 8601 date-time format.
priceBenefits	PriceBenefit[]	The price benefits that will be applied at the scheduled change. Price benefits are auto-applied by the service and are read-only, so any value supplied on a request is overwritten. This property is omitted when no price benefit applies, and at most one entry is returned today.
product	SubscriptionProductTerm	Additional product associated with the scheduled next term instructions.
quantity	integer (int32)	The number of units.