訂閱
了解如何使用 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):變更訂閱商品和/或計費間隔的請求,可以立即生效(並按比例分攤費用),也可以延後到下一個計費週期生效。