取消订阅

商户取消已存在的订阅。已为 CANCELLED 或 FAILED 时视为幂等成功返回。

接口说明

请求方式：【POST】/v1/subscription/cancel

请求域名：【主域名】https://api.baofu.com

请求参数

Header 参数

参数名	类型	必填	描述
Authorization	string	true	请参考【开发指引-整体说明】生成认证信息
Accept	string	true	请设置为 `application/json`
Content-Type	string	true	请设置为 `application/json`

Body 参数

参数名	类型	必填	描述
subscription_no	string(32)	true	订阅号
reason	string(256)	false	取消原因

请求示例

{
  "subscription_no": "SP01010120260319120000000001",
  "reason": "USER_REQUEST"
}

应答参数

200 OK

参数名	类型	必填	描述
subscription_no	string	true	订阅号
out_trade_no	string	true	商户签约订单号
subscription_status	string	true	订阅状态，取值：`PENDING_ACTIVATE` / `ACTIVE` / `SUSPENDED` / `CANCELLED` / `FAILED` / `EXPIRED`
cancel_time	string	false	取消时间，ISO 8601（可空）

应答示例

200 OK

{
  "subscription_no": "SP01010120260319120000000001",
  "out_trade_no": "MCH202603190001",
  "subscription_status": "CANCELLED",
  "cancel_time": "2026-04-16T14:30:00+08:00"
}

错误码

公共错误码

状态码	错误码	描述	解决方案
400	PARAM_ERROR	参数校验失败	必填参数缺失或格式不合法
401	SIGN_ERROR	验证不通过	请参阅【开发指引-整体说明】排查签名
500	SYSTEM_ERROR	系统异常	内部系统错误

业务错误码

状态码	错误码	描述	解决方案
404	RESOURCE_NOT_EXISTS	订阅不存在	订阅号对应记录不存在
200	ORDER_CLOSED	订阅状态不合法	订阅当前状态不允许取消
404	MCH_NOT_EXISTS	商户号不匹配	传入的 `merchantNo` 与订阅归属不一致

应答示例

失败

{
  "code": "RESOURCE_NOT_EXISTS",
  "message": "订阅不存在"
}