获取订阅列表
查询订阅合同列表
授权
Bearer API Key 鉴权。格式:Authorization: Bearer {your_api_key}
请求头
请求的唯一标识符
查询参数
订阅的 id 数组,筛选 id 属于这个数组的订阅记录
订阅业务状态:
- init - 待生效
- trial - 试用期
- active - 生效中
- paused - 暂停
- past_due - 逾期
- unpaid - 未支付
- canceled - 已终止
用于分页的游标。starting_after 是定义您在列表中位置的对象 ID。例如,如果想获取下一页,可以在第一次获取对象列表之后,使用最后一个对象的 id 作为参数值。不能和 `ending_before 同时使用
用于分页的游标 ending_before 是定义您在列表中位置的对象 ID。例如,如果想获取上一页,可以在第一次获取对象列表之后,使用第一个对象的 id 作为参数值。不能和 starting_after 同时使用
分页参数,每页数量,默认:10,接口默认按创建时间倒序排序。限制:[1, 100]
商户唯一标识
您平台的订单 ID 数组,筛选出 order_id 属于此数组的订阅记录。
来源交易订单 ID 数组,筛选出 source_trade_id 属于此数组的订阅记录
根据订阅周期筛选,支持的枚举值:
- week - 周
- month - 月
- quarter - 季
- year - 年
- customer-initiated - 客户发起
- over_threshold - 按量计费
搜索类型,取值为以下字段之一:subscription_id、trade_id、refund_id、invoice_id、customer_id
与 search_type 对应的搜索值
用于过滤的最小值(不包含,RFC3339格式的UTC时间,例如'2025-01-01T00:00:00Z')
用于过滤的最小值(包含,RFC3339格式的UTC时间,例如'2025-01-01T00:00:00Z')
用于过滤的最大值(不包含,RFC3339格式的UTC时间,例如'2025-01-01T00:00:00Z')
用于过滤的最大值(包含,RFC3339格式的UTC时间,例如'2025-01-01T00:00:00Z')