Skip to main content
取消待处理、活跃或逾期的订阅。行为取决于当前订阅状态。
认证方式: API Key(merchant、owner 角色)
此端点也有 customer 侧的 session-token 调用流程:见 取消订阅(Customer)

取消行为

  • pending:直接取消,状态变为 canceled,不经过 canceling
  • pending 的换方案新订阅:同样直接变为 canceled,区别是那笔待生效订阅的 PSP 取消按发起时刻投递,因此它在原定切换时刻既不激活也不扣款。原订阅一格不动:保持 canceling,不回到 active
  • active:触发 PSP 取消(在计费周期结束时生效)。本地状态变为 canceling,然后在周期结束时通过 Webhook 更新为 canceled
  • past_due:PSP 取消立即投递,不排到周期末。本地状态变为 canceling,PSP 确认后通过 Webhook 更新为 canceled。该路径不发送「取消中,可用至 X 日」邮件 —— 计费周期已经结束
处于 canceling 的订阅通常可以通过恢复订阅撤回,但发起取消时存在未结清扣款的订阅不可撤回,该端点返回 400。取消 past_due 订阅必然属于此类。
因已确认的换方案而处于 canceling 的订阅永远不可撤回,取消那笔待生效的新订阅、把变更作废之后也一样:支付渠道在确认变更时就已把原订阅置为待取消,且不提供恢复接口。它单向走向 canceled;想让买家继续付费,请重新下单。

请求体

请求示例

成功响应 (200) — 活跃订阅

成功响应 (200) — 待处理订阅

响应字段

错误响应

重试策略:4xx 一律不要重试 — 修正请求后重发。5xx 指数退避重试(起步 5s,最多 3 次)。