Schedule API

Schedules allow you to plan events at regular intervals in the future. For example, you can charge a customer every month or transfer your balance to your account every Monday.

Attribute

Name	Type	Description
object	string	The string `schedule`.
id	object_id	The `SCHEDULE_ID`.
livemode	boolean	Whether this is a live (`true`) or test (`false`) schedule.
location	string	Path to retrieve the schedule.
status	string	One of: `active`: The schedule is running. `expiring`: The schedule's next occurrence is its last. `expired`: The schedule has reached its last occurrence and is not running anymore. `deleted`: The schedule has been deleted and is not running anymore. `suspended`: The schedule could not be completed and was stopped.
every	integer	How often the schedule runs. E.g.: Every `3` weeks.
period	string	`day`, `week` or `month`. E.g.: Every 3 `week`s
on[weekdays]	Array	Only for the `week` period. An array of weekday names. E.g.: `['Monday', 'Wednesday']`.
on[days_of_month]	Array	Only for `month` period when `on[weekday_of_month]` is omitted. An array of days of month numbers (1..28). Please note that 29, 30 and 31 are not supported as not all months have these. E.g.: `[1, 15, 20]`
on[weekday_of_month]	string	Only for `month` period when `on[days_of_month]` is omitted. An ordinalized weekday. E.g.: `2nd_monday`, `last_friday`
in_words	string	The schedule, in english. E.g.: `Every 2 months on the 15th`, `Every 3 days`, `Every week on monday and friday`
start_date	Date	The start date of the schedule in ISO 8601 format
end_date	Date	The end date of the schedule in ISO 8601 format
charge	Hash	Only in case of charge schedules: `amount`: The amount to charge at regular interval `currency`: The currency to be used for said charge `description`: The description that is applied to all charges created by this schedule. `customer`: The customer uid to be charged `card`: The card uid to be charged. Empty in case the default card is charged.
transfer	Hash	Only in case of transfer schedules: `recipient`: The recipient uid to transfer to. `amount`: The amount to transfer at regular interval. Null if `percentage_of_balance` is present. `currency`: The currency to be used for the transfers `percentage_of_balance`: How many percent of the transferable balance are transfered. Null if `amount` is present.
occurrences	list	A list of occurrence objects.
next_occurrence_dates	Array	An array of up to 30 upcoming occurrence dates in ISO 8601 format. Returns an empty array in case of expired, suspended or deleted schedule.
created	datetime	Creation date of the schedule in ISO 8601 format.

List all schedules

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

Returns a list of schedule objects.

Returns all schedules that belongs to your account. You can learn more about lists in the pagination documentation. Please note that this endpoint returns both charge and transfer schedules.

Example

List all schedules

curl
ruby
python
php
C#
node.js
java
go

curl -X GET https://api.omise.co/schedules \
  -u skey_test_4xsjvwfnvb2g0l81sjz:

require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

schedules = Omise::Schedule.list

import omise

omise.api_secret = 'skey_test_4xs8breq3htbkj03d2x'

schedule = omise.Schedule.retrieve()

<?php

require './omise-php/lib/Omise.php';

define('OMISE_SECRET_KEY', 'skey_test_51fl8dfabe7sqnj8th2');

$schedules = OmiseSchedule::retrieve();

var schedules = await Client.Schedules.GetList(order: Ordering.ReverseChronological);
Console.WriteLine($"total schedules: {schedules.Total}");

Create a schedule

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

See the specific documentation page for charge schedules.

Retrieve a schedule

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

Returns an existing schedule object

Example

Retrieve a schedule

curl
ruby
python
php
C#
node.js
java
go

curl https://api.omise.co/schedules/schd_test_4xsjvylia03ur542vn6 \
  -u skey_test_4xs8breq3htbkj03d2x:

require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

schedule = Omise::Schedule.retrieve("schd_test_4xsjvylia03ur542vn6")

import omise

omise.api_secret = 'skey_test_4xs8breq3htbkj03d2x'

schedule = omise.Schedule.retrieve('schd_test_5851n56mg0rg90gvphj')

<?php

require './omise-php/lib/Omise.php';

define('OMISE_SECRET_KEY', 'skey_test_51fl8dfabe7sqnj8th2');

$schedule = OmiseSchedule::retrieve('schd_test_58et0oz1hmczg8foppb');

var scheduleId = "schd_test_58fmj4fpu2zpp2m8s8c";
var schedule = await Client.Schedules.Get(scheduleId);
Console.WriteLine($"charges made on schedule: {schedule.Occurrences.Total}");

Destroy a schedule

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

Destroys and returns an existing schedule object

Example

Destroy a schedule

curl
ruby
python
php
C#
node.js
java
go

curl https://api.omise.co/schedules/schd_test_4xtrb759599jsxlhkrb \
  -X DELETE \
  -u skey_test_4xsjvwfnvb2g0l81sjz:

require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

schedule = Omise::Schedule.retrieve("schd_test_4xsjvylia03ur542vn6")
schedule.destroy
schedule.destroyed? # => true

import omise

omise.api_secret = 'skey_test_4xs8breq3htbkj03d2x'

schedule = omise.Schedule.retrieve('schedule_test_5851n56mg0rg90gvphj')

schedule.destroy()

schedule.destroyed  # => true

<?php

require './omise-php/lib/Omise.php';

define('OMISE_SECRET_KEY', 'skey_test_51fl8dfabe7sqnj8th2');

$schedule = OmiseSchedule::retrieve('schd_test_58et0oz1hmczg8foppb');
$schedule->destroy();

var schedule = RetrieveSchedule();
schedule = await Client.Schedules.Destroy(schedule.Id);
Console.WriteLine($"disabled schedule: {schedule.Id} ({schedule.Deleted})");