跳转到主要内容
PATCH
取消订阅
使用此接口取消现有订阅。此操作将阻止与该订阅关联的任何未来定期付款。 重要提示:
  • 取消订阅可能不会退还剩余订阅期的费用。有关退款详情,请参阅您的订阅条款。
  • 请务必在下一个账单日之前取消订阅,以免产生不必要的费用。
  • 您可以使用获取订阅状态endpoint 来验证取消操作。
此接口需要有效的 subscriptionId。订阅一旦取消,便无法恢复。如果您想重新激活服务,则需要创建新的订阅。

授权

Authorization
string
header
必填

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

请求头

Authorization
string
必填

用于身份验证的 Bearer 访问令牌。该令牌可从获取访问令牌或刷新访问令牌endpoint 获取。

路径参数

subscriptionId
string
必填

请求体

application/json
status
any
必填

更改状态为CANCELLED。

响应

OK

externalId
string

系统生成的唯一标识符,用于跟踪交易(包含字母、数字和连字符)。我们建议使用 UUID4 以确保唯一性。

subscriptionId
string

订阅的唯一标识符。

status
状态 · object

操作状态。

totalPayments
integer

订阅相关的付款总数。

pendingPayments
integer

订阅中仍待处理的付款数量。

creationDate
string

订阅创建日期和时间。格式应符合有效的日期时间字符串(例如,ISO 8601)。

payments
object[]

表示与订阅相关的付款的对象数组。

retries
integer

订阅付款处理过程中的重试次数。

最后修改于 2026年11月10日