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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
customerId

string

這可以是客戶的主網域名稱，或客戶的專屬 ID。如果客戶的網域名稱有所變更，您就無法使用舊網域名稱存取客戶，但您隨時可以使用客戶的專屬 ID (由 API 傳回)。建議您在適用的情況下，將專屬 ID 儲存在系統中。
subscriptionId

string

這是必要屬性。subscriptionId 是訂閱 ID，每位客戶皆有專屬 ID。由於訂閱項目更新時，subscriptionId 會有所變更，因此建議您不要將此 ID 用於永久性資料的索引鍵。您可以使用擷取所有經銷商訂閱項目方法找到 subscriptionId。

要求主體

要求主體必須為空白。

回應主體

如果成功，回應主體會包含 Subscription 的執行例項。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱授權指南。