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

定期購入の取得と更新

サブスクリプションを取得したら、サブスクリプションの情報を使用して、正常に完了したレスポンスが定期購入のステータスを変更する更新してください。このページでは、Google Chat でサブスクリプションの取得と更新を行えます

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

注文または移行が完了したサブスクリプションを取得するには、次のコマンドを使用します。 HTTP リクエストの後に GETHTTP リクエストが送信される。

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 は、お客様から提供された移行トークンで、固有のものですお客様により生成された後、 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"
}

バッチ方式を使用してこれらのサブスクリプションを移行することを計画している場合は、すべてのサブスクリプションを移行します。各サブスクリプションの移行エラーが発生します。また、バッチオペレーションではステータスが 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 日間トライアルの詳細とお客様の条件については、管理者向けヘルプセンターをご覧ください。
フレキシブルプランから年間契約プランに更新できます。
年間コミットメントプランは更新できません。
すべてのプランがすべてのプロダクトに対応しているわけではありません。Google Kubernetes Engine のプロダクトが使用されている場合は、プロダクトと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 の値は、既存のライセンスと新しいライセンスです。これは、Chronicle に送信されるライセンスが必要です。

{
  "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: 年間コミットメントプランの期間の終了時に、サブスクリプションのプランを ANNUAL_YEARLY_PAY として自動更新し、同じ numberOfSeats。
AUTO_RENEW_MONTHLY_PAY: 年間コミットメントプランの終了時サブスクリプションのプランを ANNUAL_MONTHLY_PAY を同じ numberOfSeats に置き換えます。
RENEW_CURRENT_USERS_YEARLY_PAY: 年間コミットメントプランの終了時サブスクリプションのプランを ANNUAL_YEARLY_PAY として更新しますが、現在アクティブなユーザーライセンスの合計数。これがデフォルトです有効な年間コミットメントプラン（年払い）を設定します。
RENEW_CURRENT_USERS_MONTHLY_PAY: 年間コミットメントプランの終了時サブスクリプションのプランを ANNUAL_MONTHLY_PAY として更新しますが、現在アクティブなユーザーライセンスの合計数。これがデフォルトです有効な年間コミットメントプラン（月額制）の設定が必要です。
RENEW_ON_PROPOSED_OFFER: 現在のコミットメントプランの終了時 interval の場合は、最新の更新提案で 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"
}

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

契約期間の途中で年間プランをダウングレードすることはできません。ダウングレードをスケジュールできますGoogle Cloud コンソールの更新設定で FLEXIBLE に切り替え、更新日時後にダウングレードします。

サブスクリプションをアップグレードまたはダウングレードするには、新しいサブスクリプションを作成してくださいアップグレードまたはダウングレードする skuId に置き換えます。

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

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

CUSTOMER_ID: 顧客のプライマリドメイン顧客の一意の識別子を指定します

この呼び出しにより以前のサブスクリプションが終了し、新しいサブスクリプションが作成されます。

詳細情報: アップグレードとダウングレードプロダクトと[SKU]ページで確認できます

定期購入の取得と更新

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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