Schedule(スケジュール)API

スケジュールAPIを利用することで、定期的に発生する予定のイベントをスケジュールとして事前に設定することができます。例えば、特定の顧客に対して毎月課金を作成したり,毎週月曜日に残高を指定の口座に振り込む等の設定を行うことができます。

Attributes

Name Type Description
object string

固定値schedule

id string

/schd(_test)?_[0-9a-z]+/に一致するSCHEDULE_ID

livemode boolean

本番モード (true) あるいはテストモード(false) スケジュール。

location string

現在のscheduleオブジェクトを取得するためのAPIパス。

active boolean

スケジュールのステータスが running(実行中)か expiring(期限切れ)か。

charge charge_schedule

Charge schedule object(定期課金)。

created_at string

ISO 8601 形式 (YYYY-MM-DDThh:mm:ssZ)でスケジュールが作成されたUTC日時。

deleted boolean

スケジュールが削除されたかどうか。

end_on string

ISO 8601 形式のスケジュール終了日。

ended_at string

ISO 8601形式 (YYYY-MM-DDThh:mm:ssZ)でのスケジュールが実際に完了したUTC日時。

every integer

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

in_words string

スケジュールを英文で表した文字列。(例:Every 2 months on the 15thEvery 3 daysEvery week on monday and friday)。

next_occurrences_on array

ISO 8601形式で示される最大30までのオカレンス予定日。 有効期限切れ、中断、または削除されたスケジュールの場合は空白となります。

occurrences list

occurrence(オカレンス)オブジェクト list(リスト)。

on object

スケジュールを指定するオブジェクト。

period string

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

start_on string

ISO 8601形式のスケジュール開始日。

status string

定期処理の状態を表す文字列

  • running:Scheduleがアクティブ
  • expiring:次回のOccurence(実行予定日)がスケジュールされた最後の実行日
  • expired:予定された全てのOccurence(実行予定日)での実行が完了
  • deleted:削除済のSchedule
  • suspended:Scheduleは未完了だが、停止中

transfer transfer_schedule

Transfer schedule object(送金スケジュールオブジェクト)。

Example

  • JSON Response

スケジュールを作成

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

Creates and returns a new schedule.

Request Parameters

Name Type Description
end_date string

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

every integer

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

period string

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

start_date string

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

charge object

(任意、 場合によって必須) Charge schedule object(定期課金)。

on object

(任意) スケジュールを指定するオブジェクト。

transfer object

(任意、 場合によって必須) Transfer schedule object(送金スケジュールオブジェクト)。

Example

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

  • 2日ごとに定額を送金する

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

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

  • 毎月第2月曜日に残高全体を送金する

  • 3ヶ月毎、1日、10日、15日に残高全体を送金する

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

  • 残高割合を毎週月曜日と金曜日に送金する

スケジュールを削除

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

Schedule IDで指定された特定のスケジュールが返り、そのデータは削除されます。

Example

  • スケジュールを削除

全てのスケジュールのリストを取得

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

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

Request Parameters

Name Type Description
from string

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

limit integer

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

offset integer

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

order string

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

to string

(任意) 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 string

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

limit integer

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

offset integer

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

order string

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

to string

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

Example

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

特定の受信者のすべての送金スケジュールを一覧表示する

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

scheduleオブジェクトのlistを返します。 特定の受信者に属するすべての送金スケジュールを返します。

Request Parameters

Name Type Description
from string

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

limit integer

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

offset integer

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

order string

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

to string

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

Example

  • 追加振込先口座のすべての送金スケジュールを一覧表示する。

List transfer schedules

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

Returns a list of transfer schedules

Request Parameters

Name Type Description
from string

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

limit integer

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

offset integer

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

order string

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

to string

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

スケジュールを取得

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

Schedule IDで指定された特定のスケジュールを返します。

Example

  • スケジュールを取得

Omiseは、お客様のウェブサイト全般における利便性を向上するためにクッキーを利用し、お客様のアクセス、閲覧履歴に関する情報を収集します。 当社のウェブサイトを閲覧し続けることにより、お客様は当社のプライバシーポリシーに同意することとします。 詳細はこちら