Manage orders - Get customer's subscriptions
Извлекает все подписки для клиента партнера по идентификатору клиента Active Directory.
GET https://api.partnercenter.microsoft.com/v{version}/customers/{customer_id}/subscriptionsGET 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
| Имя | В | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
customer_id
|
path | True |
string |
Идентификатор клиента Active Directory. |
|
version
|
path | True |
string |
|
|
mpn_id
|
query |
string |
Идентификатор партнера (mpn). Необязательный параметр. Фильтрация подписок по идентификатору партнера. Этот параметр не может сочетаться с идентификатором заказа. |
|
|
order_id
|
query |
string |
Идентификатор заказа. Необязательный параметр. Фильтрация подписок по идентификатору заказа. Этот параметр нельзя объединить с идентификатором партнера. |
|
|
product_subtype
|
query |
string |
Подтип продукта. Необязательный параметр. Фильтрация подписок по типу продукта и подтипу продукта. |
|
|
product_type
|
query |
string |
Тип продукта. Необязательный параметр. Фильтрация подписок по типу продукта. |
Заголовок запроса
| Имя | Обязательно | Тип | Описание |
|---|---|---|---|
| Authorization | True |
string |
Маркер носителя авторизации |
| ms-correlationid |
string |
Используется для отслеживания запросов внутри системы. Если ms-correlationid не указан, сервер создаст новый для каждого запроса. |
|
| ms-cv |
string |
Используется для отслеживания запросов внутри системы. Если ms-cv не предоставлено, сервер создаст новый для каждого запроса. |
|
| ms-requestid |
string |
Используется для идемпотентности запросов. Если ms-requestid не указан, сервер создаст новый для каждого запроса. |
Ответы
| Имя | Тип | Описание |
|---|---|---|
| 200 OK |
Запрос выполнен успешно. Текст ответа содержит подписки. Media Types: "application/json", "text/json" |
|
| 400 Bad Request |
Отсутствуют или недопустимые входные данные. Текст ответа предоставит сведения об ошибке. Media Types: "application/json", "text/json" |
|
| 401 Unauthorized |
Запрос не прошел проверку подлинности. Сначала клиент должен пройти проверку подлинности с помощью службы API партнеров. Media Types: "application/json", "text/json" |
|
| 403 Forbidden |
Запрос прошел проверку подлинности, но был отклонен, так как вызывающий объект не имеет прав на его вызов. Media Types: "application/json", "text/json" |
|
| 404 Not Found |
Ресурс не найден или недоступен с заданными входными параметрами. Media Types: "application/json", "text/json" |
|
| 500 Internal Server Error |
Служба API партнера или одна из зависимостей не выполнила запрос. Вызывающие могут повторить это. Media Types: "application/json", "text/json" |
Определения
Microsoft.Partner.Core.Collections.Link
| Имя | Тип | Описание |
|---|---|---|
| body |
string |
|
| headers |
System. |
|
| method |
string |
|
| uri |
string |
Microsoft.Partner.Core.Collections.ResourceAttributes
| Имя | Тип | Описание |
|---|---|---|
| etag |
string |
|
| objectType |
string |
Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Services.Subscriptions.V1.Models.Subscription]
| Имя | Тип | Описание |
|---|---|---|
| attributes | ||
| items |
Microsoft. |
|
| links | ||
| totalCount |
integer |
Microsoft.Partner.Core.Collections.ResourceLinks
| Имя | Тип | Описание |
|---|---|---|
| next | ||
| previous | ||
| self |
Microsoft.Partner.Services.Subscriptions.V1.Models.ItemType
| Имя | Тип | Описание |
|---|---|---|
| displayName |
string |
|
| id |
string |
|
| subType |
Microsoft.Partner.Services.Subscriptions.V1.Models.ProductTerm
| Имя | Тип | Описание |
|---|---|---|
| availabilityId |
string |
|
| billingCycle |
enum:
|
|
| productId |
string |
|
| skuId |
string |
|
| termDuration |
string |
Microsoft.Partner.Services.Subscriptions.V1.Models.PurchaseCommitment
| Имя | Тип | Описание |
|---|---|---|
| amount |
number |
|
| currency |
string |
|
| grain |
string |
Microsoft.Partner.Services.Subscriptions.V1.Models.RefundableQuantity
| Имя | Тип | Описание |
|---|---|---|
| details |
Microsoft. |
|
| totalQuantity |
integer |
Microsoft.Partner.Services.Subscriptions.V1.Models.RefundableQuantityDetail
| Имя | Тип | Описание |
|---|---|---|
| allowedUntilDateTime |
string |
|
| quantity |
integer |
Microsoft.Partner.Services.Subscriptions.V1.Models.RefundOption
| Имя | Тип | Описание |
|---|---|---|
| expiresAt |
string |
|
| type |
string |
Microsoft.Partner.Services.Subscriptions.V1.Models.ScheduledNextTermInstructions
| Имя | Тип | Описание |
|---|---|---|
| customTermEndDate |
string |
|
| product |
Microsoft. |
|
| quantity |
integer |
Microsoft.Partner.Services.Subscriptions.V1.Models.Scope
| Имя | Тип | Описание |
|---|---|---|
| entitlementId |
string |
|
| managementGroupId |
string |
|
| resourceGroupId |
string |
|
| subscriptionId |
string |
|
| type |
string |
Microsoft.Partner.Services.Subscriptions.V1.Models.Subscription
| Имя | Тип | Описание |
|---|---|---|
| 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
| Имя | Тип | Описание |
|---|---|---|
| autoRenewEnabled |
boolean |
|
| friendlyName |
string |
|
| id |
string |
|
| purchaseCommitment |
Microsoft. |
|
| quantity |
integer |
|
| scope | ||
| status |
enum:
|
Microsoft.Partner.Services.Subscriptions.V1.Models.SubscriptionLinks
| Имя | Тип | Описание |
|---|---|---|
| activationLinks | ||
| availability | ||
| entitlement | ||
| next | ||
| offer | ||
| parentSubscription | ||
| pendingChanges | ||
| previous | ||
| product | ||
| self | ||
| sku |
System.Collections.Generic.KeyValuePair[System.String,System.String]
| Имя | Тип | Описание |
|---|---|---|
| key |
string |
|
| value |
string |