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
詳情請參閱授權指南。
除非另有註明，否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權，程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間：2025-07-25 (世界標準時間)。
[null,null,["上次更新時間：2025-07-25 (世界標準時間)。"],[],[],null,["# Method: subscriptions.suspend\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nSuspends an active subscription.\n\nYou can use this method to suspend a paid subscription that is currently in the `ACTIVE` state.\n\n- For `FLEXIBLE` subscriptions, billing is paused.\n- For `ANNUAL_MONTHLY_PAY` or `ANNUAL_YEARLY_PAY` subscriptions:\n - Suspending the subscription does not change the renewal date that was originally committed to.\n - A suspended subscription does not renew. If you activate the subscription after the original renewal date, a new annual subscription will be created, starting on the day of activation.\n\nWe strongly encourage you to suspend subscriptions only for short periods of time as suspensions over 60 days may result in the subscription being cancelled.\n\n### HTTP request\n\n`POST https://reseller.googleapis.com/apps/reseller/v1/customers/{customerId}/subscriptions/{subscriptionId}/suspend`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `customerId` | `string` This can be either the customer's primary domain name or the customer's unique identifier. If the domain name for a customer changes, the old domain name cannot be used to access the customer, but the customer's unique identifier (as returned by the API) can always be used. We recommend storing the unique identifier in your systems where applicable. |\n| `subscriptionId` | `string` This is a required property. The `subscriptionId` is the subscription identifier and is unique for each customer. Since a `subscriptionId` changes when a subscription is updated, we recommend to not use this ID as a key for persistent data. And the `subscriptionId` can be found using the [retrieve all reseller subscriptions](https://developers.google.com/workspace/admin/reseller/v1/how-tos/manage_subscriptions#get_all_subscriptions) method. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [Subscription](/workspace/admin/reseller/reference/rest/v1/subscriptions#Subscription).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/apps.order`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
