跳转到主要内容
GET
获取发票列表
查询发票列表

授权

Authorization
string
header
必填

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

请求头

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

请求的唯一标识符

查询参数

invoice_ids
string[]

发票ID数组,筛选发票ID属于该数组的发票

trade_ids
string[]

交易单ID数组,筛选发票的交易单ID属于该数组的发票

order_ids
string[]

订单ID数组,筛选发票订单ID属于该数组的发票

subscription_id
string

订阅ID,筛选此订阅ID关联的发票

customer_id
string

顾客ID,筛选此顾客ID关联的发票

biz_status
string[]

发票状态数组,筛选发票状态属于该数组的发票

  • open: 初始化
  • pending: 处理中
  • retrying: 等待重试
  • success: 支付成功
  • failed: 支付失败
  • refunded: 全额退款
  • partially_refunded: 部分退款
invoice_types
string[]

发票类型数组,筛选发票类型属于该数组的发票

  • initial: 首次支付
  • trial: 试用期
  • renewal: 订阅续订
  • refund: 退款
starting_after
string

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

ending_before
string

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

limit
integer<int32>

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

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

响应

200 - application/json

OK

code
string

error code

message
string

error message

data
object