POST/api/v1/subscriptions/:subscriptionId/cancel取消订阅

立即停止续订;已支付周期结束前服务继续有效。

Request

Headers

NameData TypeRequiredDescription
AuthorizationstringYes会话令牌认证,格式 `Bearer <sessionToken>`
type RequestHeaders = {
  /** 会话令牌认证,格式 `Bearer <sessionToken>` */
  Authorization: string
}

URL Parameters

Name Data Type Description
subscriptionId string 订阅 ID

Response

Body

NameData TypeRequiredDescription
subscriptionIdstringYes订阅 ID
statusstringYes固定为 canceled
activeUntilstringYes服务有效期截止时间
type ResponseBody = {
  /** 订阅 ID */
  subscriptionId: string
  /** 固定为 canceled */
  status: string
  /** 服务有效期截止时间 */
  activeUntil: string
}
{
  "subscriptionId": "01JD8SOBHV0C3D9JD",
  "status": "canceled",
  "activeUntil": "2026-11-13T09:00:00Z"
}

HTTP Code

HTTP Status Meaning Notes
200 成功 订阅已取消
409 状态不允许 订阅已取消或已过期

Response Code

响应使用统一信封 {id, code, messages, result},其 code 字段:

code Meaning Notes
0 成功 订阅已取消,停止续订
2805 订阅状态不允许该操作 订阅已取消或已过期

Examples

POST /api/v1/subscriptions/01JD8SOBHV0C3D9JD/cancel
Authorization: Bearer st_7c1f9e05b28d4a63
{
  "id": "01JD8SSWMR1M9OH",
  "code": 0,
  "messages": [],
  "result": {
    "subscriptionId": "01JD8SOBHV0C3D9JD",
    "status": "canceled",
    "activeUntil": "2026-11-13T09:00:00Z"
  }
}