顧客サブスクリプションの請求サイクルを変更する

2025-05-11

適用対象: パートナーセンター |21Vianet が運営するパートナーセンター |Microsoft Cloud for US Government のパートナーセンター

ヒント

この API を使用すると、従来のサブスクリプションの請求頻度のみを変更できます。

New Commerce Experience (NCE) サブスクリプションと従来のサブスクリプションの請求頻度を変更するには、 ID でサブスクリプションを更新する - パートナーアプリ開発者 |Microsoft Learn API。

オーダーを月次請求から年次請求へ、または年次請求から月次請求に更新します。

パートナーセンターでは、この操作は、顧客のサブスクリプションの詳細ページに移動して実行できます。そこには、サブスクリプションの現在の請求サイクルを定義するオプションが表示され、サブスクリプションを変更して送信することができます。

この記事の範囲外:

試用版の請求サイクルの変更
年単位以外の期間オファー (月単位、6 年) と Azure サブスクリプションの請求サイクルの変更
非アクティブなサブスクリプションの請求サイクルの変更
Microsoft オンラインサービスのライセンスベースのサブスクリプションの請求サイクルの変更

[前提条件]

パートナーセンター認証で説明されている資格証明。このシナリオでは、スタンドアロンアプリとアプリ + ユーザーの両方の資格情報を使った認証がサポートされています。
顧客 ID です (customer-tenant-id)。顧客の ID がわからない場合は、パートナーセンターで [顧客] ワークスペースを選び、顧客一覧から顧客を選び、[アカウント] を選んで調べることができます。顧客の [アカウント] ページで、[顧客アカウント情報] セクションで Microsoft ID を探します。 Microsoft ID は、顧客 ID (customer-tenant-id) と同じです。
注文 ID。

C#

請求サイクルの頻度を変更するには、 Order.BillingCycle プロパティを更新します。

// IAggregatePartner partnerOperations;
// string customerId;
// string offerId;
// string orderId;

var order = new Order()
{
    ReferenceCustomerId = customerId,
    BillingCycle = BillingCycleType.Annual,
    LineItems = new List<OrderLineItem>()
    {
        new OrderLineItem()
        {
            LineItemNumber = 0,
            OfferId = offerId,
            SubscriptionId = "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
            Quantity = 1
        }
    }
};

var createdOrder = partnerOperations.Customers.ById(customerId).Orders.ById(orderId).Patch(order);

REST 要求

リクエスト構文

メソッド	URI リクエスト
パッチ	{baseURL}/v1/customers/{customer-tenant-id}/orders/{order-id} HTTP/1.1

URI パラメーター

次の表に、サブスクリプションの数量を変更するために必要なクエリパラメーターを示します。

名前	タイプ	必須	説明
顧客テナントID	GUID（グローバルユニーク識別子）	Y	顧客を識別する GUID 形式の customer-tenant-id
注文番号	GUID（グローバルユニーク識別子）	Y	注文識別子

要求ヘッダー

詳細については、「パートナーセンター REST ヘッダー」を参照してください。

リクエストの本文

次の表では、要求本文のプロパティについて説明します。

注文

プロパティ	タイプ	必須	説明
ID (アイディー)	ひも	N	注文が正常に作成されたときに提供される注文識別子
ReferenceCustomerId (リファレンスカスタマー ID)	ひも	Y	顧客識別子
ビリングサイクル	ひも	Y	この注文に対してパートナーに請求される頻度を示します。サポートされている値は、 BillingCycleType にあるメンバー名です。
ラインアイテム	オブジェクトの配列	Y	OrderLineItem リソースの配列
作成日	datetime	N	注文が作成された日付 (日付/時刻形式)
属性	オブジェクト	N	"ObjectType": "OrderLineItem"が含まれます

注文ラインアイテム

プロパティ	タイプ	必須	説明
行項目番号	数	Y	0 から始まる品目番号
オファーID	ひも	Y	オファーの ID
購読ID	ひも	Y	サブスクリプションの ID
フレンドリーネーム	ひも	N	あいまいさを解消するためにパートナーによって定義されたサブスクリプションのフレンドリ名
数量	数	Y	ライセンスまたはインスタンスの数
PartnerIdOnレコード	ひも	N	レコードのパートナーの PartnerID
属性	オブジェクト	N	"ObjectType": "OrderLineItem"が含まれます

要求の例

年次請求の更新

PATCH https://api.partnercenter.microsoft.com/v1/customers/4d3cf487-70f4-4e1e-9ff1-b2bfce8d9f04/orders/CF3B0E37-BE0B-4CDD-B584-D1A97D98A922 HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: 17a2658e-d2cc-439b-a2f0-2aefd9344fbc
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
X-Locale: en-US
Content-Type: application/json
Host: api.partnercenter.microsoft.com
Content-Length: 414
Expect: 100-continue

{
    "Id": null,
    "ReferenceCustomerId": "4d3cf487-70f4-4e1e-9ff1-b2bfce8d9f04",
    "BillingCycle" : "Annual",
    "LineItems": [{
            "LineItemNumber": 0,
            "OfferId": "2828BE95-46BA-4F91-B2FD-0BEF192ECF60",
            "SubscriptionId": "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
            "FriendlyName": "Some friendly name",
            "Quantity": 2,
            "PartnerIdOnRecord": null,
            "Attributes": {
                "ObjectType": "OrderLineItem"
            }
        }
    ],
    "CreationDate": null,
    "Attributes": {
        "ObjectType": "Order"
    }
}

REST 応答

成功した場合、このメソッドは更新されたサブスクリプションの順序を応答本文で返します。

応答の成功とエラーコード

各応答には、成功または失敗を示す HTTP ステータスコードと、追加のデバッグ情報が付属しています。このコード、エラーの種類、追加のパラメーターを読み取るには、ネットワークトレースツールを使用します。完全な一覧については、エラーコードに関するページを参照してください。

応答の例

HTTP/1.1 200 OK
Content-Length: 1135
Content-Type: application/json; charset=utf-8
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: 17a2658e-d2cc-439b-a2f0-2aefd9344fbc
MS-CV: WtFy3zI8V0u2lnT9.0
MS-ServerId: 020021921
Date: Wed, 25 Jan 2017 23:01:08 GMT

{
    "id": "cf3b0e37-be0b-4cdd-b584-d1a97d98a922",
    "referenceCustomerId": "4d3cf487-70f4-4e1e-9ff1-b2bfce8d9f04",
    "billingCycle": "Annual",
    "lineItems": [{
            "lineItemNumber": 0,
            "offerId": "195416C1-3447-423A-B37B-EE59A99A19C4",
            "subscriptionId": "bbbb1b1b-cc2c-dd3d-ee4e-ffffff5f5f5f",
            "friendlyName": "new offer purchase",
            "quantity": 5,
            "links": {
                "subscription": {
                    "uri": "/customers/4d3cf487-70f4-4e1e-9ff1-b2bfce8d9f04/subscriptions/bbbb1b1b-cc2c-dd3d-ee4e-ffffff5f5f5f",
                    "method": "GET",
                    "headers": []
                }
            }
        },
        {
            "lineItemNumber": 1,
            "offerId": "2828BE95-46BA-4F91-B2FD-0BEF192ECF60",
            "subscriptionId": "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
            "friendlyName": "Some friendly name",
            "quantity": 2,
            "links": {
                "subscription": {
                    "uri": "/customers/4d3cf487-70f4-4e1e-9ff1-b2bfce8d9f04/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
                    "method": "GET",
                    "headers": []
                }
            }
        }
    ],
    "creationDate": "2017-01-25T14:53:12.093-08:00",
    "links": {
        "self": {
            "uri": "/customers/4d3cf487-70f4-4e1e-9ff1-b2bfce8d9f04/orders/cf3b0e37-be0b-4cdd-b584-d1a97d98a922",
            "method": "GET",
            "headers": []
        }
    },
    "attributes": {
        "etag": "eyJpZCI6ImNmM2IwZTM3LWJlMGItNGNkZC1iNTg0LWQxYTk3ZDk4YTkyMiIsInZlcnNpb24iOjJ9",
        "objectType": "Order"
    }
}