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

定期購入の取得と更新

サブスクリプションを取得したら、成功したレスポンスから取得した情報を使用して、サブスクリプションのステータスを変更したり、サブスクリプションを更新したりできます。このページでは、定期購入を取得して更新するさまざまな方法について説明します。

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

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

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

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

CUSTOMER_ID: お客様のメインドメイン名またはお客様の一意の識別子。
SUBSCRIPTION_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: 各顧客に固有のサブスクリプション識別子。この値は、すべての販売パートナーサブスクリプションを取得するメソッドを使用して取得できます。

次の例では、値が 123 の subscriptionId でサブスクリプションを更新します。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: 各顧客に固有のサブスクリプション識別子。この値は、すべての販売パートナーサブスクリプションを取得するメソッドを使用して取得できます。

次の例では、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: 各顧客に固有のサブスクリプション識別子。この値は、すべての販売パートナーサブスクリプションを取得するメソッドを使用して取得できます。

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

{
  "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: 各顧客に固有のサブスクリプション識別子。この値は、すべての販売パートナーサブスクリプションを取得するメソッドを使用して取得できます。

次の例では、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] ページをご覧ください。

定期購入の取得と更新 コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

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

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

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

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

サブスクリプション プランを更新する

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

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

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

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

無料トライアル サブスクリプションから有料サービスを開始する

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

定期購入の取得と更新

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

サブスクリプションプランを更新する

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

無料トライアルサブスクリプションから有料サービスを開始する