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

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

  • 年間コミットメント サブスクリプション
  • 柔軟なサブスクリプション
  • 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: 固有の Stock Keeping Unit（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: 固有の Stock Keeping Unit（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: 固有の Stock Keeping Unit（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: 固有の Stock Keeping Unit（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: 固有の Stock Keeping Unit（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_ACCEPTANCE、TRIAL_ENDED、または RENEWAL_WITH_TYPE_CANCEL の場合にのみ許可されます。

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

移行は割引ディールコードでは機能しません。