订阅
了解如何使用 Tokenz 订阅 API 销售周期性商品——从在结账时创建订阅,到计费、催收、方案变更和取消的完整流程。
订阅会按照固定的周期(每周、每月或每年)自动创建新订单,并向消费者已保存的支付方式扣款,只要订阅保持有效状态就会持续进行。Tokenz 为您管理完整的计费生命周期:安排续订扣款、重试失败的付款、发送续订提醒,并在每个环节通过 webhook 通知您的后端。
金额格式: amount 等金额字段以每种货币的最小辅助单位表示。有关每种货币的具体编码方式,请参见支持的货币。
注意: 订阅目前仅适用于使用记录商户(Merchant of Record,MOR)模式的商户。
概述
订阅 API 构建在与一次性订单相同的 Checkout Session 基础之上:
- 创建:通过创建包含
subscription字段块的 Checkout Session 来启动订阅。每个订阅只允许包含一个未打折的商品。 - 授权:消费者完成一次卡支付(可带或不带试用期)。此过程同时会获取商户发起交易(MIT)同意,以便后续续订无需消费者再次操作即可扣款。
- 自动扣款:只要订阅处于
active状态,Tokenz 就会在每个计费周期结束时创建新订单并向已保存的卡扣款。 - 管理:消费者可以通过 Tokenz 托管流程更新自己的支付方式,商户可以代表消费者变更方案或取消订阅。
- 响应:您的后端会在每次生命周期转换时收到 webhook(试用开始、激活、续订、未付款、支付方式更新、方案变更、取消、过期)。
核心概念
- 订阅(Subscription):周期性计费的记录,保存价格、计费间隔、试用配置、催收策略、当前计费周期以及消费者的支付方式。
- 计费间隔(Billing interval):订阅续订的频率,由
unit(WEEK、MONTH或YEAR)和count(两次续订之间的单位数)组成。按月和按年续订会在与首次扣款相同的日期进行(若目标月份没有对应日期,则顺延至该月最后一天)。 - 试用期(Trial period):首次扣款前的可选天数(1–365 天)。如果设置了试用期,订阅创建时不会生成初始订单,试用结束时会自动创建首个订单。
- 支付方式同意(Payment method consent):订阅仅支持卡类支付方式。消费者的首次授权(或专门的同意流程)会授权 Tokenz 在后续续订时再次向该卡扣款,而无需每次都进行 3D 验证。
- 催收(Dunning):当续订扣款失败时,在订阅过期之前所采用的重试策略。
- 方案变更(Plan change):更改订阅商品和/或计费间隔的请求,可以立即生效(并按比例分摊费用),也可以延后到下一个计费周期生效。