パラメータ(定期課金/分割払い)
基本動作については別途パラメータ解説ページがあり、左メニューから閲覧可能です。
フィールド名はローワーキャメルケースで記載する必要があります。
HTTP GETメソッドであるため、値を"
(ダブルクォーテーション)で囲む必要はありません。
定期課金
リンクフォームで定期課金登録をする際に、定期課金の挙動を指定するパラメータです。
フィールド 赤字は必須 ※は条件付き必須 | 許容する値 | 備考 | 省略時の値 |
---|---|---|---|
period ※ | 半角英数 | 期課金の間隔 指定可能な値(意味): daily (毎日)weekly (毎週)monthly (毎月)bimonthly (隔月)quarterly (3ヶ月)semiannually (6ヶ月)annually (毎年)※…基本動作で type=subscription 指定なら必須さらに詳細な指定(意味): PxD (x日周期)PxW (x週間周期)PxM (xヶ月周期)PxY (x年周期) | |
subscriptionId | 半角英数 | 継続中の定期課金IDを指定することで、登録されたカード情報を変更data-checkout="token" の指定が必須、data-app-id 以外のパラメータは不要指定可能な値: アプリケーショントークンに紐付いたストアに作成されている定期課金のID | |
initialAmount | 半角数 | 定期課金の初回金額 | |
startIn | 半角英数 | 定期課金の2回目の課金が行われるまでの期間 指定可能な値(意味): PxD (x日後)PxW (x週間後)PxM (xヶ月後)PxY (x年後) | periodに従う |
startDayOfMonth | 半角英数 (1〜31) | 定期課金の2回目の課金が行われる日付startIn との組み合わせも可能例: startDayOfMonth=20 &startIn=P2M 翌月の20日 startIn 未設定の場合は、当月の該当日以前であれば当月にも課金され、 該当日以降であれば翌月の該当日に課金されます | periodに従う |
subscriptionRetryInterval | 半角英数 | 定期課金が失敗したときのリトライ間隔P1D 以上かつ定期課金サイクルより短くないとエラー指定可能な値(意味): PxD (x日)PxW (x週間)PxM (xか月) | 定期課金の周期÷リトライ回数の間隔 (余り切捨) |
terminationMode | 半角英 | 定期課金の停止リクエストを受理したとき、実際に自動課金のステータスをsupended (一時停止)に変更するタイミングメールや webhook の通知も同期するため、定期課金の停止申請後も次回課金日まで会員権利を維持したい場合に利用指定可能な値(意味): immediate (即時)on_next_payment (次回課金日) | immediate |
分割払い
リンクフォームで消費者に分割払いを選択させたい場合に、指定するパラメータです。
フィールド | 許容する値 | 備考 | 省略時の値 |
---|---|---|---|
allowCardInstallments | 真偽(true /false ) | true 指定で、分割払いの回数を選択するドロップダウンメニューを表示クレジットカードが指定または選択され、 checkout=payment かつ、type=subscription 以外を指定し、契約上分割払いが可能な場合のみ有効 | false |