顧客サブスクリプションの支払いサイクルを変更する

[アーティクル]
06/13/2024

適用対象: パートナーセンター | 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
PATCH	{baseURL}/v1/customers/{customer-tenant-id}/orders/{order-id} HTTP/1.1

URI パラメーター

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

名前	タイプ	必須	説明
customer-tenant-id	GUID	年	顧客を識別する GUID 形式の customer-tenant-id
order-id	GUID	年	注文識別子

要求ヘッダー

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

要求本文

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

注文

プロパティ	タイプ	必須	内容
ID	string	N	注文の正常な作成時に指定される注文識別子
ReferenceCustomerId	string	年	顧客 ID
BillingCycle	string	年	この注文に対してパートナーに請求される頻度を示します。サポートされる値は、BillingCycleType で検出されたメンバー名です。
LineItems	オブジェクトの配列	年	OrderLineItem リソースの配列
CreationDate	datetime	N	注文が作成された日付 (日時形式)
属性	Object	N	"ObjectType": "OrderLineItem" が含まれています

OrderLineItem

プロパティ	タイプ	必須	説明
LineItemNumber	数値	年	0 から始まる行項目番号
OfferId	string	年	オファーの ID
SubscriptionId	string	年	サブスクリプションの ID
FriendlyName	string	N	あいまいさを解消するためにパートナーによって定義されたサブスクリプションのフレンドリ名
数量（Quantity）	数値	年	ライセンスまたはインスタンスの数
PartnerIdOnRecord	string	N	レコードのパートナーの PartnerID
属性	Object	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"
    }
}

次の方法で共有