获取订阅列表

get

https://{api}.subotiz.com/api/v1/subscription

查询订阅合同列表

Query Params

ids

array of strings

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

ids

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

int32

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

merchant_id

string

商户唯一标识

order_ids

array of strings

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

order_ids

source_trade_ids

array of strings

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

source_trade_ids

billing_cycle_unit

array of strings

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

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

billing_cycle_unit

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')

Headers

Request-Id

string

required

Defaults to 008e3967-a1b5-48bb-be14-d5bff5092e61

请求的唯一标识符

Responses

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

500Internal server error