REST Resource: subscriptions

リソースのサブスクリプション

サブスクリプションの JSON テンプレート。

JSON 表現 
{
  "customerId": string,
  "subscriptionId": string,
  "skuId": string,
  "creationTime": string,
  "kind": string,
  "seats": {
    object (Seats)
  },
  "renewalSettings": {
    object (RenewalSettings)
  },
  "purchaseOrderId": string,
  "status": string,
  "resourceUiUrl": string,
  "billingMethod": string,
  "suspensionReasons": [
    string
  ],
  "customerDomain": string,
  "dealCode": string,
  "skuName": string,
  "plan": {
    "planName": string,
    "isCommitmentPlan": boolean,
    "commitmentInterval": {
      "startTime": string,
      "endTime": string
    }
  },
  "trialSettings": {
    "isInTrial": boolean,
    "trialEndTime": string
  },
  "transferInfo": {
    "transferabilityExpirationTime": string,
    "minimumTransferableSeats": integer,
    "currentLegacySkuId": string
  }
}
フィールド
customerId

string

このプロパティは常に Google が生成した一意の識別子としてレスポンスで返されます。リクエストでは、このプロパティはプライマリ ドメインか、Google が生成した一意の ID のいずれかになります。
subscriptionId

string

subscriptionId は、サブスクリプション ID で、顧客ごとに固有です。このプロパティは必須です。定期購入が更新されると subscriptionId が変更されるため、この ID を永続データのキーとして使用しないことをおすすめします。すべての販売パートナー サブスクリプションを取得するに記載されているとおり、subscriptionIdを使用してください。
skuId

string

必須プロパティ。skuId は、定期購入で顧客に割り当てられたサービスの SKU 用の一意の識別子です。このバージョンの API で利用できるプロダクトと SKU については、プロダクト ID と SKU ID をご覧ください。
creationTime

string (int64 format)

creationTime プロパティは、サブスクリプションが作成された日付です。ミリ秒単位のエポック形式です。エポック コンバータの例をご覧ください。
kind

string

リソースをサブスクリプションとして識別します。値: reseller#subscription
seats

object (Seats)

このプロパティは必須です。プラン内のユーザー シート数と上限数。
renewalSettings

object (RenewalSettings)

年間コミットメント プランの更新設定。詳しくは、管理者向けヘルプセンターの更新オプションをご参照ください。
purchaseOrderId

string

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

string

このプロパティは省略可能です。
resourceUiUrl

string

管理コンソールの [サブスクリプション] ページの URL。読み取り専用 URL が API サービスによって生成されます。管理コンソールで [サブスクリプション] ページを使用してタスクを完了する必要があるクライアント クライアントに使用します。
billingMethod

string

定期購入の現在の請求方法を返す読み取り専用フィールド。
suspensionReasons[]

string

定期購入の現在の停止理由をすべて列挙した読み取り専用フィールド。定期購入が同時に複数の停止理由になる場合もあります。サブスクリプションのSTATUSは、保留中の停止がすべて解除されるまでSUSPENDEDになります。

たとえば、

  • PENDING_TOS_ACCEPTANCE - お客様はログインせずに、G Suite 再販利用規約に同意していない。
  • RENEWAL_WITH_TYPE_CANCEL - 顧客の契約期間が終了し、サービス期間が解約された。
  • RESELLER_INITIATED - 販売パートナーが手動で停止した。
  • TRIAL_ENDED - プランを選択していない、お客様の試用期間が終了した。
  • OTHER - Google の内部的な理由（不正行為など）によりお客様が停止されている。
customerDomain

string

顧客のプライマリ ドメイン名
dealCode

string

定期購入プランの割引コードを提供する、Google が発行したコード（最大 100 文字）。割引料金を受けるには、insert リクエストにディールコードを含める必要があります。このプロパティは省略可能です。空白のままにした場合は通常料金が適用されます。
skuName

string

サブスクリプション内の顧客に割り当てられたプロダクトの SKU の読み取り専用外部表示名。SKU 名は Google の裁量により変更される場合があります。このバージョンの API で利用できるプロダクトと SKU については、プロダクト ID と SKU ID をご覧ください。
plan

object

plan プロパティは必須です。このバージョンの API では、G Suite プランはフレキシブル プラン、年間コミットメント プラン、30 日間の無料試用プランです。API のお支払いプランについて詳しくは、API のコンセプトをご覧ください。
plan.planName

string

planName プロパティは必須です。これは、定期購入のプランの名前です。Google お支払いプランの詳細については、API のコンセプトをご覧ください。

有効な値:

  • ANNUAL_MONTHLY_PAY - 月払いの年間コミットメント プラン。
  • ANNUAL_YEARLY_PAY - 年払いプランでの年間コミットメント プラン
  • FLEXIBLE - フレキシブル プラン
  • TRIAL - 30 日間の無料試用プラン。お支払いプランが提供されていない場合、試用期間中のサブスクリプションは 30 日後に無料停止されます。changePlan 宛に通話を発信すると、試用にお支払いプランが割り当てられますが、プランは有効になりません。30 日経過した後、または startPaidService に電話をかけた直後に、割り当てられたお支払いプランが自動的に開始されます。
  • FREE - 無料プランは Cloud Identity SKU 専用であり、課金は発生しません。
plan.isCommitmentPlan

boolean

isCommitmentPlan プロパティのブール値は、プランを年間コミットメント プランとして識別します。

  • true - サブスクリプションのプランは年間コミットメント プランです。
  • false - 年払いプランではありません。
plan.commitmentInterval

object

このバージョンの API では、年間コミットメント プランの間隔は 1 年間です。
plan.commitmentInterval.startTime

string (int64 format)

UNIX エポック形式を使用した年間コミットメント プランの間隔（ミリ秒単位）。startTimeエポック コンバータの例をご覧ください。
plan.commitmentInterval.endTime

string (int64 format)

UNIX エポック形式を使用した年間コミットメント プランの間隔（ミリ秒単位）。endTimeエポック コンバータの例をご覧ください。
trialSettings

object

G Suite の年間コミットメントとフレキシブルなお支払いプランは、30 日間の無料試用をご利用いただけます。詳細については、API のコンセプトをご覧ください。
trialSettings.isInTrial

boolean

定期購入のプランが 30 日間の無料試用の対象かどうかを判断します。

  • true - プランは試用期間中です。
  • false - プランがトライアル中ではない。
trialSettings.trialEndTime

string (int64 format)

試用期間の終了日。値は、UNIX エポック形式を使用したミリ秒単位です。エポック コンバータの例をご覧ください。
transferInfo

object

サブスクリプションの読み取り専用転送関連情報。詳しくは、移行可能なお客様のサブスクリプションを取得するをご確認ください。
transferInfo.transferabilityExpirationTime

string (int64 format)

移行トークンまたは移行インテントの有効期限。この時間は、UNIX エポック形式によるミリ秒単位です。
transferInfo.minimumTransferableSeats

integer

サブスクリプションを挿入する際は、このプロダクトの移行の注文に記載された最小限のシート数となります。たとえば、お客様のユーザー数が 20 人の場合、販売パートナー様は 15 シートの移行注文を行うことはできません。最小シート数は 20 です。
transferInfo.currentLegacySkuId

string

現在の再販サブスクリプションの skuId。以前の SKU の定期購入を利用しており、移行に推奨される SKU の skuId が入力されている場合にのみ、データが入力されます。

座席数

サブスクリプション シートの JSON テンプレート。

JSON 表現 
{
  "numberOfSeats": integer,
  "maximumNumberOfSeats": integer,
  "licensedNumberOfSeats": integer,
  "kind": string
}
フィールド
numberOfSeats

integer

これは必須プロパティであり、ANNUAL_MONTHLY_PAY および ANNUAL_YEARLY_PAY プランのサブスクリプション専用です。このプロパティでは、サブスクリプションでユーザーに割り当てることができるライセンス数の上限を設定します。販売パートナーがライセンスを追加することは可能ですが、いったん設定すると、更新するまで numberOfSeats を減らすことはできません。割り当て済みのユーザー ライセンスの数に関係なく、numberOfSeats の値に基づいて販売パートナーに請求が行われます。
maximumNumberOfSeats

integer

このプロパティは必須で、FLEXIBLE または TRIAL プランのサブスクリプション専用です。このプロパティでは、サブスクリプションで許可されるライセンス ユーザーの最大数を設定します。この数量は、販売パートナーの契約で定義されている上限まで引き上げることができます。最小数量は、顧客アカウントの現在のユーザー数です。
licensedNumberOfSeats

integer

skuId で定義されたサービスのライセンスが割り当てられている現在のユーザー数を含む読み取り専用フィールド。このフィールドの値は、Enterprise License Manager API メソッドから返されるユーザー数（listForProductAndSku）と同じです。
kind

string

サブスクリプション シートの設定としてリソースを識別します。値: subscriptions#seats

RenewalSettings

定期購入の更新設定用の JSON テンプレート。

JSON 表現 
{
  "renewalType": string,
  "kind": string
}
フィールド
renewalType

string

年間コミットメント プランの更新設定。詳しくは、管理者向けヘルプセンターの更新オプションをご参照ください。定期購入を更新する場合、renewalType は必須プロパティです。
kind

string

サブスクリプション更新の設定としてリソースを識別します。値: subscriptions#renewalSettings

Methods

activate

 販売パートナーによって以前に停止されたサブスクリプションを有効にします。

changePlan

 サブスクリプション プランを更新します。

changeRenewalSettings

 ユーザー ライセンスの更新設定を更新します。

changeSeats

 定期購入のユーザー ライセンス設定を更新します。

delete

 定期購入の解約、停止、移行（直接）

get

 特定のサブスクリプションを取得します。

insert

 定期購入を作成または移行します。

list

 販売パートナーが管理するサブスクリプションのリスト。

startPaidService

 30 日間の無料試用のサブスクリプションを直ちに有料の定期購入に移行します。

suspend

 アクティブなサブスクリプションを停止します。