サブスクリプションを作成または移行する

お客様のアカウントを注文したら、次のようなさまざまなサブスクリプションを作成できます。

  • 年間契約のサブスクリプション
  • フレキシブルな定期購入
  • 30 日間の無料トライアル
  • 割引のある定期購入

これらのサブスクリプションで使用されるプロダクトの詳細については、プロダクトと SKU をご覧ください。

このお客様のアカウントを注文していない場合は、定期購入を移行できます。

customerType = 'team' のお客様は、Google Workspace の Essentials エディションと Enterprise Essentials エディションのみを購入できます。他の Google Workspace サブスクリプションを購入しようとすると、エラー Customer is not eligible to purchase this subscription が発生します。Essentials または従量制サブスクリプションを購入しているお客様は、年間契約プランを処理できない場合があります。また、アップグレードとダウングレードのオプションが制限される場合があります。

サブスクリプションを作成する

新しく作成されたお客様のアカウントのサブスクリプションを作成するには、次の POST HTTP リクエストを使用し、認証トークンを含めます。

POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions

CUSTOMER_ID は、お客様のプライマリ ドメイン名、または再販されたお客様のアカウントを取得したときに返されたお客様の一意の識別子のいずれかです。

年間コミットメント プランを作成する

年間コミットメント プランのサブスクリプションでは、すべての SKU に同じデフォルトの更新設定が適用されるわけではありません。常に renewalSettings を渡すことをおすすめします。10 席の年間コミットメント サブスクリプションを作成します。

POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions
{
  "kind": "reseller#subscription",
  "customerId": "CUSTOMER_ID",
  "skuId": "SKU_ID",
  "plan": {
    "planName": "ANNUAL_MONTHLY_PAY"
  },
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 10
  },
  renewalSettings: {
    "renewalType": 'RENEW_CURRENT_USERS_MONTHLY_PAY'
  },
  "purchaseOrderId": "PURCHASE_ORDER_ID"
}

次のように置き換えます。

  • CUSTOMER_ID: お客様のメインのドメイン名またはお客様の一意の識別子。
  • SKU_ID: 一意の最小管理単位（SKU）識別子。詳細については、プロダクトと SKU ID をご覧ください。
  • PURCHASE_ORDER_ID: 使用状況の追跡に使用できる注文書 ID（省略可）。

成功すると、HTTP 200 ステータスと、年間コミットメント プランの新しい定期購入の設定が返されます。ANNUAL_MONTHLY_PAY は、すべての API レスポンスで ANNUAL として返されます。

年間プランのレスポンスの例を次に示します。

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "billingMethod": "ONLINE",
  "skuId": "1010020028",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "ANNUAL",
    "isCommitmentPlan": true,
    "commitmentInterval": {
      "startTime": "1331647980142",
      "endTime": "1363183980142"
    }
  },
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 10,
    "licensedNumberOfSeats": 10
  },
  "trialSettings": {
    "isInTrial": false
  },
  "renewalSettings": {
    "kind": "subscriptions#renewalSettings",
    "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
  },
  "purchaseOrderId": "my_example.com_annual_1",
  "status": "ACTIVE",
  "customerDomain": "my_example.com",
  "skuName": "Google Workspace Business Standard"
}

フレキシブルなプランを作成する

新しく作成された顧客のアカウントにフレキシブル サブスクリプションを作成するには、次の POST HTTP リクエストを使用し、認証トークンを含めます。

POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions
{
  "kind": "reseller#subscription",
  "customerId": "CUSTOMER_ID",
  "skuId": "SKU_ID",
  "plan": {
    "planName": "FLEXIBLE"
  },
  "seats": {
    "kind": "subscriptions#seats",
    "maximumNumberOfSeats": 10
  },
  "purchaseOrderId": "PURCHASE_ORDER_ID"
}

次のように置き換えます。

  • CUSTOMER_ID: お客様のメインのドメイン名またはお客様の一意の識別子。
  • SKU_ID: 一意の最小管理単位（SKU）識別子。詳細については、プロダクトと SKU ID をご覧ください。
  • PURCHASE_ORDER_ID: 使用状況の追跡に使用できる注文書 ID（省略可）。

フレキシブル プラン レスポンスの例を次に示します。

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "billingMethod": "ONLINE",
  "skuId": "1010020028",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "FLEXIBLE",
    "isCommitmentPlan": false
  },
  "seats": {
    "kind": "subscriptions#seats",
    "maximumNumberOfSeats": 10,
    "licensedNumberOfSeats": 0
  },
  "trialSettings": {
    "isInTrial": false
  },
  "purchaseOrderId": "my_example_flex_1",
  "status": "ACTIVE",
  "customerDomain": "my_example.com",
  "skuName": "Google Workspace Business Standard"
}

無料トライアルを作成する

新しく作成された顧客のアカウントに 30 日間の無料試用サブスクリプションを作成するには、次の POST HTTP リクエストを使用し、認証トークンを含めます。

POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions
{
  "kind": "reseller#subscription",
  "customerId": "CUSTOMER_ID",
  "skuId": "SKU_ID",
  "plan": {
    "planName": "TRIAL"
  },
  "seats": {
    "kind": "subscriptions#seats",
    "maximumNumberOfSeats": 10
  },
  "purchaseOrderId": "PURCHASE_ORDER_ID"
}

次のように置き換えます。

  • CUSTOMER_ID: お客様のメインのドメイン名またはお客様の一意の識別子。
  • SKU_ID: 一意の最小管理単位（SKU）識別子。詳細については、プロダクトと SKU ID をご覧ください。
  • PURCHASE_ORDER_ID: 使用状況の追跡に使用できる注文書 ID（省略可）。

30 日間の無料試用プランのレスポンスの例を次に示します。

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "billingMethod": "ONLINE",
  "skuId": "1010020028",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "TRIAL",
    "isCommitmentPlan": false
  },
  "seats": {
    "kind": "subscriptions#seats",
    "maximumNumberOfSeats": 10,
    "licensedNumberOfSeats": 0
  },
  "trialSettings": {
    "isInTrial": true,
    "trialEndTime": "1331648420142"
  },
  "purchaseOrderId": "my_example_trial_1",
  "status": "ACTIVE",
  "customerDomain": "my_example.com",
  "skuName": "Google Workspace Business Standard"
}

割引定期購入を作成する

Google から、割引料金で定期購入を作成するための特価コードが提供される場合があります。定期購入に割引を適用するには、定期購入の insert 呼び出しでディールコードを指定する必要があります。お客様が元の SKU から変更した場合、割引は削除されます。

新しく作成された顧客のアカウントに割引の年間コミットメント サブスクリプションを作成するには、次の POST HTTP リクエストを使用し、認証トークンを含めます。

POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions
{
  "kind": "reseller#subscription",
  "customerId": "CUSTOMER_ID",
  "skuId": "SKU_ID",
  "plan": {
    "planName": "ANNUAL_MONTHLY_PAY"
  },
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 10
  },
  renewalSettings: {
    "renewalType": 'RENEW_CURRENT_USERS_MONTHLY_PAY'
  },
  "purchaseOrderId": "PURCHASE_ORDER_ID",
  "dealCode": "GOOGLE_CONTRACT_DEAL_CODE"
}

次のように置き換えます。

  • CUSTOMER_ID: お客様のメインのドメイン名またはお客様の一意の識別子。
  • SKU_ID: 一意の最小管理単位（SKU）識別子。詳細については、プロダクトと SKU ID をご覧ください。
  • PURCHASE_ORDER_ID: 使用状況の追跡に使用できる注文書 ID（省略可）。
  • GOOGLE_CONTRACT_DEAL_CODE: Google から入手できる割引コード。

割引の年間プラン レスポンスの例を次に示します。

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "billingMethod": "ONLINE",
  "skuId": "1010020028",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "ANNUAL",
    "isCommitmentPlan": true,
    "commitmentInterval": {
      "startTime": "1331647980142",
      "endTime": "1363183980142"
    }
  },
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 10,
    "licensedNumberOfSeats": 10
  },
  "trialSettings": {
    "isInTrial": false
  },
  "renewalSettings": {
    "kind": "subscriptions#renewalSettings",
    "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
  },
  "purchaseOrderId": "my_example.com_annual_1",
  "status": "ACTIVE",
  "customerDomain": "my_example.com",
  "dealCode": "GOOGLE_CONTRACT_DEAL_CODE",
  "skuName": "Google Workspace Business Standard"
}

定期購入の移行

新しいお客様アカウントを注文するオペレーションを使用してお客様のアカウントを注文しなかった場合は、そのお客様の定期購入を作成するときにお客様の移行トークンを使用します。

注文していない顧客アカウントのサブスクリプションを作成するには、次の POST HTTP リクエストを使用します。

POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions?customerAuthToken=TOKEN_VALUE

次のように置き換えます。

  • CUSTOMER_ID: お客様のメインのドメイン名またはお客様の一意の識別子。
  • TOKEN_VALUE: お客様から提供された移行トークン。お客様がトークンを生成した後、トークンは 30 日間有効です。

転送トークンを取得する方法について詳しくは、Google Workspace ヘルプセンターをご覧ください。

年間コミットメント プランの顧客の定期購入を移行するには、次の POST HTTP リクエストを使用し、認証トークンを含めます。

POST https://reseller.googleapis.com/apps/reseller/v1/customers/C0123456/subscriptions?customerAuthToken=auth token
{
  "customerId": "CUSTOMER_ID",
  "skuId": "SKU_ID",
  "plan": {
    "planName": "ANNUAL_MONTHLY_PAY"
  },
  "seats": {
    "numberOfSeats": 10,
    "licensedNumberOfSeats": 10
  },
  "purchaseOrderId": "PURCHASE_ORDER_ID"
}

次のように置き換えます。

  • CUSTOMER_ID: お客様のメインのドメイン名またはお客様の一意の識別子。
  • SKU_ID: 一意の最小管理単位（SKU）識別子。詳細については、プロダクトと SKU ID をご覧ください。
  • PURCHASE_ORDER_ID: 使用状況の追跡に使用できる注文書 ID（省略可）。

成功すると、HTTP 200 ステータス コードと、年間コミットメント プランの移行された定期購入の設定が返されます。

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "billingMethod": "ONLINE",
  "skuId": "1010020028",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "ANNUAL",
    "isCommitmentPlan": true,
    "commitmentInterval": {
      "startTime": "1331647980142",
      "endTime": "1363183980142"
    }
  },
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 10,
    "licensedNumberOfSeats": 10
  },
  "trialSettings": {
    "isInTrial": false
  },
  "renewalSettings": {
    "kind": "subscriptions#renewalSettings",
    "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
  },
  "purchaseOrderId": "example.com_annual_1",
  "status": "ACTIVE",
  "resourceUiUrl": "URL to customer's Admin console dashboard",
  "skuName": "Google Workspace Business Standard"
}

移行の制限

関連付けられた Google Drive サブスクリプションまたは Google Vault サブスクリプションを含む Google Workspace サブスクリプションを移行する場合は、batch オペレーションを使用して、ステータスが ACTIVE のすべてのサブスクリプションを移行します。各定期購入を 1 つずつ移行すると、エラーが発生します。

停止中の定期購入の移行は、停止の理由が PENDING_TOS_ACCEPTANCE、TRIAL_ENDED、または RENEWAL_WITH_TYPE_CANCEL の場合にのみ許可されます。

以前の SKU を移行する場合、subscriptions.list は移行が必要な SKU の skuId を返します。お客様が実際に持っている SKU の skuId は transferInfo.currentLegacySkuId として返されます。skuIds の完全なリストと、これらのプランで使用されるプロダクトについては、プロダクトと SKU をご覧ください。

送金では割引ディールコードを使用できません。