查询订阅

按订阅号或商户订单号查询订阅详情。subscription_no 与 out_trade_no 二选一且仅填一项。

接口说明

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

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

请求参数

Header 参数

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

Body 参数

参数名 类型 必填 描述
subscription_no string false 【订阅号】与 out_trade_no 至少填一个；两者都填时以本字段为准
out_trade_no string false 【商户订单号】与 subscription_no 至少填一个

请求示例

{
  "subscription_no": "SP01010120260319120000000001"
}
{
  "out_trade_no": "MCH202603190001"
}

应答参数

200 OK

参数名 类型 必填 描述
subscription_no string true 订阅号
out_trade_no string true 商户签约订单号
product_code string true 产品编码
merchant_user_id string false 用户标识（可空）
period_type string true 周期类型，取值：DAY / WEEK / MONTH / QUARTER / HALF_YEAR / YEAR / MONTH_FIXED_DAY
period_value integer true 周期值
fixed_day integer false 固定扣款日（可空）
period_amount integer true 每期扣款金额（分）
applied_pricing_type string false 营销定价类型（可空），取值：FREE_TRIAL / FIRST_PERIOD_DISCOUNT / TIERED_DISCOUNT / FIXED_DISCOUNT / NO_DISCOUNT / MERCHANT_SPECIFIED
subscription_status string true 订阅状态，取值：PENDING_ACTIVATE / ACTIVE / SUSPENDED / CANCELLED / FAILED / EXPIRED
sign_time string true 签约时间，ISO 8601
cancel_time string false 取消时间，ISO 8601（可空）
next_deduction_time string false 下次计划扣款时间，ISO 8601（可空）
deduct_period integer true 扣款期数
total_period integer false 总期数（可空）

应答示例

200 OK

{
  "subscription_no": "SP01010120260319120000000001",
  "out_trade_no": "MCH202603190001",
  "product_code": "PC202603260001",
  "merchant_user_id": "U10001",
  "period_type": "MONTH",
  "period_value": 1,
  "fixed_day": null,
  "period_amount": 1990,
  "applied_pricing_type": "FIRST_PERIOD_DISCOUNT",
  "subscription_status": "ACTIVE",
  "sign_time": "2026-03-19T12:00:00+08:00",
  "cancel_time": null,
  "next_deduction_time": "2026-04-19T12:00:00+08:00",
  "deduct_period": 1,
  "total_period": 12
}

错误码

公共错误码

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

业务错误码

状态码 错误码 描述 解决方案
404 RESOURCE_NOT_EXISTS 订阅不存在 订阅号对应记录不存在
404 MCH_NOT_EXISTS 商户号不匹配 传入的 merchantNo 与订阅归属不一致

应答示例

失败

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