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
这可以是客户的主域名,也可以是客户的唯一标识符。如果客户的域名发生变化,则无法使用旧域名访问该客户,但可以随时使用客户的唯一标识符(由 API 返回)。我们建议您在系统中存储唯一标识符(如果适用)。
|
subscriptionId |
string
这是必需属性。subscriptionId 是订阅标识符,每个客户都有唯一的标识符。由于订阅更新时 subscriptionId 会发生变化,因此我们建议您不要将此 ID 用作永久性数据的键。您可以使用检索所有转销商订阅方法找到 subscriptionId 。
|
响应正文
如果成功,则响应正文包含一个 Subscription
实例。
授权范围
需要以下 OAuth 范围:
https://www.googleapis.com/auth/apps.order
如需了解详情,请参阅授权指南。
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2025-07-25。
[null,null,["最后更新时间 (UTC):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)."]]