定期課金: Create

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

Request

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

Parameters:

Parameters
transaction_token_id	string (UUID) [必須] トランザクショントークンのID。定期課金を有効にする必要があります。
amount	number [必須] 課金額
currency	string (ISO-4217) [必須] ISO-4217形式の通貨
initial_amount	number 定期的な金額と異なる場合は、初回に請求する金額
period	string[必須]※ 定期課金が請求される頻度。 `daily`, `weekly`, `biweekly`, `monthly`, `quarterly`, `semiannually`, `annually` のいずれかこのフィールドが入力されている場合、cyclical_periodは利用できません。分割払いの場合は、`monthly`を指定する必要があります。 ※cyclical_periodを利用しない場合、このフィールドは必須です
cyclical_period	string (ISO-8601 Duration)[必須]※ 課金を行う詳細な頻度、1日間以上で設定します。例:P3D,P2M,P2Mなどこのフィールドが入力されている場合、`period`は利用できません。 ※periodを利用しない場合、このフィールドは必須です
schedule_settings.start_on	string (ISO-8601) 以降のすべての支払いがで開始される日付（`年月日形式`）。時間は`zone_id`で宣言されたタイムゾーンの午前7時に固定されています。
schedule_settings.zone_id	string (IANAタイムゾーン) 定期課金が請求されるタイムゾーン例:Asia/Tokyo
schedule_settings.preserve_end_of_month	boolean `period`が`monthly`で、指定された`start_on`の日付が月末日である場合、このオプションを使用すると、以降は月の最終日に料金を請求できます。例えば、`start_on`が`2018-06-30`の場合、次の請求は`true`の場合は`2018-07-31`、`false`の場合は`2018-07-30`となります。
schedule_settings.termination_mode	string `immediate`, `on_next_payment` のいずれか。指定がない場合のデフォルトは `immediate` です。この定期課金の停止リクエストが送信されたとき、値が `immediate` の場合、定期課金は即座に停止または終了しますが、`on_next_payment` の場合は、次回課金日の直前に停止または終了します。
installment_plan.plan_type	string `revolving`, `fixed_cycles` のいずれか `installment_plan`を指定した定期課金は全てクレジットカード会社による分割払いになります。 `revolving` を指定した場合はリボ払い、`fixed_cycles` を指定した場合は`installment_plan.fixed_cycles` で指定した回数の分割払いになります。
installment_plan.fixed_cycles	number `plan_type`が`fixed_cycles`の場合、このフィールドは必須です。クレジットカード会社での分割払いの回数を指定します。指定可能な値：3, 5, 6, 10, 12, 15, 18, 20, 24 ※上記以外の回数はエラーになります。
first_charge_authorization_only	boolean 初回決済時に行う処理を指定します。オーソリ（仮売上）のみ行う場合は`true`、キャプチャ（実売上）を行う場合は`false`を指定してください。指定がない場合のデフォルトは`false`です。
first_charge_capture_after	string (ISO-8601 Duration) `first_charge_authorization_only`が`true`の場合、このパラメーターによって自動でキャプチャを行う日を指定できます。指定可能な日数：1,2,3,4,5,6 ※上記以外の回数はエラーになります。例：3日後を指定する場合 `first_charge_capture_after:"P3D"`
subscription_plan.plan_type	string 回数指定の定期課金を行う場合、`fixed_cycles`, `fixed_cycle_amount`のいずれかを指定します。
subscription_plan.fixed_cycles	number `subscription_plan.plan_type` が `fixed_cycles` の場合、このフィールドは必須です。定期課金を行う回数を指定します。
subscription_plan.fixed_cycle_amount	number `subscription_plan.plan_type` が `fixed_cycle_amount` の場合、このフィールドは必須です。定期課金の1回当たりの支払い金額を指定します。
schedule_settings.retry_interval	string (ISO-8601 Duration) 定期課金の支払いが失敗したときにリトライを行う間隔を指定します。例: P5D…失敗後5日毎にリトライ ※指定する間隔は1日以上かつ定期課金のサイクルよりも短い必要があります。
metadata	json 定期課金に紐づけられたメタデータ

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"
}

定期課金: Create

Request

Parameters:

Headers:

Body:

Response

Code: 201

Headers:

Body:

Code: `201`