Schedule(スケジュール)API

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

Attribute

Name Type Description
object string

オブジェクト名、このJSONレスポンスがScheduleオブジェクトであることを示す schedule

id object_id

ScheduleのID、一意なオブジェクトを示す文字列。

livemode boolean

本番モード (true) あるいはテストモード(false) schedule。

location string

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

charge charge_schedule

スケジュールされた課金の情報。Charge Schedule(定期課金) の場合のみ

  • amount:金額
  • currency:通貨
  • description: ここで設定される説明情報は、このスケジュールに従って作成される課金オブジェクトにも設定されます
  • customer:Customer ID
  • card:Card ID、空欄の場合はデフォルトカードに課金される

created datetime

ISO 8601 形式(YYYY-MM-DDThh:mm:ssZ)でschedule作成の協定世界時(UTC)。

deleted boolean

scheduleが削除されたかどうか。

end_date date

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

every integer

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

in_words string

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

next_occurrence_dates array

予定された向こう30件までのOccurenceの日付の配列、ISO 8601形式。statusがactive以外であれば空の配列が返る。

occurrences list

Occurrence オブジェクトのリスト。

on on

スケジュールのタイミングを表現するobject。

period string

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

start_date date

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

status string

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

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

transfer transfer_schedule

スケジュールされた振込の情報。Charge Transfer(定期振込) の場合のみ

  • recipient: 送金先のRecipient ID
  • amount: 定期的に送金する金額、percentage_of_balance 指定の場合はnull
  • currency: 通貨
  • percentage_of_balance: 送金可能金額のうち、送金したい割合の数値(%)、amount指定の場合はnull

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

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

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

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

スケジュールを作成

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

Charge Schedule(定期課金) APIをご覧ください。

スケジュールを取得

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

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

Example

  • スケジュールを取得

スケジュールを削除

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

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

Example

  • スケジュールを削除