API Reference
API Reference

获取结账会话列表

查询结账会话列表

Query Params
session_ids
array of strings

结账会话的 id 数组,筛选 id 属于这个数组 checkout session

session_ids
string

checkout session 状态:

  • open: 创建成功
  • expire: 过期
  • complete: 交易完成
string

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

string

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

int32

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

order_ids
array of strings

接入方订单号

order_ids
string

仅返回此客户 ID 指定的客户的结账会话。

string

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

string

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

string

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

string

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

Headers
string
required
Defaults to 008e3967-a1b5-48bb-be14-d5bff5092e61

请求的唯一标识符

Response

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
These developer docs retire on 2026-08-30. Visit the new docs: NEW DOCS本开发者文档将于 2026-08-30下线,请访问新版文档: 新文档