サブスクリプションを取得したら、成功したレスポンスの情報を使用して、サブスクリプションのステータスを変更したり、サブスクリプションを更新したりできます。このページでは、サブスクリプションを取得して更新するさまざまな方法について説明します。
サブスクリプションを取得する
正常に注文または移行された定期購入を取得するには、次の 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 は、販売パートナー 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。この値は、すべての販売店サブスクリプションを取得するメソッドを使用して取得できます。
次の例では、値が 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: お客様ごとに一意のサブスクリプション 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] ページをご覧ください。