跳转到主要内容
GET
获取订阅列表
查询订阅合同列表

授权

Authorization
string
header
必填

Bearer API Key 鉴权。格式:Authorization: Bearer {your_api_key}

请求头

Request-Id
string
默认值:008e3967-a1b5-48bb-be14-d5bff5092e61
必填

请求的唯一标识符

查询参数

ids
string[]

订阅的 id 数组,筛选 id 属于这个数组的订阅记录

status
string

订阅业务状态:

  • init - 待生效
  • trial - 试用期
  • active - 生效中
  • paused - 暂停
  • past_due - 逾期
  • unpaid - 未支付
  • canceled - 已终止
starting_after
string

用于分页的游标。starting_after 是定义您在列表中位置的对象 ID。例如,如果想获取下一页,可以在第一次获取对象列表之后,使用最后一个对象的 id 作为参数值。不能和 `ending_before 同时使用

ending_before
string

用于分页的游标 ending_before 是定义您在列表中位置的对象 ID。例如,如果想获取上一页,可以在第一次获取对象列表之后,使用第一个对象的 id 作为参数值。不能和 starting_after 同时使用

limit
integer<int32>

分页参数,每页数量,默认:10,接口默认按创建时间倒序排序。限制:[1, 100]

merchant_id
string

商户唯一标识

order_ids
string[]

您平台的订单 ID 数组,筛选出 order_id 属于此数组的订阅记录。

source_trade_ids
string[]

来源交易订单 ID 数组,筛选出 source_trade_id 属于此数组的订阅记录

billing_cycle_unit
string[]

根据订阅周期筛选,支持的枚举值:

  • week - 周
  • month - 月
  • quarter - 季
  • year - 年
  • customer-initiated - 客户发起
  • over_threshold - 按量计费
search_type
string

搜索类型,取值为以下字段之一:subscription_id、trade_id、refund_id、invoice_id、customer_id

search_value
string

与 search_type 对应的搜索值

created_at.gt
string

用于过滤的最小值(不包含,RFC3339格式的UTC时间,例如'2025-01-01T00:00:00Z')

created_at.gte
string

用于过滤的最小值(包含,RFC3339格式的UTC时间,例如'2025-01-01T00:00:00Z')

created_at.lt
string

用于过滤的最大值(不包含,RFC3339格式的UTC时间,例如'2025-01-01T00:00:00Z')

created_at.lte
string

用于过滤的最大值(包含,RFC3339格式的UTC时间,例如'2025-01-01T00:00:00Z')

响应

OK

code
string

error code

message
string

error message

data
object