このページは Cloud Translation API によって翻訳されました。

サブスクリプションを取得して更新する

定期購入を取得したら、正常なレスポンスの情報を使用して定期購入のステータスを変更したり、定期購入を更新したりできます。このページでは、定期購入を取得して更新するさまざまな方法に焦点を当てています。

サブスクリプションを取得する

正常に注文または移行された定期購入を取得するには、次の GET HTTP リクエストを使用します。

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

以下を置き換えます。

CUSTOMER_ID: お客様のプライマリドメイン名またはお客様の一意の識別子。
SUBSCRIPTION_ID: 顧客ごとに一意の定期購入 ID。この値は、すべての販売パートナーサブスクリプションを取得する方法を使用して取得できます。

このオペレーションでは、リクエストの本文にパラメータはありません。

成功すると、HTTP 200 ステータスコードと定期購入の設定が返されます。次のレスポンス例では、isInTrial プロパティは false ですが、trialEndTime プロパティは存在しません。つまり、このお客様がこのプランの 30 日間の無料試用を利用したことがないことを意味します。

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "skuId": "1010020028",
  "billingMethod": "ONLINE",
  "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": "RENEW_CURRENT_USERS_MONTHLY_PAY"
  },
  "purchaseOrderId": "example.com_annual_1",
  "status": "ACTIVE",
  "resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
  "skuName": "Google Workspace Business Standard"
}

顧客のすべてのサブスクリプションを取得する

注文または移行が完了した特定の販売パートナーのお客様のサブスクリプションをすべて取得するには、次の GET HTTP リクエストを使用して認証トークンを指定します。

GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerId=CUSTOMER_ID value&pageToken=START_DATE&maxResults=MAX_NUMBER

以下を置き換えます。

CUSTOMER_ID: お客様のプライマリドメイン名またはお客様の一意の識別子。
START_DATE: 開始日（YYYY-MM-DD 形式）。
MAX_NUMBER: レスポンスページで返される結果の最大数。

このオペレーションでは、リクエストの本文にパラメータはありません。

成功すると、HTTP 200 ステータスコードと、お客様のサブスクリプションと設定のリストが返されます。サブスクリプションのリストには、このバージョンの Reseller API で管理されていないプロダクトが含まれている可能性があります。

このお客様が管理されていない場合は、403 "Forbidden" エラーが返されます。

お客様の移行可能なすべてのサブスクリプションを取得する

販売パートナーの管理に移行する可能性があるお客様のサブスクリプションをすべて取得するには、次の GET HTTP リクエストを使用し、認証トークンを含めます。customerId は必須で、販売パートナー経由で購入されたお客様のアカウントを取得する際に返されるお客様の一意の識別子です。customerAuthToken は顧客から提供された移行トークンで、貴社の販売パートナー ID に固有のものです。顧客が生成した有効期限は 30 日間です。お客様がトークンを生成する方法の詳細については、Google Workspace アカウントを販売パートナーに移行するをご覧ください。

GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerId=CUSTOMER_ID&customerAuthToken=AUTH_TOKEN&pageToken=START_DATE&maxResults=MAX_NUMBER

以下を置き換えます。

CUSTOMER_ID: お客様のプライマリドメイン名またはお客様の一意の識別子。
AUTH_TOKEN: 顧客から提供された、販売パートナー ID に固有の移行トークン。これは、お客様が生成してから 30 日間有効です。お客様がトークンを生成する方法の詳細については、Google Workspace アカウントを販売パートナーに移行するをご覧ください。この値が無効または期限切れの場合、API レスポンスは 403 "Forbidden" エラーを返します。
START_DATE: 開始日（YYYY-MM-DD 形式）。
MAX_NUMBER: レスポンスページで返される結果の最大数。

このオペレーションでは、リクエストの本文にパラメータはありません。

成功すると、HTTP 200 ステータスコードと、お客様の移行可能な定期購入のリスト（移行トークンの有効期限、移行注文に必要な最小シート数など）が返されます。お客様が、移行できない追加のサブスクリプションを保有している可能性があります。

{
  "kind": "reseller#subscriptions",
  "subscriptions": [
    {
      "kind": "subscriptions#subscription",
      "customerId": "custId-6543",
      "subscriptionId": "432",
      "skuId": "1010020028",
      "billingMethod": "ONLINE",
      "creationTime": "1331647980142",
      "plan": {
        "planName": "ANNUAL",
        "isCommitmentPlan": true,
        "commitmentInterval": {
          "startTime": "1331647980142",
          "endTime": "1363183980142"
        }
      },
      "seats": {
        "kind": "subscriptions#seats",
        "numberOfSeats": 10,
        "maximumNumberOfSeats": 500,
        "licensedNumberOfSeats": 10
      },
      "trialSettings": {
        "isInTrial": false
      },
      "renewalSettings": {
        "kind": "subscriptions#renewalSettings",
        "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
      },
      "transferInfo": {
        "transferabilityExpirationTime": "1333183980142",
        "minimumTransferableSeats": "20"
      },
      "purchaseOrderId": "PO_890",
      "status": "ACTIVE",
      "resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
      "skuName": "Google Workspace Business Standard"
    },
    {
      "kind": "subscriptions#subscription",
      "customerId": "custId-6543",
      "subscriptionId": "140",
      "skuId": "1010020028",
      "creationTime": "1329389322728",
      "plan": {
        "planName": "FLEXIBLE",
        "isCommitmentPlan": false
      },
      "seats": {
        "kind": "subscriptions#seats",
        "maximumNumberOfSeats": 50
        "licensedNumberOfSeats": 10
      },
      "trialSettings": {
        "isInTrial": false,
        "trialEndTime": "1331877480016"
      },
      "renewalSettings": {
        "kind": "subscriptions#renewalSettings",
        "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
      },
      "transferInfo": {
        "transferabilityExpirationTime": "1333183780159",
        "minimumTransferableSeats": "10"
      },
      "purchaseOrderId": "",
      "status": "ACTIVE",
      "resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
      "skuName": "Google Workspace Business Standard"
    },
  ],
  "nextPageToken": "token"
}

バッチオペレーションでこれらのサブスクリプションを移行する場合は、すべてのサブスクリプションを移行します。サブスクリプションを 1 つずつ転送すると、エラーが発生します。また、バッチオペレーションでは、ステータスが ACTIVE のサブスクリプションのみが転送されます。詳しくは、サブスクリプションを移行するをご覧ください。

すべての販売パートナーサブスクリプションを取得する

販売パートナーの注文または移行に成功したサブスクリプションをすべて取得するには、次の GET HTTP リクエストを使用して認証トークンを含めます。

GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerNamePrefix=PREFIX &pageToken=TOKEN&maxResults=MAX_NUMBER

以下を置き換えます。

PREFIX: サブスクリプションを検索する顧客の名前の先頭。
TOKEN: サーバーが返す結果の特定のページを識別するトークン。
MAX_NUMBER: レスポンスページで返される結果の最大数。

このオペレーションでは、OAuth 読み取り専用アクセススコープを使用できます。customerNamePrefix、pageToken、maxResults はオプションのクエリ文字列です。

次の例では、名前が「exam」で始まるお客様に属する販売パートナーのサブスクリプションをすべて取得します。

GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerNamePrefix=exam

{
  "kind": "reseller#subscriptions",
  "subscriptions": [
    {
      "kind": "subscriptions#subscription",
      "customerId": "C0123456",
      "subscriptionId": "123",
      "skuId": "1010020028",
      "creationTime": "1331647980142",
      "billingMethod": "ONLINE",
      "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": "PO_135",
      "status": "ACTIVE",
      "resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
      "skuName": "Google Workspace Business Standard"
    },
    {
      "kind": "subscriptions#subscription",
      "customerId": "custId-5678",
      "subscriptionId": "1404686",
      "skuId": "1010020028",
      "billingMethod": "ONLINE",
      "creationTime": "1329389322728",
      "plan": {
        "planName": "FLEXIBLE",
        "isCommitmentPlan": false
      },
      "seats": {
        "kind": "subscriptions#seats",
        "maximumNumberOfSeats": 50,
        "licensedNumberOfSeats": 10
      },
      "trialSettings": {
        "isInTrial": false,
        "trialEndTime": "1331877480016"
      },
      "renewalSettings": {
        "kind": "subscriptions#renewalSettings",
        "renewalType": "AUTO_RENEW"
      },
      "purchaseOrderId": "",
      "status": "ACTIVE",
      "resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
      "skuName": "Google Workspace Business Standard"
    },
  ],
  "nextPageToken": "token"
}

定期購入プランを更新する

Google Workspace プランの更新方法は、プランによって異なります。プランを更新する前に、次の点を考慮してください。

サブスクリプションを作成し、お客様が対象の場合、サブスクリプションのプランを 30 日間の試用版にすることができます。フレキシブルプランと年間契約お支払いプランはどちらも 30 日間の無料試用にできます。試用期間中は、必要に応じてサブスクリプションのお支払いプランをフレキシブルプランまたは年間コミットメントプランに変更できます。ただし、トライアルが終了してプランがアクティブになると、他のサブスクリプションの有効なプランと同じルールに従ってプランが更新されます。試用中のサブスクリプションを有効なプランにすぐに移行するには、30 日間の無料試用サブスクリプションから有料サービスを開始します。30 日間のトライアルの情報とお客様適性評価のルールについては、管理者向けヘルプセンターをご覧ください。
フレキシブルプランは年間契約プランに更新できます。
年間契約プランは更新できません。
すべてのプランがすべてのサービスで利用できるわけではありません。これらのプランで使用されるサービスの詳細については、サービスと SKU をご覧ください。

30 日間の試用プランまたはフレキシブルプランのサブスクリプションを年間コミットメントプランに更新するには、次の POST HTTP リクエストを使用します。

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

以下を置き換えます。

CUSTOMER_ID: お客様のプライマリドメイン名またはお客様の一意の識別子。
SUBSCRIPTION_ID: 顧客ごとに一意の定期購入 ID。この値は、すべての販売パートナーサブスクリプションを取得する方法を使用して取得できます。

次の例では、subscriptionId の値が 123 のサブスクリプションを更新します。customerId は C0123456 です。

POST https://reseller.googleapis.com/apps/reseller/v1/customers/C0123456/subscriptions/123/changePlan

リクエストの本文は次のようになります。

{
  "kind": "reseller#changePlanRequest",
  "planName": "ANNUAL_MONTHLY_PAY",
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 10
  },
  "purchaseOrderId": "123_March2012"
}

成功すると、HTTP 201 ステータスコードが返され、更新されたサブスクリプションプランの設定が返されます。

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "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": "123_March2012",
  "status": "ACTIVE",
  "skuName": "Google Workspace Business Standard"
}

定期購入のシートを更新する

年間契約プランのサブスクリプションの更新と、Google Workspace フレキシブルプランのサブスクリプションの更新では、異なるサブスクリプションプロパティが使用されます。

年間プランのサブスクリプションのシート数を更新する

年間プランサブスクリプションのユーザーライセンス設定を更新するには、次の POST HTTP リクエストを使用します。

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

以下を置き換えます。

CUSTOMER_ID: お客様のプライマリドメイン名またはお客様の一意の識別子。
SUBSCRIPTION_ID: 顧客ごとに一意の定期購入 ID。この値は、すべての販売パートナーサブスクリプションを取得する方法を使用して取得できます。

次の例では、サブスクリプションを 123 個の subscriptionId で更新します。customerId は C0123456 です。リクエストの本文はプランのタイプによって異なります。

POST https://reseller.googleapis.com/apps/reseller/v1/customers/C0123456/subscriptions/123/changeSeats

Google Workspace の年間契約プランのサブスクリプションでは、このリクエスト本文を使用して、ユーザーライセンス数を更新します。numberOfSeats の値は合計です。たとえば、以前に 10 個のユーザーライセンスがあり、5 個の新しいライセンスを注文した場合、次の例に示すように、numberOfSeats のリクエスト本文の合計は 15 になります。

{
    "kind": "subscriptions#seats",
    "numberOfSeats": 15
}

フレキシブルプランのサブスクリプションのシート数の更新

Google Workspace フレキシブルプランのサブスクリプションでは、リクエストの本文を使用してユーザーライセンスを更新します。maximumNumberOfSeats の値は、既存のライセンスと新しいライセンスの合計です。これは、アカウントでプロビジョニングできるユーザーライセンスの最大数です。

{
  "kind": "subscriptions#seats",
  "maximumNumberOfSeats": 15
}

成功すると、HTTP 201 ステータスコードと更新されたサブスクリプションライセンス設定が返されます。

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "skuId": "1010020028",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "FLEXIBLE",
    "isCommitmentPlan": false
  },
  "seats": {
    "kind": "subscriptions#seats",
    "maximumNumberOfSeats": 15,
    "licensedNumberOfSeats": 10
  },
  "trialSettings": {
    "isInTrial": false
  },
  "skuName": "Google Workspace Business Standard"
}

定期購入の更新設定を更新する

年間契約のサブスクリプションの更新設定を更新するには、次の POST HTTP リクエストを使用します。

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

以下を置き換えます。

CUSTOMER_ID: お客様のプライマリドメイン名またはお客様の一意の識別子。
SUBSCRIPTION_ID: 顧客ごとに一意の定期購入 ID。この値は、すべての販売パートナーサブスクリプションを取得する方法を使用して取得できます。

リクエストの本文の例を次に示します。

{
  "kind": "subscriptions#renewalSettings",
  "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
}

renewalType プロパティの値は次のいずれかです。

AUTO_RENEW_YEARLY_PAY: 年間契約プランの期間終了時に、同じ numberOfSeats でサブスクリプションプランを ANNUAL_YEARLY_PAY として自動更新します。
AUTO_RENEW_MONTHLY_PAY: 年間契約プランの期間終了時に、同じ numberOfSeats でサブスクリプションプランを ANNUAL_MONTHLY_PAY として自動更新します。
RENEW_CURRENT_USERS_YEARLY_PAY: 年間契約プランの期間終了時に、現在のアクティブユーザーライセンスの合計数を使用してサブスクリプションプランを ANNUAL_YEARLY_PAY として更新します。これは有効な年間契約プランのデフォルトの設定です（年払い）。
RENEW_CURRENT_USERS_MONTHLY_PAY: 年間契約プランの期間終了時に、現在のアクティブユーザーライセンスの合計数を使用してサブスクリプションプランを ANNUAL_MONTHLY_PAY として更新します。これは有効な年間契約プランのデフォルトの設定です（月払い）。
RENEW_ON_PROPOSED_OFFER: 現在のコミットメントプランの期間の終了時に、現在のアクティブユーザーライセンス数または提案された特典のコミットメント数（いずれか多いほう）を numberOfSeats にして、最新の更新提案で更新します。
SWITCH_TO_PAY_AS_YOU_GO: 年間コミットメントプランの期間終了時に、年間コミットメントプランをフレキシブルプランに変更します。
CANCEL: 年間契約プランの期間が終了すると、サブスクリプションが停止されます。停止を解除する方法については、管理者向けヘルプセンターをご覧ください。

成功すると、HTTP 201 ステータスコードと更新された定期購入更新設定が返されます。

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "skuId": "1010020028",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "ANNUAL",
    "isCommitmentPlan": true,
    "commitmentInterval": {
      "startTime": "1331647980142",
      "endTime": "1363183980142"
    }
  },
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 15,
    "licensedNumberOfSeats": 15
  },
  "trialSettings": {
    "isInTrial": false
  },
  "renewalSettings": {
    "kind": "subscriptions#renewalSettings",
    "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
  },
  "skuName": "Google Workspace Business Standard"
}

無料試用サブスクリプションから有料サービスを開始する

30 日間の無料試用サブスクリプションを有料サービスの定期購入にすぐに移行するには、試用版の定期購入にお支払いプランがすでに設定されている場合、次の POST HTTP リクエストを使用します。

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

以下を置き換えます。

CUSTOMER_ID: お客様のプライマリドメイン名またはお客様の一意の識別子。
SUBSCRIPTION_ID: 顧客ごとに一意の定期購入 ID。この値は、すべての販売パートナーサブスクリプションを取得する方法を使用して取得できます。

次の例では、customerId が C0123456 で、subscriptionId の値が 123 になっています。

POST https://reseller.googleapis.com/apps/reseller/v1/customers/C0123456/subscriptions/123/startPaidService

このオペレーションでは、リクエストの本文にパラメータはありません。

成功すると、HTTP 201 ステータスコードと更新された定期購入設定が返されます。

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "skuId": "1010020028",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "ANNUAL",
    "isCommitmentPlan": true,
    "commitmentInterval": {
      "startTime": "1331647980142",
      "endTime": "1363183980142"
    }
  },
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 15,
    "licensedNumberOfSeats": 15
  },
  "trialSettings": {
    "isInTrial": false
  },
  "renewalSettings": {
    "kind": "subscriptions#renewalSettings",
    "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
  },
  "skuName": "Google Workspace Business Standard"
}

サブスクリプションをアップグレードまたはダウングレードする

契約期間の途中で年間プランをダウングレードすることはできません。また、更新設定を使用してダウングレードをスケジュールすることもできません。更新設定を FLEXIBLE に切り替えて、更新後にダウングレードすることをおすすめします。

定期購入をアップグレードまたはダウングレードするには、アップグレードまたはダウングレードする skuId で新しい定期購入を作成します。

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

以下を置き換えます。

CUSTOMER_ID: お客様のプライマリドメイン名またはお客様の一意の識別子。

この呼び出しにより、以前の定期購入が終了し、新しい定期購入が作成されます。

アップグレードとダウングレードの詳細については、プロダクトと SKU のページをご覧ください。

サブスクリプションを取得して更新する

サブスクリプションを取得する

顧客のすべてのサブスクリプションを取得する

お客様の移行可能なすべてのサブスクリプションを取得する

すべての販売パートナー サブスクリプションを取得する

定期購入プランを更新する

定期購入のシートを更新する

年間プランのサブスクリプションのシート数を更新する

フレキシブル プランのサブスクリプションのシート数の更新

定期購入の更新設定を更新する

無料試用サブスクリプションから有料サービスを開始する

サブスクリプションをアップグレードまたはダウングレードする

すべての販売パートナーサブスクリプションを取得する

フレキシブルプランのサブスクリプションのシート数の更新