Schedule API

Create, retrieve, and delete schedules. Schedules are charges or transfers that occur at regular intervals, for example, a monthly membership fee or a weekly transfer. Actual schedule dates are accessed via the occurrence API.

Attributes

Name Type Description
object string

The string schedule.

id object_id

The schedule identifier matching /schd(_test)?_[0-9a-z]+/.

livemode boolean

Whether this is a live (true) or test (false) schedule.

location string

API path to retrieve the current schedule object.

active boolean

Whether schedule is status running or expiring.

charge charge_schedule
created_at datetime

UTC datetime of schedule creation in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

deleted boolean

Whether schedule is deleted.

end_on date

End date of schedule in ISO 8601 format.

ended_at datetime

Actual end date of schedule in ISO 8601 format.

every integer

How often schedule should run when applied to period. For example, if set to 3 and period is set to week, schedule should run every 3 weeks.

in_words string

Schedule expressed as an English sentence. E.g.: Every 2 months on the 15th, Every 3 days, Every week on monday and friday.

next_occurrences_on array

Up to 30 upcoming occurrence dates in ISO 8601 format. Empty in case of expired, suspended or deleted schedule.

occurrences list

List of occurrence objects.

on on

Object specifying schedule timing.

period string

Period to use for every. One of day, week or month. For example, if set to week and every is set to 3 schedule should run every 3 weeks.

start_on date

Start date of schedule in ISO 8601 format.

status string

One of:

  • running: 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.
.

transfer transfer_schedule

Example

  • JSON Response

Create a schedule

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

Creates and returns a new schedule. See the documentation page for charge schedules or transfer schedules.

Retrieve a schedule

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

Returns the schedule matching :id.

Example

  • Retrieve a schedule

Destroy a schedule

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

Destroys the schedule matching :id.

Example

  • Destroy a schedule

List schedules

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

Returns a list of schedules belonging to your account.

Request Parameters

Name Type Description
from datetime

(optional, default: 1970-01-01T00:00:00Z) Earliest UTC datetime for returned records in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

limit integer

(optional, default: 20, maximum: 100) Number of records returned.

offset integer

(optional, default: 0) Offset of the first record returned (i.e. how many records to skip from the beginning).

order string

(optional, default: chronological) Order of records returned. One of chronological (earliest to latest) or reverse_chronological (latest to earliest).

to datetime

(optional, default: current UTC datetime) Latest UTC datetime for returned records in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

Example

  • List all schedules