Charge Schedule(定期課金) API

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

注:このAPIの使用は3DS対応のアカウントに対して無効になっています。

Attribute

Name Type Description
amount integer

指定された通貨において最小単位、かつ正の整数で表される金額。(例:100サターンは1タイバーツ) サポート通過コード一覧

card card

Card ID、空欄の場合はデフォルトカードに課金される。

currency string

小文字3桁の国際識別コードで、ISO 4217規格 によって定義された通貨(サポート通貨コード一覧)。

customer object_id

Customer ID。

description string

解読可能なcharge scheduleの説明。

Example

  • Json Response

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

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

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

Request Parameter

Name Type Description
offset integer

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

limit integer

(optional, default: 20, maximum: 100) 返されたレコード数。

from datetime

(optional, default: 1970-01-01T00:00:00Z) ISO 8601 形式の返されたレコードの最初のUTC日付と時刻(YYYY-MM-DDThh:mm:ssZ)。

to datetime

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

order string

(optional, default: chronological) chronological(最初のものから最新のもの)または reverse_chronological (最新のものから最初のもの)のリストのオーダーが返されます。

Example

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

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

- GET https://api.omise.co/customers/CUSTOMER_ID/schedules

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

Request Parameter

Name Type Description
offset integer

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

limit integer

(optional, default: 20, maximum: 100) 返されたレコード数。

from datetime

(optional, default: 1970-01-01T00:00:00Z) ISO 8601 形式の返されたレコードの最初のUTC日付と時刻(YYYY-MM-DDThh:mm:ssZ)。

to datetime

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

order string

(optional, default: chronological) chronological(最初のものから最新のもの)または reverse_chronological (最新のものから最初のもの)のリストのオーダーが返されます。

Example

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

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

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

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

定期課金を作成

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

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

Request Parameter

Name Type Description
every integer

スケジュールの実行間隔を表す数値
例:every 3 weeks(3週間毎)。

period string

課金周期を表す文字列:dayweekまたはmonth

on on

periodがdayの場合:{}

periodがweekの場合:{ weekdays: [''Monday'', ''Wednesday''] }

periodがmonthの場合:
 (例1) 日付指定:{ days_of_month: [1, 15, 20] }
 (例2) 曜日指定:{ weekday_of_month: 'second_monday' }

start_date date

(オプション)ISO 8601形式のスケジュール開始日(YYYY-MM-DD)、 省略すると作成した日付が設定される。

end_date date

ISO 8601形式のスケジュール終了日(YYYY-MM-DD)。

charge charge_schedule

amount:金額
currency:通貨を表す文字列
customer:Customer IDを指定
card:(オプション) 省略するとCustomerのデフォルトカードで課金、Customerオブジェクトに紐づくCardのCard IDを指定すると指定したCardで課金。

Example

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

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

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

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

定期課金を削除

- DELETE https://api.omise.co/schedules/SCHEDULE_ID

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