Manage orders - Get subscription by ID
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. |
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
Microsoft.Partner.Core.Collections.Link
| Name | Type | Description |
|---|---|---|
| body |
string |
|
| headers |
System. |
|
| 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.ProductTerm
| Name | Type | Description |
|---|---|---|
| availabilityId |
string |
|
| billingCycle |
enum:
|
|
| 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. |
|
| 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. |
|
| 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 | ||
| autoRenewEnabled |
boolean |
|
| billingCycle |
enum:
|
|
| billingType |
enum:
|
|
| commitmentEndDate |
string |
|
| contractType |
enum:
|
|
| creationDate |
string |
|
| effectiveStartDate |
string |
|
| entitlementId |
string |
|
| friendlyName |
string |
|
| hasPurchasableAddons |
boolean |
|
| id |
string |
|
| isMicrosoftProduct |
boolean |
|
| isTrial |
boolean |
|
| lineItems |
Microsoft. |
|
| links |
Microsoft. |
|
| migratedFromSubscriptionId |
string |
|
| offerId |
string |
|
| offerName |
string |
|
| orderId |
string |
|
| parentSubscriptionId |
string |
|
| partnerId |
string |
|
| productOrderId |
string |
|
| productType | ||
| promotionId |
string |
|
| publisherName |
string |
|
| quantity |
integer |
|
| refundOptions |
Microsoft. |
|
| refundableQuantity |
Microsoft. |
|
| renewalTermDuration |
string |
|
| scheduledNextTermInstructions |
Microsoft. |
|
| status |
enum:
|
|
| suspensionReasons |
string[] |
|
| termDuration |
string |
|
| unitType |
string |
Microsoft.Partner.Services.Subscriptions.V1.Models.SubscriptionLineItemDetail
| Name | Type | Description |
|---|---|---|
| autoRenewEnabled |
boolean |
|
| friendlyName |
string |
|
| id |
string |
|
| purchaseCommitment |
Microsoft. |
|
| quantity |
integer |
|
| scope | ||
| status |
enum:
|
Microsoft.Partner.Services.Subscriptions.V1.Models.SubscriptionLinks
| Name | Type | Description |
|---|---|---|
| activationLinks | ||
| availability | ||
| entitlement | ||
| next | ||
| offer | ||
| parentSubscription | ||
| pendingChanges | ||
| previous | ||
| product | ||
| self | ||
| sku |
System.Collections.Generic.KeyValuePair[System.String,System.String]
| Name | Type | Description |
|---|---|---|
| key |
string |
|
| value |
string |