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

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

  • 年間契約のサブスクリプション
  • フレキシブルなサブスクリプション
  • 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)ID。詳しくは、プロダクトと 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)ID。詳しくは、プロダクトと 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)ID。詳しくは、プロダクトと 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)ID。詳しくは、プロダクトと 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)ID。詳しくは、プロダクトと 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 ドライブまたは Google Vault サブスクリプションと Google Workspace サブスクリプションを移行する場合は、batch オペレーションを使用して、ACTIVE ステータスのすべてのサブスクリプションを移行します。各サブスクリプションを 1 つずつ移行すると、エラーが発生します。

停止中のサブスクリプションの移行は、停止の理由が PENDING_TOS_ACCEPTANCETRIAL_ENDEDRENEWAL_WITH_TYPE_CANCEL の場合にのみ許可されます。

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

移行は割引ディールコードでは使用できません。