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 は、すべての販売パートナー サブスクリプションを取得する方法で確認できます。

リクエスト本文

リクエストの本文には 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 リクエストにディールコードを含める必要があります。このプロパティは省略可能です。ディールコードがすでにサブスクリプションに追加されている場合は、このプロパティを空のままにして、既存の割引料金をそのまま適用することができます(空でない場合は、サブスクリプションにすでに存在するディールコードのみを指定してください)。ディールコードがサブスクリプションに追加されておらず、このプロパティを空白のままにした場合は、通常料金が適用されます。