Schedule API

The Schedule API allows you to 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	Charge schedule object.
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	Transfer schedule object.

Example

JSON Response

{
  "object": "schedule",
  "id": "schd_test_5fvso6f485njpzpajzd",
  "livemode": false,
  "deleted": false,
  "location": "/schedules/schd_test_5fvso6f485njpzpajzd",
  "created_at": "2019-05-13T04:37:09Z",
  "status": "active",
  "every": 2,
  "period": "day",
  "on": {
  },
  "in_words": "Every 2 day(s)",
  "start_on": "2019-11-01",
  "end_on": "2020-11-01",
  "transfer": {
    "object": "scheduled_transfer",
    "id": "rtrf_test_5fvso6f2uwhjjapj276",
    "livemode": false,
    "created_at": "2019-05-13T04:37:09Z",
    "recipient": "recp_test_5fvso4xvu87s4vf6cs7",
    "amount": null,
    "percentage_of_balance": 100,
    "currency": "THB"
  },
  "occurrences": {
    "object": "list",
    "from": "1970-01-01T00:00:00Z",
    "to": "2019-05-13T04:37:09Z",
    "offset": 0,
    "limit": 20,
    "total": 0,
    "order": "chronological",
    "location": "/schedules/schd_test_5fvso6f485njpzpajzd/occurrences",
    "data": [

    ]
  },
  "next_occurrences_on": [
    "2019-11-01",
    "2019-11-03",
    "2019-11-05",
    "2019-11-07",
    "2019-11-09",
    "2019-11-11",
    "2019-11-13",
    "2019-11-15",
    "2019-11-17",
    "2019-11-19",
    "2019-11-21",
    "2019-11-23",
    "2019-11-25",
    "2019-11-27",
    "2019-11-29",
    "2019-12-01",
    "2019-12-03",
    "2019-12-05",
    "2019-12-07",
    "2019-12-09",
    "2019-12-11",
    "2019-12-13",
    "2019-12-15",
    "2019-12-17",
    "2019-12-19",
    "2019-12-21",
    "2019-12-23",
    "2019-12-25",
    "2019-12-27",
    "2019-12-29"
  ]
}

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

curl
ruby
python
php
C#
node.js
java
go
elixir

curl https://api.omise.co/schedules \
  -u $OMISE_SECRET_KEY:

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}");

omise.schedules.retrieve(function(error, schedules) {
    /* Response. */
});

var schds omise.ScheduleList
list := operations.ListSchedules{
	List: operations.List{
		Limit: 100,
		From: time.Now().Add(-1 * time.Hour),
	},
}

if e := client.Do(&schds, &list); e != nil {
	panic(e)
}

fmt.Println("# of schedules made in the last hour:", len(schds.Data))

Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.Schedule.list

Create a schedule

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

Creates and returns a new schedule. See the specific 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

curl
ruby
python
php
C#
node.js
java
go
elixir

curl https://api.omise.co/schedules/schd_test_5g022yhk1zcvkf7zbt7 \
  -u $OMISE_SECRET_KEY:

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}");

omise.schedules.retrieve('schd_test_4xsjvylia03ur542vn6', 
  function(error, schedule) {
      /* Response. */
  });

var schd omise.Schedule
if e := client.Do(&schd, &operations.RetrieveSchedule{ScheduleID: "schd_test_4xsjvylia03ur542vn6"}); e != nil {
	panic(e)
}

fmt.Printf("schedule #schd_57z9hj228pusa652nk1: %#v\n", schd)

Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.Schedule.retrieve("schd_test_4xsjvylia03ur542vn6")

Destroy a schedule

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

Destroys the schedule matching :id.

Example

Destroy a schedule

curl
ruby
python
php
C#
node.js
java
go
elixir

curl https://api.omise.co/schedules/schd_test_5g022yhk1zcvkf7zbt7 \
  -X DELETE \
  -u $OMISE_SECRET_KEY:

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})");

omise.schedules.destroy('schd_test_584yqgiuavbzrfng7mv', 
  function(error, schedule) {
      /* Response. */
  });

var deletedSchd omise.Schedule
if e := client.Do(&deletedSchd, &operations.DestroySchedule{ScheduleID: "schd_test_4xsjvylia03ur542vn6"}); e != nil {
	panic(e)
}

fmt.Println("destroyed schedule:", deletedSchd.ID)

Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.Schedule.destroy("schd_test_4xsjvylia03ur542vn6")