API Reference
API Reference

业务对象

订阅(Subscription)业务对象字段说明

属性名类型描述
idstring订阅唯一标识
customer_idstringSubotiz 顾客唯一标识
emailstring顾客邮箱
cycle_indexint订阅当前所处周期
metadatamap[string]string元数据
cancel_reasonstring终止订阅的原因
sub_merchant_idstring商户唯一标识
statusstring订阅业务状态:
  • init - 待生效
  • trial - 试用期
  • active - 生效中
  • paused - 已暂停
  • past_due - 逾期
  • unpaid - 未支付
  • canceled - 已终止
  • incomplete - 未完成
price_idstring商品定价方案唯一标识
total_cyclesint总周期数(0表示无限期)
current_period_startstring当前计费周期开始时间
current_period_endstring当前计费周期结束时间
next_invoice_datestring下一次续订时间
created_atstring创建时间
updated_atstring更新时间
cancel_atstring终止订阅时间(可选)
order_idstring接入方订单 id,创建 checkout session 时传入的 order_id 一致。
source_trade_idstring来源交易订单 ID
price_typestring定价模型
price_version_idstring商品定价方案版本唯一标识
first_source_channelstring该结账会话的首次创建来源
last_source_channelstring该结账会话的最后访问来源
fixed_termstring固定期限期数。"0" 表示持续订阅(无固定期限)
is_renewablebool是否支持到期后自动转为持续订阅
end_atstring订阅结束时间。空字符串表示持续订阅(无结束时间)
current_periodint当前周期序号
is_cancelingbool是否正在取消中
launch_cancel_atstring发起取消的时间
expected_cancel_atstring预期取消的时间
These developer docs retire on 2026-08-30. Visit the new docs: NEW DOCS本开发者文档将于 2026-08-30下线,请访问新版文档: 新文档