定期課金: Create

このリクエストでは、アプリトークン・シークレット・事前に作成されたトランザクションIDを指定することで、顧客の個人情報・決済に関する情報を呼び出して定期課金を作成することができます。
Parameterを指定して様々な種類の定期課金が作成可能です。

Request

POST https://api.univapay.com/subscriptions

Parameters:

Parameters
transaction_token_idstring (UUID) [必須]
トランザクショントークンのID。定期課金を有効にする必要があります。
amountnumber [必須]
課金額
currencystring (ISO-4217) [必須]
ISO-4217形式の通貨
initial_amountnumber
定期的な金額と異なる場合は、初回に請求する金額
periodstring[必須]※
定期課金が請求される頻度。 daily, weekly, biweekly, monthly, quarterly, semiannually, annually のいずれか
このフィールドが入力されている場合、cyclical_periodは利用できません。
※cyclical_periodを利用しない場合、このフィールドは必須です
cyclical_periodstring (ISO-8601 Duration)[必須]※
課金を行う詳細な頻度、1日間以上で設定します。
例:P3D,P2M,P2Mなど
このフィールドが入力されている場合、periodは利用できません。
※periodを利用しない場合、このフィールドは必須です
schedule_settings.start_onstring (ISO-8601)
以降のすべての支払いがで開始される日付(年月日形式)。時間はzone_idで宣言されたタイムゾーンの午前9時に固定されています。
schedule_settings.zone_idstring (IANAタイムゾーン)
定期課金が請求されるタイムゾーン
例:Asia/Tokyo
schedule_settings.preserve_end_of_monthboolean
periodmonthlyで、指定されたstart_onの日付が月末日である場合、このオプションを使用すると、以降は月の最終日に料金を請求できます。例えば、start_on2018-06-30の場合、次の請求はtrueの場合は2018-07-31falseの場合は2018-07-30となります。
schedule_settings.termination_modestring
immediate, on_next_payment のいずれか。

指定がない場合のデフォルトは immediate です。
この定期課金の停止リクエストが送信されたとき、
値が immediate の場合、定期課金は即座に停止または終了しますが、on_next_payment の場合は、次回課金日の直前に停止または終了します。
installment_plan.plan_typestring
revolving, fixed_cycles のいずれか

installment_planを指定した定期課金は全てクレジットカード会社による分割になります。
installment_plan.fixed_cyclesnumber
plan_typefixed_cyclesの場合、このフィールドは必須です。クレジットカード会社での分割払の回数を指定します。
指定可能な値は3, 5, 6, 10, 12, 15, 18, 20, 24
※上記以外の回数はエラーになります。
installment_plan.fixed_cycle_amount※5/11に仕様変更がありこのパラメータは利用不可になりました。
subscription_plan.plan_typestring
回数指定の定期課金を行う場合、fixed_cyclesfixed_cycle_amountのいずれかを指定します。
subscription_plan.fixed_cyclesnumber
subscription_plan.plan_type が fixed_cycles の場合、このフィールドは必須です。定期課金を行う回数を指定します。
subscription_plan.fixed_cycle_amountnumber
subscription_plan.plan_type が fixed_cycle_amount の場合、このフィールドは必須です。定期課金の1回当たりの支払い金額を指定します。
schedule_settings.retry_intervalstring (ISO-8601 Duration)
定期課金の支払いが失敗したときにリトライを行う間隔を指定します。
例: P5D…失敗後5日毎にリトライ
※指定する間隔は1日以上かつ定期課金のサイクルよりも短い必要があります。
metadatajson
定期課金に紐づけられたメタデータ

Headers:

Content-Type: application/json
Authorization: Bearer {secret}.{jwt}

Body:

curl --request POST \
--url https://api.univapay.com/subscriptions \
--header 'Authorization: Bearer {secret}.{jwt}' \
--header 'content-type: application/json' \
--data '{
  "transaction_token_id": "a6025e32-18e3-11e7-8fc4-17c907a37445",
  "amount": 1250,
  "currency": "USD",
  "period": "daily",
  "metadata":{
      "ServiceId": 78435694
  }
}'

Response

Code: 201

Headers:

Content-Type: application/json

Body:

{
  "id": "aaadee6a-18e3-11e7-a461-e3b078a7dc52",
  "store_id": "37ff5664-18c6-11e7-8221-ff4914d76afc",
  "amount": 1250,
  "currency": "USD",
  "amount_formatted": 12.5,
  "period": "daily",
  "status": "unverified",
  "metadata": {
    "ServiceId": 78435694
  },
  "mode": "test",
  "created_on": "2018-14-13T02:44:00.07367Z"
}