Manage orders - Get subscription by ID

Service:

Partner Center Rest

API Version:

v1

Retrieves a subscription by identifier for the customer of a partner by their active directory tenant identifier.

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

URI Parameters

Name	In	Required	Type	Description
customer_id	path	True	string	The customer's active directory tenant identifier.
subscription_id	path	True	string	The subscription identifier.
version	path	True	string

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	Microsoft.Partner.Services.Subscriptions.V1.Models.Subscription	The request was successful. The response body contains the subscription information. Media Types: "application/json", "text/json", "application/xml", "text/xml"
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", "application/xml", "text/xml"
401 Unauthorized		The request was not authenticated. The client needs to authenticate with the partner API service first. Media Types: "application/json", "text/json", "application/xml", "text/xml"
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", "application/xml", "text/xml"
404 Not Found		The resource is not found or not available with the given input parameters. Media Types: "application/json", "text/json", "application/xml", "text/xml"
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", "application/xml", "text/xml"

Definitions

Name	Description
Microsoft.Partner.Core.Collections.Link
Microsoft.Partner.Core.Collections.ResourceAttributes
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

Name	Type	Description
body	string
headers	System.Collections.Generic.KeyValuePair[System.String,System.String][]
method	string
uri	string

Microsoft.Partner.Core.Collections.ResourceAttributes

Name	Type	Description
etag	string
objectType	string

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

Name	Type	Description
displayName	string
id	string
subType	Microsoft.Partner.Services.Subscriptions.V1.Models.ItemType

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

Name	Type	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

Name	Type	Description
amount	number
currency	string
grain	string

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

Name	Type	Description
details	Microsoft.Partner.Services.Subscriptions.V1.Models.RefundableQuantityDetail[]
totalQuantity	integer

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

Name	Type	Description
allowedUntilDateTime	string
quantity	integer

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

Name	Type	Description
expiresAt	string
type	string

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

Name	Type	Description
customTermEndDate	string
product	Microsoft.Partner.Services.Subscriptions.V1.Models.ProductTerm
quantity	integer

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

Name	Type	Description
entitlementId	string
managementGroupId	string
resourceGroupId	string
subscriptionId	string
type	string

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

Name	Type	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

Name	Type	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

Name	Type	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]

Name	Type	Description
key	string
value	string