Method: subscriptions.changePlan

定期購入プランを更新します。この方法は、30 日間の試用プランまたはフレキシブル プランのサブスクリプションを、月払いまたは年払いの年間コミットメント プランに更新する場合に使用します。

プランの更新方法は、プランと商品によって異なります。詳しくは、サブスクリプションを管理するをご覧ください。

HTTP リクエスト

POST https://reseller.googleapis.com/apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/changePlan

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
customerId

string

顧客のメインのドメイン名または顧客の一意の ID を指定できます。お客様のドメイン名が変更された場合、古いドメイン名を使用してお客様にアクセスすることはできませんが、（API から返された）お客様の一意の識別子は常に使用できます。必要に応じて、一意の識別子をシステムに保存することをおすすめします。
subscriptionId

string

これは必須のプロパティです。subscriptionId は定期購入の識別子で、お客様ごとに一意です。subscriptionId は定期購入の更新時に変更されるため、この ID を永続データのキーとして使用しないことをおすすめします。subscriptionId は、すべての販売店の定期購入を取得するメソッドを使用して確認できます。

リクエストの本文

リクエストの本文には ChangePlanRequest のインスタンスが含まれます。

レスポンスの本文

成功した場合、レスポンスの本文には Subscription のインスタンスが含まれます。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/apps.order

詳しくは、認可ガイドをご覧ください。

ChangePlanRequest

subscriptions.changePlan rpc リクエストの JSON テンプレート。

JSON 表現 
{
  "kind": string,
  "planName": string,
  "seats": {
    object (Seats)
  },
  "purchaseOrderId": string,
  "dealCode": string
}
フィールド
kind

string

サブスクリプションのプラン変更リクエストとしてリソースを識別します。値: subscriptions#changePlanRequest
planName

string

planName プロパティは必須です。サブスクリプションのお支払いプランの名前です。Google のお支払いプランの詳細については、API のコンセプトをご覧ください。

使用できる値は次のとおりです。

  • ANNUAL_MONTHLY_PAY - 月払いの年間契約プラン
  • ANNUAL_YEARLY_PAY - 年払いの年間契約プラン
  • FLEXIBLE - フレキシブル プラン
  • TRIAL - 30 日間の無料トライアルプラン
seats

object (Seats)

これは必須のプロパティです。seats プロパティは、ユーザー シート ライセンス数です。
purchaseOrderId

string

このプロパティは省略可能です。この注文書（PO）情報は、販売店が自社の使用状況を追跡するために使用します。purchaseOrderId 値が指定されている場合、API レスポンスと請求書に表示されます。このプロパティには、最大 80 文字の書式なしテキストを使用できます。
dealCode

string

定期購入プランの割引価格を適用するための Google 発行コード（最大 100 文字）。割引料金を適用するには、changePlan リクエストにディールコードを含める必要があります。このプロパティは省略可能です。定期購入にすでにディールコードが追加されている場合は、このプロパティを空のままにして、既存の割引料金を適用できます（空でない場合、定期購入にすでに存在するディールコードのみを指定してください）。定期購入にディールコードが追加されたことがなく、このプロパティが空白になっている場合は、通常の料金が適用されます。