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)。 省略可能なパラメーター。 サブスクリプションを "パートナー ID" でフィルター処理します。 このパラメーターを 'order id' と組み合わせることはできません。 |
|
|
order_id
|
query |
string |
注文識別子。 省略可能なパラメーター。 "order id" でサブスクリプションをフィルター処理します。 このパラメーターを 'partner id' と組み合わせることはできません。 |
|
|
product_subtype
|
query |
string |
製品サブタイプ。 省略可能なパラメーター。 "製品の種類" と "製品サブタイプ" でサブスクリプションをフィルター処理します。 |
|
|
product_type
|
query |
string |
製品の種類。 省略可能なパラメーター。 サブスクリプションを "製品の種類" でフィルター処理します。 |
要求ヘッダー
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
| Authorization | True |
string |
承認ベアラー トークン |
| ms-correlationid |
string |
要求を内部的に追跡するために使用されます。 ms-correlationid が指定されていない場合、サーバーは要求ごとに新しいものを生成します |
|
| ms-cv |
string |
要求を内部的に追跡するために使用されます。 ms-cv が指定されていない場合、サーバーは要求ごとに新しい 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 サービスまたはその依存関係の 1 つが要求を満たできませんでした。 呼び出し元はこれを再試行できます。 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 |