Manage orders - Get customer subscriptions

サービス:: Partner Center Rest

API バージョン:: v1

パートナー顧客のサブスクリプションをMicrosoft Entraテナント識別子で取得します。

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

省略可能なパラメーターを含む:

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 パラメーター

名前	/	必須	型	説明
customer_id	path	True	string	顧客のMicrosoft Entraテナント識別子。
version	path	True	string	パートナーセンターAPIバージョンです。 v1を使いましょう。
mpn_id	query		string	リセラーPartnerIDでサブスクリプションをフィルタリングします。このパラメータはorder_idと組み合わせることはできません。
order_id	query		string	注文識別子で購読をフィルタリングします。このパラメータはmpn_id、product_type、product_subtypeと組み合わせることはできません。
product_subtype	query		string	購読を製品サブタイプでフィルタリングします。 product_typeと一緒に使う。
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	SubscriptionCollection	要求は成功しました。応答本文には、サブスクリプションが含まれています。 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"

定義

名前	説明
BenefitScheduledNextTermInstructions	次の任期開始時に給付に適用される指示を表します。
ItemType	アイテムタイプのリソースを表します。
Link	リンクリソースを表します。
NextChargeInstructions	サブスクリプションの次の期間開始時に適用される請求指示を表しています。
PriceBenefit	項目やサブスクリプションに適用される価格のメリットを表します。現在、唯一のベネフィットの種類はCSPグロースマージンであり、これはGrowthMarginの一種で示されます。このリソースは、将来のリリースで追加のベネフィットタイプを搭載できるように形状されています。価格のメリットはサービスによって自動的に適用され読み取り専用であるため、リクエストで提供された値は上書きされます。給付の金銭的効果は既存の価格設定プロパティに反映されます。このリソースは、どの割引商品が適用されたかのみを特定します。
PurchaseCommitment	購入コミットメントのリソースを表しています。
RefundableQuantity	返還可能な数量資源を表します。
RefundableQuantityDetail	返金可能な数量詳細資料を表します。
RefundOption	返金オプションのリソースを表しています。
ResourceAttributes	リソース属性のリソースを表します。
ResourceLinks	リソースリンクリソースを表します。
ScheduledAction	スケジュールされたアクションリソースを表します。
Scope	スコープリソースを表します。
StringStringKeyValuePair	鍵対リソースを表します。
Subscription	サブスクリプションリソースを表しています。
SubscriptionCollection	資源収集リソースを表します。
SubscriptionLineItemDetail	サブスクリプションの項目詳細リソースを表します。
SubscriptionLinks	サブスクリプションリンクリソースを表しています。
SubscriptionProductTerm	商品語リソースを表します。
SubscriptionScheduledNextTermInstructions	次の学期の指示リソースをスケジュールされています。

BenefitScheduledNextTermInstructions

Object

次の任期開始時に給付に適用される指示を表します。

名前	型	説明
billingCycle	enum: annual biennial monthly none one_time quadrennial quinquennial triennial unknown	次の期間の請求サイクルを申請します。可能な値は「不明」「月ごと」「年次」「なし」「one_time年」「三年ごとの年」「二年ごとの年」「四年ごとの年」「五年ごとの年」などがあります。
productCode	string	次の期間に購入する商品コード。
productId	string	次の期間に購入する商品の識別子です。
purchaseCommitment	PurchaseCommitment	次の学期の申請に関する購入の約束。
skuId	string	次の期間に購入するSKUの識別子です。
termDuration	string	次の学期の期間はISO 8601形式で記載されています。

ItemType

Object

アイテムタイプのリソースを表します。

名前	型	説明
displayName	string	表示名はパートナーに表示されます。
id	string	アイテムタイプの一意識別子。価値は通常GUIDです。
skuCategories	string[]	商品タイプに関連するSKUカテゴリ。
subType	ItemType	アイテムタイプに関連する追加のサブタイプ。

Link

Object

リンクリソースを表します。

名前	型	説明
body	string	リンクの本体だ。
headers	StringStringKeyValuePair[]	このリンクに関連するヘッダーの集合。
method	string	リンクの方法について。
uri	string	関連リソースのURIです。

NextChargeInstructions

Object

サブスクリプションの次の期間開始時に適用される請求指示を表しています。

名前	型	説明
product	SubscriptionProductTerm	商品と請求期間は次の期間に請求します。
quantity	integer (int32)	次の期間に請求する金額。

PriceBenefit

Object

項目やサブスクリプションに適用される価格のメリットを表します。現在、唯一のベネフィットの種類はCSPグロースマージンであり、これはGrowthMarginの一種で示されます。このリソースは、将来のリリースで追加のベネフィットタイプを搭載できるように形状されています。価格のメリットはサービスによって自動的に適用され読み取り専用であるため、リクエストで提供された値は上書きされます。給付の金銭的効果は既存の価格設定プロパティに反映されます。このリソースは、どの割引商品が適用されたかのみを特定します。

名前	型	説明
availabilityId	string	価格、利益割引商品の可用性識別子。適用された具体的な割引価格を特定します。
productCode	string	価格、便益、割引商品のユニバーサル製品名(UPN)。
productId	string	価格、利益割引商品の製品識別子。
skuId	string	価格便益割引商品のSKU識別子。
type	string	価格特典の種類。現在サポートされているのはGrowthMarginのみです。

PurchaseCommitment

Object

購入コミットメントのリソースを表しています。

名前	型	説明
amount	number (double)	金額です。
currency	string	3文字のISO通貨コード。
grain	string	この値に使われる測定粒。

RefundableQuantity

Object

返還可能な数量資源を表します。

名前	型	説明
details	RefundableQuantityDetail[]	この返金可能な金額に関連する詳細の収集。
totalQuantity	integer (int32)	返還可能な金額の総額です。

RefundableQuantityDetail

Object

返金可能な数量詳細資料を表します。

名前	型	説明
allowedUntilDateTime	string (date-time)	返金可能な数量の詳細は日付まで許可されています。 ISO 8601の日付時間形式を使用しています。
quantity	integer (int32)	単位の数。

RefundOption

Object

返金オプションのリソースを表しています。

名前	型	説明
expiresAt	string (date-time)	返金オプションは期限切れです。 ISO 8601の日付時間形式を使用しています。
type	string	返金オプションの種類。

ResourceAttributes

Object

リソース属性のリソースを表します。

名前	型	説明
etag	string	並行制御に使われるエンティティタグ。
objectType	string	リソース属性のオブジェクトタイプです。

ResourceLinks

Object

リソースリンクリソースを表します。

名前	型	説明
next	Link	リソースリンクに関連する追加の次。
previous	Link	リソースリンクに関連する追加の過去。
self	Link	リソースリンクには関連した追加情報もあります。

ScheduledAction

Object

スケジュールされたアクションリソースを表します。

名前	型	説明
actionType	enum: Cancel RenewToExtendedServiceTerm RenewToNewTerm Transition	実行すべきアクション。サポートされる値は、RenewToExtendedServiceTerm、Cancel、RenewToNewTerm、Transitionです。
effectiveDate	string (date-time)	CustomDateのスケジュールされたアクションが発効する日時(ISO 8601形式)。
instructions	BenefitScheduledNextTermInstructions	予定変更の製品、数量、期の指示。キャンセルには使われていません。
scheduleType	enum: BillingCycleEnd CustomDate TermEnd	行動が発動したときに。サポートされる値はTermEnd、BillingCycleEnd、CustomDateです。

Scope

Object

スコープリソースを表します。

名前	型	説明
entitlementId	string	権利の一意識別子。価値は通常GUIDです。
managementGroupId	string	管理グループの固有識別子。価値は通常GUIDです。
resourceGroupId	string	リソースグループの一意識別子です。価値は通常GUIDです。
subscriptionId	string	サブスクリプションの一意識別子(GUID)です。価値は通常GUIDです。
type	string	スコープの種類。

StringStringKeyValuePair

Object

鍵対リソースを表します。

名前	型	説明
key	string	キー値ペアの鍵です。
value	string	鍵値ペアの価値です。

Subscription

Object

サブスクリプションリソースを表しています。

名前	型	説明
actionTaken	boolean	このサブスクリプションの行動が取られたかどうか。
actions	string[]	このサブスクリプションに関連するアクションのコレクション。
additionalPartnerIds	string[]	EU/EFTA市場のディストリビューターからサブスクリプションに割り当てられた追加のリセラーPartnerID。
attentionNeeded	boolean	このサブスクリプションの注意が必要かどうか。
attentionReason	string	サブスクリプションの注目理由。
attributes	ResourceAttributes	サブスクリプションに関連する追加機能。
autoRenewEnabled	boolean	このサブスクリプションが自動更新が有効かどうか。
billingCycle	enum: annual biennial monthly none one_time quadrennial quinquennial triennial unknown	請求頻度。支持される価値は不明、月ごと、年次、なし、one_time、三年ごとのもの、隔年ごとのもの、四年ごとのもの、そして五年ごとのものがあります。
billingCycleEndDate	string (date-time)	サブスクリプションの請求サイクル終了日(ISO 8601形式)。
billingCycleEndDateTime	string (date-time)	購読の請求サイクル終了日と時間(ISO 8601形式)。
billingType	enum: benefit license none usage	サブスクリプションの請求形式。可能な値には「なし」「使用」「ライセンス」「利益」などがあります。
cancellationAllowedUntilDate	string (date-time)	解約が許可される最終日時(ISO 8601形式)。
commitmentEndDate	string (date-time)	現在のコミットメントが終了する日付(ISO 8601形式)。 ISO 8601の日付時間形式を使用しています。
commitmentEndDateTime	string (date-time)	現在のサブスクリプション契約が終了する日時(ISO 8601形式)。
commitmentStartDate	string (date-time)	現在のサブスクリプション契約が開始される日時(ISO 8601形式)。
consumptionType	string	サブスクリプションに関連する消費タイプ。
contractType	enum: product_key redemption_code subscription	サブスクリプションの契約タイプ。可能な値には「サブスクリプション」「product_key」「redemption_code」があります。
creationDate	string (date-time)	サブスクリプションが作成された日付と時刻(ISO 8601形式)。 ISO 8601の日付時間形式を使用しています。
effectiveStartDate	string (date-time)	サブスクリプションの有効開始日。 ISO 8601の日付時間形式を使用しています。
entitlementId	string	権利の一意識別子。価値は通常GUIDです。
friendlyName	string	このアイテムの親しみやすい表示名です。
gracePeriodEndDate	string (date-time)	購読が更新されない猶予期間の終了日(ISO 8601形式)。
hasPurchasableAddons	boolean	購入可能なアドオンがあるかどうか。
id	string	サブスクリプションの一意の識別子です。価値は通常GUIDです。
isMicrosoftProduct	boolean	Microsoft製品かどうかは別として。
isTrial	boolean	裁判かどうかは別として。
lineItems	SubscriptionLineItemDetail[]	このサブスクリプションに関連する項目のコレクション。
links	SubscriptionLinks	関連リソースへのリンク。
migratedFromSubscriptionId	string	サブスクリプションから移行したユニーク識別子が使われました。価値は通常GUIDです。
migratedToSubscriptionId	string	この購読が移行したサブスクリプションの識別子。
nextChargeInstructions	NextChargeInstructions	請求サイクルの変更が保留中の次の学期の開始時に適用される請求指示。
offerId	string	オファーID。新規コマース購読の場合、通常はプロダクト:SKU:可用性複合カタログ項目識別子です。
offerName	string	サブスクリプションのオファー名です。
orderId	string	サブスクリプションを作成したオーダーの識別子。
parentSubscriptionId	string	親契約の一意識別子。価値は通常GUIDです。
partnerId	string	間接パートナーモデルにおけるリセラー・オブ・レコードのPartnerID。
priceBenefits	PriceBenefit[]	このサブスクリプションには現在の期間の価格特典が適用されます。価格のメリットはサービスによって自動的に適用され読み取り専用であるため、リクエストで提供された値は上書きされます。価格のメリットが適用されない場合、この物件は除外され、今日返却されるのはせいぜい1件だけです。
productOrderId	string	予約やAzure貯蓄プランの注文など、商品購入注文の識別子です。
productType	ItemType	サブスクリプションに関連する追加の商品タイプ。
promotionId	string	プロモーション識別子はサブスクリプションに適用され、通常はproduct:SKU:可用性の複合識別子です。
publisherName	string	サブスクリプションの出版社名。
quantity	integer (int32)	単位の数。
refundOptions	RefundOption[]	このサブスクリプションに関連する返金オプションのコレクション。
refundableQuantity	RefundableQuantity	サブスクリプションに関連する追加の返金可能な金額があります。
renewalTermDuration	string	サブスクリプションの更新期間。
scheduledActions	ScheduledAction[]	このサブスクリプションに関連する予定されたアクションの収集。
scheduledNextTermInstructions	SubscriptionScheduledNextTermInstructions	サブスクリプションに関連する追加の次学期の指示が予定されています。
status	enum: active deleted disabled expired none pending suspended	現在のサブスクリプション状況。可能な値は「なし」「アクティブ」「保留中」「一時停止」「期限切れ」「無効化」「削除済み」などがあります。
suspensionReasons	string[]	このサブスクリプションに関連する停止理由の収集。
termDuration	string	サブスクリプション期間の長さ(例:月額はP1M、年次はP1Y)。
termLifeCycleState	string	サブスクリプションのライフサイクル状態。
unitType	string	サブスクリプションのユニットタイプ。

SubscriptionCollection

Object

資源収集リソースを表します。

名前	型	説明
attributes	ResourceAttributes	リソースコレクションに関連する追加の属性。
items	Subscription[]	このリソースコレクションに関連するアイテムのコレクションです。
links	ResourceLinks	関連リソースへのリンク。
totalCount	integer (int32)	結果セットで利用可能な項目の総数。

SubscriptionLineItemDetail

Object

サブスクリプションの項目詳細リソースを表します。

名前	型	説明
autoRenewEnabled	boolean	このサブスクリプション項目の詳細が自動更新が有効になっているかどうか。
friendlyName	string	このアイテムの親しみやすい表示名です。
id	string	購読項目の詳細に対する一意識別子。価値は通常GUIDです。
purchaseCommitment	PurchaseCommitment	この商品に関連する購入契約。
quantity	integer (int32)	単位の数。
scope	Scope	購読項目の詳細に関連する追加範囲。
status	enum: active deleted disabled expired none pending suspended	現在のサブスクリプション状況。可能な値は「なし」「アクティブ」「保留中」「一時停止」「期限切れ」「無効化」「削除済み」などがあります。

SubscriptionLinks

Object

サブスクリプションリンクリソースを表しています。

名前	型	説明
activationLinks	Link	サブスクリプションリンクに関連する追加のアクティベーションリンク。
availability	Link	サブスクリプションリンクに関連する追加の利用可能性。
entitlement	Link	購読リンクに関連する追加の権利があります。
next	Link	さらに、サブスクリプションリンクに関連する追加情報です。
offer	Link	サブスクリプションリンクに関連する追加オファー。
parentSubscription	Link	サブスクリプションリンクに関連する追加の親サブスクリプション。
pendingChanges	Link	購読リンクに関連する追加の保留中の変更点。
previous	Link	サブスクリプションリンクに関連する追加の過去情報。
product	Link	サブスクリプションリンクに関連する追加商品。
self	Link	購読リンクに関連する追加の情報です。
sku	Link	サブスクリプションリンクには追加のSKUが付与されます。

SubscriptionProductTerm

Object

商品語リソースを表します。

名前	型	説明
availabilityId	string	製品内の可用性識別子とSKU内の識別子です。
billingCycle	enum: annual biennial monthly none one_time quadrennial quinquennial triennial unknown	請求頻度。支持される価値は不明、月ごと、年次、なし、one_time、三年ごとのもの、隔年ごとのもの、四年ごとのもの、そして五年ごとのものがあります。
productId	string	次の用語の製品識別子です。
promotionId	string	次の用語で適用されるプロモーション識別子は、通常はproduct:SKU:可用性複合識別子です。
skuId	string	商品内のSKU識別子。
termDuration	string	サブスクリプション期間の長さ(例:月額はP1M、年次はP1Y)。

SubscriptionScheduledNextTermInstructions

Object

次の学期の指示リソースをスケジュールされています。

名前	型	説明
customTermEndDate	string (date-time)	この期間のカスタム終了日はISO 8601形式で示されています。 ISO 8601の日付時間形式を使用しています。
priceBenefits	PriceBenefit[]	予定変更時に適用される価格優遇措置。価格のメリットはサービスによって自動的に適用され読み取り専用であるため、リクエストで提供された値は上書きされます。価格のメリットが適用されない場合、この物件は除外され、今日返却されるのはせいぜい1件だけです。
product	SubscriptionProductTerm	予定された次の学期の指示に関連する追加の製品。
quantity	integer (int32)	単位の数。