Charge Schedule(定期課金) API

定期課金(Charge schedule)は、Schedule機能の1つで、定期的に課金するために利用できます。 スケジュールの詳細については、 Schedule(スケジュール)API をご覧ください。

注:このAPIの使用は[3DS対応](https://www.omise.co/how-to-implement-3-D-Secure)のアカウントに対して無効になっています。

Attributes

Name Type Description
object string

固定値scheduled_charge

id object_id

/rchg(_test)?_[0-9a-z]+/に一致する定期課金ID。

livemode boolean

本番モード (true) あるいはテストモード(false) の定期課金。

amount integer

smallest currency unit(最小通貨単位)での課金スケジュールの金額。

card object_id

課金される CARD_ID

created_at datetime

ISO 8601 形式 (YYYY-MM-DDThh:mm:ssZ)で定期課金が作成されたUTC日時。

currency currency

3文字の課金スケジュール通貨ISO 4217コード。

customer object_id

課金されるCUSTOMER_ID

default_card boolean

cardcustomerのデフォルトカードかどうか。

description string

課金スケジュールの説明。

metadata object

Custom metadata (e.g. {"answer": 42}) for charge schedule.

Example

  • JSON Response

定期課金を作成

- POST https://api.omise.co/schedules

新規の定期課金オブジェクトを作成し、返ってくる情報を確認します。

Request Parameters

Name Type Description
charge[amount] integer

(必須) smallest currency unit(最小通貨単位)での課金スケジュールの金額。

charge[customer] object_id

(必須) 課金されるCUSTOMER_ID

end_on date

(必須) ISO 8601 形式のスケジュール終了日。

every integer

(必須) スケジュールの実行頻度を表す数値
例:every 3 weeks(3週間毎)。スケジュールの実行頻度をperiodに入力された数値で決定する。 例えば、3に設定し、periodweekに設定した場合、scheduleは3週間ごとに実行される。

period string

(必須) everyに適用する期間。「日」、「週」、または「月」のいずれか。 例えば、weekに設定し、every3に設定した場合、スケジュールは3週間毎に実行される。

on[days_of_month] array

(任意、 場合によって必須) 期間がmonthで、on[weekday_of_month]を設定しない場合に指定する、日付の配列(1から28まで)。29, 30, 31日は存在しない月があるため指定不可(例:[1、15、20])。

on[weekday_of_month] string

(任意、 場合によって必須) 期間がmonthで、on[days_of_month]を設定しない場合に指定する、特定の曜日を表す文字列(例:2nd_mondaylast_friday)。

on[weekdays] array

(任意、 場合によって必須) 期間がweekの場合に指定する、曜日の配列(例:['Monday'、 'Wednesday'])。

charge[card] object_id

(任意) 課金される CARD_ID

charge[currency] currency

(任意) 3文字の課金スケジュール通貨ISO 4217コード。

charge[description] string

(任意) 課金スケジュールの説明。

charge[metadata] object

(任意) Custom metadata (e.g. {"answer": 42}) for charge schedule.

start_on date

(任意) ISO 8601形式のスケジュール開始日。

Example

  • Cardを指定して2日毎に課金

  • 毎週月曜日と金曜日に課金

  • 3ヶ月毎に月内の1日、10日、15日に課金

  • 毎月の第2月曜日に課金

特定の定期課金情報を取得

- GET https://api.omise.co/schedules/{id}

Schedule(スケジュール)APIを参照してください。

定期課金を削除

- DELETE https://api.omise.co/schedules/{id}

Schedule(スケジュール)APIを参照してください。

全ての定期課金リストを取得

- GET https://api.omise.co/charges/schedules

charge_scheduleに属するすべての お客様のアカウントオブジェクトの list を返します。

Request Parameters

Name Type Description
from datetime

(任意, default: 1970-01-01T00:00:00Z) ISO 8601 形式(YYYY-MM-DDThh:mm:ssZ)で返されたレコードの最新のUTC日時。

limit integer

(任意, default: 20, maximum: 100) 返されるレコードの数。

offset integer

(任意, default: 0) 返される最初のレコードのオフセット(先頭からスキップするレコードの数)。

order string

(任意, default: chronological) listのオーダーがchronological (古い順) or reverse_chronological (新しい順)で返されます。エントリがない場合は nullとなります。

to datetime

(任意, default: current UTC datetime) ISO 8601形式 (YYYY-MM-DDThh:mm:ssZ)で返されたレコードの最新のUTC日付と時刻。

Example

  • 全ての定期課金リストを取得

特定の顧客に対する定期課金リストを取得

- GET https://api.omise.co/customers/{id}/schedules

指定したCustomer IDに紐づく定期課金のリストを返します。

Request Parameters

Name Type Description
from datetime

(任意, default: 1970-01-01T00:00:00Z) ISO 8601 形式(YYYY-MM-DDThh:mm:ssZ)で返されたレコードの最新のUTC日時。

limit integer

(任意, default: 20, maximum: 100) 返されるレコードの数。

offset integer

(任意, default: 0) 返される最初のレコードのオフセット(先頭からスキップするレコードの数)。

order string

(任意, default: chronological) listのオーダーがchronological (古い順) or reverse_chronological (新しい順)で返されます。エントリがない場合は nullとなります。

to datetime

(任意, default: current UTC datetime) ISO 8601形式 (YYYY-MM-DDThh:mm:ssZ)で返されたレコードの最新のUTC日付と時刻。

Example

  • 特定の顧客に対する定期課金リストを取得