Method: subscriptions.suspend

アクティブなサブスクリプションを一時停止します。

このメソッドを使用して、現在 ACTIVE ステータスの有料定期購入を停止できます。

  • FLEXIBLE の定期購入の場合、請求は一時停止されています。
  • ANNUAL_MONTHLY_PAY または ANNUAL_YEARLY_PAY の定期購入の場合:
    • サブスクリプションを停止しても、最初に契約されていた更新日は変更されません。
    • 停止中のサブスクリプションは更新されません。元の更新日以降にサブスクリプションを有効にすると、年間サブスクリプションがアクティベーション日から新規作成されます。

定期購入を短期間だけ停止することを強くおすすめします。60 日を超えて停止した場合、定期購入が解約されることもあります。

HTTP リクエスト

POST https://reseller.googleapis.com/apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/suspend

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
customerId

string

これは、顧客のプライマリ ドメイン名または顧客の一意の識別子のいずれかになります。顧客のドメイン名が変更された場合、古いドメイン名は顧客へのアクセスに使用できなくなりますが、顧客の一意の識別子（API から返されるもの）は常に使用できます。該当する場合は、システムに一意の識別子を保存することをおすすめします。
subscriptionId

string

これは必須プロパティです。subscriptionId はサブスクリプション ID で、顧客ごとに一意です。サブスクリプションが更新されると subscriptionId が変更されるため、この ID を永続データのキーとして使用しないことをおすすめします。また、subscriptionId は、すべての販売パートナー サブスクリプションを取得する方法で確認できます。

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功した場合、レスポンスの本文には Subscription のインスタンスが含まれます。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/apps.order

詳細については、承認ガイドをご覧ください。