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

顧客のメインのドメイン名または顧客の一意の ID を指定できます。お客様のドメイン名が変更された場合、古いドメイン名を使用してお客様にアクセスすることはできませんが、（API から返された）お客様の一意の識別子は常に使用できます。必要に応じて、一意の識別子をシステムに保存することをおすすめします。
subscriptionId

string

これは必須のプロパティです。subscriptionId は定期購入の識別子で、お客様ごとに一意です。subscriptionId は定期購入の更新時に変更されるため、この ID を永続データのキーとして使用しないことをおすすめします。subscriptionId は、すべての販売店の定期購入を取得するメソッドを使用して確認できます。

リクエストの本文

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

レスポンスの本文

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

認可スコープ

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

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

詳しくは、認可ガイドをご覧ください。