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。由於 subscriptionId 會在訂閱項目更新時變更，因此建議您不要使用這個 ID 做為持續性資料的鍵。您也可以使用擷取所有經銷商訂閱方法找出 subscriptionId。

要求主體

要求主體必須為空白。

回應主體

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

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱授權指南。