Method: subscriptions.changePlan

サブスクリプション プランを更新します。この方法は、30 日間の試用プランやフレキシブル プランのサブスクリプションを、月単位または年払いの年間契約プランに更新するために使用します。

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
customerId

string

顧客のプライマリ ドメイン名または顧客の一意の識別子のいずれかです。顧客のドメイン名が変更された場合、古いドメイン名を使用して顧客にアクセスすることはできませんが、API によって返される顧客の一意の識別子は常に使用できます。可能な場合は、一意の識別子をシステムに保存することをおすすめします。
subscriptionId

string

これは必須プロパティです。subscriptionId は定期購入 ID で、顧客ごとに一意です。subscriptionId はサブスクリプションが更新されると変更されるため、この ID を永続データのキーとして使用しないことをおすすめします。subscriptionId は、retrieve all reseller subscription メソッドを使用して確認できます。

リクエスト本文

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

レスポンスの本文

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

認可スコープ

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

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

詳細については、承認ガイドをご覧ください。

ChangePlanRequest

subscription.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)

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

string

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

string

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