サブスクリプション
Tokenz サブスクリプション API を使って継続課金商品を販売する方法を学びましょう — チェックアウトでのサブスクリプション作成から、課金、督促、プラン変更、解約までを解説します。
サブスクリプションは、サブスクリプションが有効である限り、一定の間隔(週次・月次・年次)で自動的に新しい注文を作成し、消費者が保存した支払い方法に対して課金します。Tokenz は、更新課金のスケジューリング、失敗した支払いの再試行、更新リマインダーの送信、各ステップでの Webhook によるバックエンドへの通知など、課金ライフサイクル全体を管理します。
金額の形式: amount などの金額項目は、各通貨の最小補助単位で表されます。通貨ごとの正確なエンコーディングについては 対応通貨 をご覧ください。
注: サブスクリプションは現在、Merchant of Record(MOR)モデルを利用する加盟店のみが利用できます。
概要
サブスクリプション API は、単発注文で使用されるのと同じ Checkout Session の仕組みの上に構築されています。
- 作成:
subscriptionブロックを含む Checkout Session を作成してサブスクリプションを開始します。サブスクリプションには、値引きのない単一の商品のみを設定できます。 - 認証:消費者がカード決済を完了します(トライアル期間の有無を問いません)。この際、加盟店起因取引(MIT)の同意も取得され、以降の更新時に消費者の操作なしで課金できるようになります。
- 自動課金:サブスクリプションが
activeである限り、Tokenz は各請求期間の終了時に新しい注文を作成し、保存済みのカードに課金します。 - 管理:消費者は Tokenz がホストするフローを通じて支払い方法を更新でき、加盟店は消費者に代わってプランの変更やサブスクリプションの解約を行えます。
- 通知:バックエンドは、あらゆるライフサイクルの遷移(トライアル開始、有効化、更新、未払い、支払い方法の更新、プラン変更、解約、失効)について Webhook を受け取ります。
主な概念
- サブスクリプション:継続課金の記録です。価格、請求間隔、トライアル設定、督促戦略、現在の請求期間、消費者の支払い方法を保持します。
- 請求間隔:サブスクリプションが更新される頻度。
unit(WEEK、MONTH、またはYEAR)とcount(更新間隔の単位数)で表します。月次・年次の更新は、最初の課金と同じ日(該当する日がない月の場合はその月の末日)に行われます。 - トライアル期間:最初の課金までの任意の日数(1〜365日)です。設定されている場合、サブスクリプションは初期注文なしで作成され、トライアル終了時に最初の注文が自動的に作成されます。
- 支払い方法の同意:サブスクリプションはカード支払い方法のみをサポートします。消費者の最初の認証(または専用の同意フロー)により、Tokenz は毎回の 3D セキュア認証なしで更新時にカードへ再度課金する権限を得ます。
- 督促(ダニング):更新の課金が失敗した際に、サブスクリプションが失効する前に使用される再試行戦略です。
- プラン変更:サブスクリプションの商品や請求間隔を変更するリクエストです。即時(日割り計算あり)または次回の請求期間への繰り延べのいずれかで適用されます。
このガイドの内容
- ライフサイクルと請求 — ステータス、請求期間、トライアル、督促、解約、更新リマインダーについて詳しく解説
- サブスクリプションの連携 — サブスクリプションのチェックアウトを作成し、有効化し、更新をトリガーする
- 決済方法と同意 — MIT 同意の仕組みと、消費者によるカード更新の方法
- Webhook — サンプルペイロード付きの完全なイベントカタログ