定期購入の取得と更新

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

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

正常に注文または移行されたサブスクリプションを取得するには、次の 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&pageToken=START_DATE&maxResults=MAX_NUMBER

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

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

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

成功すると、レスポンスとして HTTP 200 ステータスコードと、顧客のサブスクリプションと設定のリストが返されます。サブスクリプションのリストには、このバージョンの販売パートナー 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。この値は、すべての販売パートナーサブスクリプションを取得するメソッドを使用して取得できます。

次の例では、subscriptionId が 123 のサブスクリプションを更新します。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 のページをご覧ください。

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

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

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

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

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

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

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

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

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

サブスクリプションの更新設定を更新する

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

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

定期購入の取得と更新

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

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

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