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 によって生成された一意の識別子のいずれかになります。
subscriptionId

string

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

string

必須プロパティ。skuId は、定期購入で顧客に割り当てられた商品の SKU の一意のシステム ID です。このバージョンの API で利用可能なサービスと SKU については、 サービスと 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 については、 サービスと 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 プランのサブスクリプション専用です。このプロパティは、1 つのサブスクリプションでユーザーに割り当て可能なライセンスの最大数を設定します。販売パートナーはライセンスを追加できますが、一度設定すると、更新するまで numberOfSeats を減らすことはできません。販売パートナーには、割り当てられているユーザー ライセンスの数に関係なく、numberOfSeats の値に基づいて請求が行われます。
maximumNumberOfSeats

integer

これは必須プロパティであり、FLEXIBLE プランまたは TRIAL プランのサブスクリプション専用です。このプロパティは、1 つのサブスクリプションでライセンスを付与できる最大ユーザー数を設定します。この数量は、販売パートナーの契約で定義されている上限まで増やすことができます。最小ユーザー数は、お客様のアカウントの現在のユーザー数です。
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

 有効なサブスクリプションを一時停止します。