定期課金: Create

Request

POST https://api.gyro-n.money/subscriptions

Parameters:

Parameters
transaction_token_idstring (UUID) [必須]
トランザクショントークンのID。定期課金を有効にする必要があります。
amountnumber [必須]
課金額
currencystring (ISO-4217) [必須]
ISO-4217形式の通貨
initial_amountnumber
定期的な金額と異なる場合は、初回に請求する金額
periodstring
定期課金が請求される頻度。 daily, weekly, biweekly, monthly, annually のいずれか
schedule_settings.start_onstring (ISO-8601)
以降のすべての支払いがで開始される日付(年月日形式)。時間はzone_idで宣言されたタイムゾーンの午前9時に固定されています。
schedule_settings.zone_idstring (IANAタイムゾーン)
定期課金が請求されるタイムゾーン
schedule_settings.preserve_end_of_monthboolean
periodmonthlyで、指定されたstart_onの日付が月末日である場合、このオプションを使用すると、以降は月の最終日に料金を請求できます。例えば、start_on2018-06-30の場合、次の請求はtrueの場合は2018-07-31falseの場合は2018-07-30となります。
installment_plan.plan_typestring
revolving, fixed_cycles, fixed_cycle_amount のいずれか
installment_plan.fixed_cyclesnumber
plan_typefixed_cyclesの場合、このフィールドは必須です。分割払いでの回数を指定します。
installment_plan.fixed_cycle_amountnumber
plan_typefixed_cycle_amountの場合、このフィールドは必須です。 分割払いで、1回ごとの金額を指定します。
metadatajson
定期課金に紐づけられたメタデータ

Headers:

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

Body:

curl --request POST \
--url https://api.gyro-n.money/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": 1491275175825
}