パラメータ（定期課金）

ウィジェットで定期課金登録をする際に、定期課金の挙動を指定するパラメータです。

基本動作、分割払い、デザインについては別途パラメータ解説ページがあり、左メニューから閲覧可能です。（デザイン用パラメータは、「ウィジェットの設置」ページに記載）

フィールド名について

• data-で始まる、ケバブケース（kebab-case）で記載のフィールド名はHTML用
• 2行目にローワーキャメルケース（lowerCamelCase）で記載のフィールド名はJavaScript用
• いずれかしか記載のないものは、いずれかのみで利用可能

フィールド 赤字は必須 ※は条件付き必須	許容する値	備考	省略時の値
data-subscription-period subscriptionPeriod ※	半角英	定期課金の間隔 指定可能な値（意味）： daily（毎日） weekly（毎週） biweekly（隔週） monthly（毎月） bimonthly（隔月） quarterly（3ヶ月） semiannually（6ヶ月） annually（毎年） ※…基本動作でdata-token-type="subscription"指定なら必須 さらに詳細な指定（意味）： PxD（x日周期） PxW（x週間周期） PxM（xヶ月周期） PxY（x年周期） インラインフォームで利用可
data-subscription-id subscriptionId	半角英数	継続中の定期課金IDを指定することで、登録されたカード情報を変更 data-checkout="token"の指定が必須、data-app-id以外のパラメータは不要 必須: いいえ 指定可能な値: アプリケーショントークンに紐付いたストアに作成されている定期課金のID インラインフォームで利用可
data-subscription-plan subscriptionPlan	半角英	「回数指定型」の定期課金を指定する際に必要 指定可能な値（意味）： fixed_cycles（指定した回数に達するまで） fixed_cycle_amount（指定した金額に達するまで） fixed_cycle_amount指定で端数が出た場合、最終回は端数のみ課金 インラインフォームで利用可
data-subscription-qty subscriptionQty ※	半角数	data-subscription-plan="fixed_cycles"なら、支払の回数（初回課金を含む） data-subscription-plan="fixed_cycle_amount"なら、課金ごとの金額 ※…data-subscription-planでいずれかの値を指定すると必須 インラインフォームで利用可
data-subscription-initial-amount subscriptionInitialAmount	半角数	定期課金の、初回金額 0指定で初回は「カード登録のみ」実行（セキュリティコード認証の併用必須） インラインフォームで利用可	基本動作のdata-amountで指定した額
data-subscription-start subscriptionStart	半角数ハイフン区切り YYYY-MM-DD	作成された定期課金の２回目の課金を行う日付 インラインフォームで利用可
data-subscription-start-in subscriptionStartIn	半角英数	定期課金の2回目の課金が行われるまでの期間 指定可能な値（意味）： PxD（x日後） PxW（x週間後） PxM（xか月後） PxY（x年後） インラインフォームで利用可	data-subscription-periodに従う
data-subscription-start-day-of-month subscriptionStartDayOfMonth	半角英数 （1〜31）	定期課金の2回目の課金を行う日付 data-subscription-start-in/startInとの組み合わせも可能 例： startDayOfMonth=20&startIn=P2M 翌々月（2か月後）の20日 startIn未設定の場合は、当月の該当日以前であれば当月にも課金され、該当日以降であれば翌月の該当日に課金されます インラインフォームで利用可	data-subscription-periodに従う
data-subscription-preserve-end-of-month subscriptionPreserveEndOfMonth	真偽（true/false）	trueで、かつ、開始日に月の末日を指定した場合、以降の課金日を末日に固定する 例： 開始日が2018-06-30の場合、次の請求はtrueの場合は2018-07-31 falseの場合は2018-07-30となります。 ※periodが月単位時のみ有効 インラインフォームで利用可	false
data-subscription-retry-interval subscriptionRetryInterval	半角英数	定期課金が失敗したときのリトライ間隔 ISO 8601 duration 形式で記述 P1D以上かつ定期課金サイクルより短くないとエラー 指定可能な値（意味）： PxD（x日） PxW（x週間） PxM（xか月） インラインフォームで利用可	定期課金の周期÷リトライ回数の間隔 （余り切捨）