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 は定期購入の識別子で、お客様ごとに一意です。これは必須のプロパティです。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)

年間契約プランの期間の startTime（UNIX エポック形式のミリ秒単位）。エポック変換ツールの例をご覧ください。
plan.commitmentInterval.endTime

string (int64 format)

年間契約プランの期間の endTime（UNIX エポック形式のミリ秒単位）。エポック変換ツールの例をご覧ください。
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

メソッド

activate

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

changePlan

 定期購入プランを更新します。

changeRenewalSettings

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

changeSeats

 サブスクリプションのユーザー ライセンス設定を更新します。

delete

 定期購入の解約、一時停止、ダイレクトへの移行を行います。

get

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

insert

 サブスクリプションを作成または転送します。

list

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

startPaidService

 30 日間の無料試用サブスクリプションをすぐに有料サービス サブスクリプションに移行します。

suspend

 有効な定期購入を停止します。