Skip to main content
GET
获取商品定价列表
定价方案列表

授权

Authorization
string
header
必填

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

请求头

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

请求的唯一标识符

查询参数

price_ids
string[]

定价ID 集合检索,集合大小限制[0,100]

status
string

定价状态

  • draft - 草稿
  • active - 激活
  • frozen - 冻结
starting_after
string

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

ending_before
string

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

limit
integer<int32>

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

product_id
string

通过商品ID查询定价

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

price_type
string

按价格结构过滤,取值之一:flat_price | package_price | tiers_price(存量只读可含 based_on_usage)

payment_timing
string

按付费时机过滤,取值之一:prepaid | postpaid

billing_dimension
string

按计费维度过滤,取值之一:quantity | usage | mixed

billing_cycle_unit
string[]

按计费周期单位精确过滤(多值取并集),支持的枚举值:

  • day - 天
  • week - 周
  • month - 月
  • quarter - 季
  • year - 年
  • custom - 自定义(每 N 单位)
  • customer-initiated - 客户发起
  • over_threshold - 按量计费 精确匹配,不做 day ↔ custom/day/1 语义展开。
merchant_price_ids
string[]

按商户侧定价 ID 反查,多值 OR。已归档定价的该字段被清空,不可反查

billing_type
string

按收费方式过滤:

  • one_time:单次付费
  • recurring:周期性订阅 不传则不过滤,返回全部收费方式的定价。

响应

200 - application/json

OK

code
string

error code

message
string

error message

data
object