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	string	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	string	UTC datetime of schedule creation in ISO 8601 format (`YYYY-MM-DDThh:mm:ssZ`).
deleted	boolean	Whether schedule is deleted.
end_on	string	End date of schedule in ISO 8601 format.
ended_at	string	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	object	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	string	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_no1t4tnemucod0e51mo",
  "deleted": false,
  "livemode": false,
  "location": "/schedules/schd_test_no1t4tnemucod0e51mo",
  "every": 2,
  "occurrences": {
    "object": "list",
    "data": [],
    "limit": 20,
    "offset": 0,
    "total": 0,
    "location": "/schedules/schd_test_no1t4tnemucod0e51mo/occurrences",
    "order": "chronological",
    "from": "1970-01-01T00:00:00Z",
    "to": "2019-12-31T12:59:59Z"
  },
  "on": {},
  "in_words": "Every 2 day(s)",
  "period": "day",
  "status": "running",
  "active": true,
  "charge": {
    "object": "scheduled_charge",
    "id": "rchg_test_no1t4tnemucod0e51mo",
    "livemode": false,
    "currency": "THB",
    "amount": 12345,
    "default_card": true,
    "card": "card_test_no1t4tnemucod0e51mo",
    "customer": "cust_test_no1t4tnemucod0e51mo",
    "description": null,
    "metadata": {},
    "created_at": "2019-12-31T12:59:59Z"
  },
  "next_occurrences_on": [
    "2021-11-01",
    "2021-11-03",
    "2021-11-05",
    "2021-11-07",
    "2021-11-09",
    "2021-11-11",
    "2021-11-13",
    "2021-11-15",
    "2021-11-17",
    "2021-11-19",
    "2021-11-21",
    "2021-11-23",
    "2021-11-25",
    "2021-11-27",
    "2021-11-29",
    "2021-12-01",
    "2021-12-03",
    "2021-12-05",
    "2021-12-07",
    "2021-12-09",
    "2021-12-11",
    "2021-12-13",
    "2021-12-15",
    "2021-12-17",
    "2021-12-19",
    "2021-12-21",
    "2021-12-23",
    "2021-12-25",
    "2021-12-27",
    "2021-12-29"
  ],
  "ended_at": null,
  "start_on": "2021-11-01",
  "end_on": "2022-11-01",
  "created_at": "2019-12-31T12:59:59Z"
}

Create a schedule

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

Creates and returns a new schedule.

Request Parameters

Name	Type	Description
end_date	string	(required) End date of schedule in ISO 8601 format.
every	integer	(required) 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.
period	string	(required, one of: `day`, `week`, `month`) 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_date	string	(required) Start date of schedule in ISO 8601 format.
charge	object	(optional, but conditionally required) Charge schedule object. Use when creating a charge schedule.
on	object	(optional) Object specifying schedule timing.
transfer	object	(optional, but conditionally required) Transfer schedule object. Use when creating a transfer schedule.

Example

Charge a specific customer every 2 days

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

curl https://api.omise.co/schedules \
  -u $OMISE_SECRET_KEY: \
  -d "every=2" \
  -d "period=day" \
  -d "start_date=2022-01-01" \
  -d "end_date=2022-12-31" \
  -d "charge[customer]=cust_test_5g0221fe8iwtayocgja" \
  -d "charge[card]=card_test_5g021zls9ei5suyryss" \
  -d "charge[amount]=100000" \
  -d "charge[description]=Membership fee"

<?php

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

define('OMISE_SECRET_KEY', 'skey_test_51fl8dfabe7sqnj8th2');

$scheduler = OmiseCharge::schedule(array(
    'customer'    => 'cust_test_58e7b94d2wfmfn6p2x1',
    'card'        => 'card_test_58eeofcdwl5clmhtyf0',
    'amount'      => 100000,
    'description' => 'Membership fee'
));

$schedule = $scheduler->every(2)
                      ->days()
                      ->startDate('2017-09-17')
                      ->endDate('2018-09-17')
                      ->start();

omise.schedules.create({
    'every': 2,
    'period': 'day',
    'start_date': '2017-05-01',
    'end_date': '2018-05-01',
    'charge': {
        'customer': 'cust_test_57m2wcnfx96k634rkqq',
        'card': 'card_test_57m2w8iemdovs4f92m2',
        'amount': 100000,
        'description': 'Membership fee'
    }
}, function(error, schedule) {
    /* Response. */
});

require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

scheduler = Omise::Charge.schedule({
  customer:    "cust_test_57m2wcnfx96k634rkqq",
  card:        "card_test_57m2w8iemdovs4f92m2",
  amount:      100000,
  description: "Membership fee"
})

schedule = scheduler.every(2).days
  .start_date("2017-05-01")
  .end_date("2018-05-01")
  .start

var schedule = await Client.Schedules.Create(new CreateScheduleRequest
{
    Every = 2,
    Period = SchedulePeriod.Day,
    StartDate = DateTime.Now,
    EndDate = DateTime.Now.AddYears(2),
    On = new ScheduleOnRequest
    {
        Weekdays = new[] { Weekdays.Monday }
    },
    Charge = new ChargeScheduling
    {
        Amount = 2000,
        Currency = "thb",
        Customer = "cust_test_59gbtlbjldnc8651pmp",
    }
});

Console.WriteLine($"created schedule: {schedule.Id}");

Schedule schedule = client.schedules()
  .create(new Schedule.Create()
    .every(2)
    .period(SchedulePeriod.day)
    .startDate(new DateTime(DateTime.parse("2017-05-01")))
    .endDate(new DateTime(DateTime.parse("2018-05-01")))
    .charge(new ChargeScheduling.Params()
      .customer("cust_test_57m2wcnfx96k634rkqq")
      .card("card_test_57m2w8iemdovs4f92m2")
      .amount(100000)
      .description("Membership fee")
    ));
System.out.printf("created charge schedule: %s", schedule.getId());

import omise

omise.api_secret = "skey_test_no1t4tnemucod0e51mo"

schedule = omise.Schedule.create(
    every=2,
    period="day",
    start_date="2021-05-01",
    end_date="2022-05-01",
    charge={
        "customer": "cust_test_no1t4tnemucod0e51mo",
        "card": "card_test_no1t4tnemucod0e51mo",
        "amount": 100000,
        "description": "Membership fee",
    },
)

var schd omise.Schedule
create := operations.CreateChargeSchedule{
	Every:       2,
	Period:      schedule.PeriodDay,
	StartDate:   "2017-05-01",
	EndDate:     "2018-05-01",
	Customer:    "cust_test_57m2wcnfx96k634rkqq",
	Amount:      100000,
	Description: "Membership fee",
}

if e := client.Do(&schd, &create); e != nil {
	log.Fatalln(e)
}

log.Println("created schedule: %#v\n", schd)

Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.Schedule.create(
  every:      2,
  period:     "day",
  start_date: "2017-05-01",
  end_date:   "2018-05-01",
  charge: [
    customer:    "cust_test_57m2wcnfx96k634rkqq",
    card:        "card_test_57m2w8iemdovs4f92m2",
    amount:      100000,
    description: "Membership fee",
  ]
)

Transfer a fixed amount every 2 days

curl
php
C#
go
elixir

curl https://api.omise.co/schedules \
  -u $OMISE_SECRET_KEY: \
  -d "every=2" \
  -d "period=day" \
  -d "start_date=2022-01-01" \
  -d "end_date=2022-12-31" \
  -d "transfer[recipient]=recp_test_5g03h1x1mbpgxp8h1fh" \
  -d "transfer[amount]=1000000"

<?php

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

define('OMISE_SECRET_KEY', 'skey_test_51fl8dfabe7sqnj8th2');

$scheduler = OmiseTransfer::schedule(array(
    'recipient' => 'recp_test_586lkjci7y1h3a0uce3',
    'amount'    => 1000000
));

$schedule  = $scheduler->every(2)
                       ->days()
                       ->startDate('2017-09-17')
                       ->endDate('2018-09-17')
                       ->start();

var recipient = RetrieveRecipient();
var schedule = await Client.Schedules.Create(new CreateScheduleRequest
{
    Every = 2,
    Period = SchedulePeriod.Day,
    StartDate = DateTime.Now,
    EndDate = DateTime.Now.AddYears(2),
    Transfer = new TransferScheduling
    {
        Amount = 200000,
        Recipient = recipient.Id,
    }
});

Console.WriteLine($"created schedule: {schedule.Id}");

var schd omise.Schedule
create = operations.CreateTransferSchedule{
	Every:     2,
	Period:    schedule.PeriodDay,
	StartDate: "2017-05-01",
	EndDate:   "2018-05-01",
	Recipient: "recp_test_57m2wcnfx96k634rkqq",
	Amount:    1000000,
}

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

fmt.Println("Create a daily fixed amount transfer schedule:", schd.ID)

Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.Schedule.create(
  every:      2,
  period:     "day",
  start_date: "2017-05-01",
  end_date:   "2018-05-01",
  transfer: [
    recipient: "recp_test_57m2wcnfx96k634rkqq",
    amount:     1000000,
  ]
)

Charge on the 1st, 10th and 15th every 3 months

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

curl https://api.omise.co/schedules \
  -u $OMISE_SECRET_KEY: \
  -d "every=3" \
  -d "period=month" \
  -d "on[days_of_month][]=1" \
  -d "on[days_of_month][]=10" \
  -d "on[days_of_month][]=15" \
  -d "start_date=2022-01-01" \
  -d "end_date=2022-12-31" \
  -d "charge[customer]=cust_test_5g0221fe8iwtayocgja" \
  -d "charge[amount]=100000" \
  -d "charge[description]=Membership fee"

<?php

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

define('OMISE_SECRET_KEY', 'skey_test_51fl8dfabe7sqnj8th2');

$scheduler = OmiseCharge::schedule(array(
    'customer'    => 'cust_test_58e7b94d2wfmfn6p2x1',
    'card'        => 'card_test_58eeofcdwl5clmhtyf0',
    'amount'      => 100000,
    'description' => 'Membership fee'
));

$schedule = $scheduler->every(3)
                      ->months(array(1, 10, 15))
                      ->startDate('2017-09-17')
                      ->endDate('2018-09-17')
                      ->start();

omise.schedules.create({
    'every': 3,
    'period': 'month',
    'on': {
        'days_of_month': [1,10,15]
    },
    'start_date': '2017-05-01',
    'end_date': '2018-05-01',
    'charge': {
        'customer': 'cust_test_57m2wcnfx96k634rkqq',
        'amount': 100000,
        'description': 'Membership fee'
    }
}, function(error, schedule) {
    /* Response. */
});

require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

scheduler = Omise::Charge.schedule({
  customer:    "cust_test_57m2wcnfx96k634rkqq",
  card:        "card_test_57m2w8iemdovs4f92m2",
  amount:      100000,
  description: "Membership fee"
})

schedule = scheduler.every(3).months(on: [1, 10, 15])
  .start_date("2017-05-01")
  .end_date("2018-05-01")
  .start

var schedule = await Client.Schedules.Create(new CreateScheduleRequest
{
    Every = 3,
    Period = SchedulePeriod.Month,
    StartDate = DateTime.Now,
    EndDate = DateTime.Now.AddYears(2),
    On = new ScheduleOnRequest
    {
        DaysOfMonth = new[] { 1, 10, 15 }
    },
    Charge = new ChargeScheduling
    {
        Amount = 2000,
        Currency = "thb",
        Customer = "cust_test_59gbtlbjldnc8651pmp",
    }
});

Console.WriteLine($"created schedule: {schedule.Id}");

Schedule schedule = client.schedules()
  .create(new Schedule.Create()
    .every(3)
    .period(SchedulePeriod.month)
    .on(new ScheduleOn.Params()
      .daysOfMonth(1,10,15))
    .startDate(new DateTime(DateTime.parse("2017-05-01")))
    .endDate(new DateTime(DateTime.parse("2018-05-01")))
    .charge(new ChargeScheduling.Params()
      .customer("cust_test_57m2wcnfx96k634rkqq")
      .amount(100000)
      .description("Membership fee")
    ));
System.out.printf("created charge schedule: %s", schedule.getId());

import omise

omise.api_secret = "skey_test_no1t4tnemucod0e51mo"

schedule = omise.Schedule.create(
    every=3,
    period="month",
    on={"days_of_month": [1, 10, 15]},
    start_date="2021-05-01",
    end_date="2022-05-01",
    charge={
        "customer": "cust_test_no1t4tnemucod0e51mo",
        "card": "card_test_no1t4tnemucod0e51mo",
        "amount": 100000,
        "description": "Membership fee",
    },
)

var schd omise.Schedule
create := operations.CreateChargeSchedule{
	Every:       3,
	Period:      schedule.PeriodMonth,
	DaysOfMonth: schedule.DaysOfMonth{1, 10, 15},
	StartDate:   "2017-05-01",
	EndDate:     "2018-05-01",
	Customer:    "cust_test_57m2wcnfx96k634rkqq",
	Amount:      100000,
	Description: "Membership fee"
}

if e := client.Do(&schd, &create); e != nil {
	log.Fatalln(e)
}

log.Println("created schedule: %#v\n", schd)

Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.Schedule.create(
  every:      3,
  period:     "month",
  on:         [days_of_month: [1, 10, 15]],
  start_date: "2017-05-01",
  end_date:   "2018-05-01",
  charge: [
    customer:    "cust_test_57m2wcnfx96k634rkqq",
    card:        "card_test_57m2w8iemdovs4f92m2",
    amount:      100000,
    description: "Membership fee",
  ]
)

Charge on the second Monday every month

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

curl https://api.omise.co/schedules \
  -u $OMISE_SECRET_KEY: \
  -d "every=1" \
  -d "period=month" \
  -d "on[weekday_of_month]=2nd_monday" \
  -d "start_date=2022-01-01" \
  -d "end_date=2022-12-31" \
  -d "charge[customer]=cust_test_5g0221fe8iwtayocgja" \
  -d "charge[amount]=100000" \
  -d "charge[description]=Membership fee"

<?php

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

define('OMISE_SECRET_KEY', 'skey_test_51fl8dfabe7sqnj8th2');

$scheduler = OmiseCharge::schedule(array(
    'customer'    => 'cust_test_58e7b94d2wfmfn6p2x1',
    'card'        => 'card_test_58eeofcdwl5clmhtyf0',
    'amount'      => 100000,
    'description' => 'Membership fee'
));

$schedule = $scheduler->every(1)
                      ->months('2nd_monday')
                      ->startDate('2017-09-17')
                      ->endDate('2018-09-17')
                      ->start();

omise.schedules.create({
    'every': 1,
    'period': 'month',
    'on': {
        'weekday_of_month': '2nd_monday'
    },
    'start_date': '2017-05-01',
    'end_date': '2018-05-01',
    'charge': {
        'customer': 'cust_test_57m2wcnfx96k634rkqq',
        'amount': 100000,
        'description': 'Membership fee'
    }
}, function(error, schedule) {
    /* Response. */
});

require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

scheduler = Omise::Charge.schedule({
  customer:    "cust_test_57m2wcnfx96k634rkqq",
  card:        "card_test_57m2w8iemdovs4f92m2",
  amount:      100000,
  description: "Membership fee"
})

schedule = scheduler.every(1).month(on: "2nd_monday")
  .start_date("2017-05-01")
  .end_date("2018-05-01")
  .start

var schedule = await Client.Schedules.Create(new CreateScheduleRequest
{
    Every = 1,
    Period = SchedulePeriod.Month,
    StartDate = DateTime.Now,
    EndDate = DateTime.Now.AddYears(2),
    On = new ScheduleOnRequest
    {
        WeekdayOfMonth = "2nd_monday"
    },
    Charge = new ChargeScheduling
    {
        Amount = 2000,
        Currency = "thb",
        Customer = "cust_test_59gbtlbjldnc8651pmp",
    }
});

Console.WriteLine($"created schedule: {schedule.Id}");

Schedule schedule = client.schedules()
  .create(new Schedule.Create()
    .every(1)
    .period(SchedulePeriod.month)
    .on(new ScheduleOn.Params()
      .weekdayOfMonth("2nd_monday"))
    .startDate(new DateTime(DateTime.parse("2017-05-01")))
    .endDate(new DateTime(DateTime.parse("2018-05-01")))
    .charge(new ChargeScheduling.Params()
      .customer("cust_test_57m2wcnfx96k634rkqq")
      .amount(100000)
      .description("Membership fee")
    ));
System.out.printf("created charge schedule: %s", schedule.getId());

import omise

omise.api_secret = "skey_test_no1t4tnemucod0e51mo"

schedule = omise.Schedule.create(
    every=1,
    period="month",
    on={"weekday_of_month": "2nd_monday"},
    start_date="2021-05-01",
    end_date="2022-05-01",
    charge={
        "customer": "cust_test_no1t4tnemucod0e51mo",
        "card": "card_test_no1t4tnemucod0e51mo",
        "amount": 100000,
        "description": "Membership fee",
    },
)

var schd omise.Schedule
create := operations.CreateChargeSchedule{
	Every:          1,
	Period:         schedule.PeriodMonth,
	WeekdayOfMonth: "2nd_monday",
	StartDate:      "2017-05-01",
	EndDate:        "2018-05-01",
	Customer:       "cust_test_57m2wcnfx96k634rkqq",
	Amount:         100000,
	Description:    "Membership fee",
}

if e := client.Do(&schd, &create); e != nil {
	log.Fatalln(e)
}

log.Println("created schedule: %#v\n", schd)

Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.Schedule.create(
  every:      1,
  period:     "month",
  on:         [weekday_of_month: "2nd_monday"],
  start_date: "2017-05-01",
  end_date:   "2018-05-01",
  charge: [
    customer:    "cust_test_57m2wcnfx96k634rkqq",
    card:        "card_test_57m2w8iemdovs4f92m2",
    amount:      100000,
    description: "Membership fee",
  ]
)

Transfer the whole balance on the second Monday every month

curl
php
C#
go
elixir

curl https://api.omise.co/schedules \
  -u $OMISE_SECRET_KEY: \
  -d "every=1" \
  -d "period=month" \
  -d "on[weekday_of_month]=2nd_monday" \
  -d "start_date=2022-01-01" \
  -d "end_date=2022-12-31" \
  -d "transfer[recipient]=recp_test_5g03h1x1mbpgxp8h1fh"

<?php

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

define('OMISE_SECRET_KEY', 'skey_test_51fl8dfabe7sqnj8th2');

$scheduler = OmiseTransfer::schedule(array(
    'recipient' => 'recp_test_586lkjci7y1h3a0uce3'
));

$schedule  = $scheduler->every(1)
                       ->months('2nd_monday')
                       ->startDate('2017-09-17')
                       ->endDate('2018-09-17')
                       ->start();

var recipient = RetrieveRecipient();
var schedule = await Client.Schedules.Create(new CreateScheduleRequest
{
    Every = 1,
    Period = SchedulePeriod.Month,
    StartDate = DateTime.Now,
    EndDate = DateTime.Now.AddYears(2),
    On = new ScheduleOnRequest
    {
        WeekdayOfMonth = "2nd_monday"
    },
    Transfer = new TransferScheduling
    {
        Recipient = recipient.Id,
    },
});

Console.WriteLine($"created schedule: {schedule.Id}");

var schd omise.Schedule
create = operations.CreateTransferSchedule{
	Every:          1,
	Period:         schedule.PeriodMonth,
	WeekdayOfMonth: "2nd_monday",
	StartDate:      "2017-05-01",
	EndDate:        "2018-05-01",
	Recipient:      "recp_test_57m2wcnfx96k634rkqq",
}

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

fmt.Println("created schedule:", schd.ID)

Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.Schedule.create(
  every:      1,
  period:     "month",
  on:         [weekday_of_month: "2nd_monday"],
  start_date: "2017-05-01",
  end_date:   "2018-05-01",
  transfer: [
    recipient: "recp_test_57m2wcnfx96k634rkqq",
  ]
)

Transfer the whole balance on the 1st, 10th and 15th every 3 months

curl
php
C#
go
elixir

curl https://api.omise.co/schedules \
  -u $OMISE_SECRET_KEY: \
  -d "every=3" \
  -d "period=month" \
  -d "on[days_of_month][]=1" \
  -d "on[days_of_month][]=10" \
  -d "on[days_of_month][]=15" \
  -d "start_date=2022-01-01" \
  -d "end_date=2022-12-31" \
  -d "transfer[recipient]=recp_test_5g03h1x1mbpgxp8h1fh"

<?php

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

define('OMISE_SECRET_KEY', 'skey_test_51fl8dfabe7sqnj8th2');

$scheduler = OmiseTransfer::schedule(array(
    'recipient' => 'recp_test_586lkjci7y1h3a0uce3'
));

$schedule  = $scheduler->every(3)
                       ->months(array(1, 10, 15))
                       ->startDate('2017-09-17')
                       ->endDate('2018-09-17')
                       ->start();

var recipient = RetrieveRecipient();
var schedule = await Client.Schedules.Create(new CreateScheduleRequest
{
    Every = 3,
    Period = SchedulePeriod.Month,
    StartDate = DateTime.Now,
    EndDate = DateTime.Now.AddYears(2),
    On = new ScheduleOnRequest
    {
        DaysOfMonth = new[] { 1, 10, 15 }
    },
    Transfer = new TransferScheduling
    {
        Recipient = recipient.Id,
    }
});

Console.WriteLine($"created schedule: {schedule.Id}");

var schd omise.Schedule
create = operations.CreateTransferSchedule{
	Every:       3,
	Period:      schedule.PeriodMonth,
	DaysOfMonth: schedule.DaysOfMonth{1, 10, 15},
	StartDate:  "2017-05-01",
	EndDate:    "2018-05-01",
	Recipient:  "recp_test_57m2wcnfx96k634rkqq",
}

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

fmt.Println("Create a monthly transfer schedule of your whole balance:", schd.ID)

Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.Schedule.create(
  every:      3,
  period:     "month",
  on:         [days_of_month: [1, 10, 15]],
  start_date: "2017-05-01",
  end_date:   "2018-05-01",
  transfer: [
    recipient: "recp_test_57m2wcnfx96k634rkqq",
  ]
)

Charge every Monday and Friday

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

curl https://api.omise.co/schedules \
  -u $OMISE_SECRET_KEY: \
  -d "every=1" \
  -d "period=week" \
  -d "on[weekdays][]=monday" \
  -d "on[weekdays][]=friday" \
  -d "start_date=2022-01-01" \
  -d "end_date=2022-12-31" \
  -d "charge[customer]=cust_test_5g0221fe8iwtayocgja" \
  -d "charge[amount]=100000" \
  -d "charge[description]=Membership fee"

<?php

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

define('OMISE_SECRET_KEY', 'skey_test_51fl8dfabe7sqnj8th2');

$scheduler = OmiseCharge::schedule(array(
    'customer'    => 'cust_test_58e7b94d2wfmfn6p2x1',
    'card'        => 'card_test_58eeofcdwl5clmhtyf0',
    'amount'      => 100000,
    'description' => 'Membership fee'
));

$schedule = $scheduler->every(1)
                      ->weeks(array('monday', 'friday'))
                      ->startDate('2017-09-17')
                      ->endDate('2018-09-17')
                      ->start();

omise.schedules.create({
    'every': 1,
    'period': 'week',
    'on': {
        'weekdays': ['monday', 'friday']
    },
    'start_date': '2017-05-01',
    'end_date': '2018-04-01',
    'charge': {
        'customer': 'cust_test_57m2wcnfx96k634rkqq',
        'amount': 100000,
        'description': 'Membership fee'
    }
}, function(error, schedule) {
    /* Response. */
});

require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

scheduler = Omise::Charge.schedule({
  customer:    "cust_test_57m2wcnfx96k634rkqq",
  card:        "card_test_57m2w8iemdovs4f92m2",
  amount:      100000,
  description: "Membership fee"
})

schedule = scheduler.every(1).week(on: ["monday", "friday"])
  .start_date("2017-05-01")
  .end_date("2018-05-01")
  .start

var schedule = await Client.Schedules.Create(new CreateScheduleRequest
{
    Every = 1,
    Period = SchedulePeriod.Week,
    StartDate = DateTime.Now,
    EndDate = DateTime.Now.AddYears(2),
    On = new ScheduleOnRequest
    {
        Weekdays = new[] { Weekdays.Monday, Weekdays.Friday }
    },
    Charge = new ChargeScheduling
    {
        Amount = 2000,
        Currency = "thb",
        Customer = "cust_test_59gbtlbjldnc8651pmp",
    }
});

Console.WriteLine($"created schedule: {schedule.Id}");

Schedule schedule = client.schedules()
  .create(new Schedule.Create()
    .every(1)
    .period(SchedulePeriod.week)
    .on(new ScheduleOn.Params()
      .weekdays(Weekdays.Monday, Weekdays.Friday))
    .startDate(new DateTime(DateTime.parse("2017-05-01")))
    .endDate(new DateTime(DateTime.parse("2018-04-01")))
    .charge(new ChargeScheduling.Params()
      .customer("cust_test_57m2wcnfx96k634rkqq")
      .amount(100000)
      .description("Membership fee")
    ));
System.out.printf("created charge schedule: %s", schedule.getId());

import omise

omise.api_secret = "skey_test_no1t4tnemucod0e51mo"

schedule = omise.Schedule.create(
    every=1,
    period="week",
    on={"weekdays": ["monday", "friday"]},
    start_date="2021-05-01",
    end_date="2022-05-01",
    charge={
        "customer": "cust_test_no1t4tnemucod0e51mo",
        "card": "card_test_no1t4tnemucod0e51mo",
        "amount": 100000,
        "description": "Membership fee",
    },
)

var schd omise.Schedule
create := operations.CreateChargeSchedule{
	Every:       1,
	Period:      schedule.PeriodWeek
	Weekdays:    schedule.Weekdays{
		schedule.Monday,
		schedule.Friday,
	},
	StartDate:   "2017-05-01",
	EndDate:     "2018-05-01",
	Customer:    "cust_test_57m2wcnfx96k634rkqq",
	Amount:      100000,
	Description: "Membership fee",
}

if e := client.Do(&schd, &create); e != nil {
	log.Fatalln(e)
}

log.Println("created schedule: %#v\n", schd)

Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.Schedule.create(
  every:      1,
  period:     "week",
  on:         [weekdays: ["monday", "friday"]],
  start_date: "2017-05-01",
  end_date:   "2018-05-01",
  charge: [
    customer:    "cust_test_57m2wcnfx96k634rkqq",
    card:        "card_test_57m2w8iemdovs4f92m2",
    amount:      100000,
    description: "Membership fee",
  ]
)

Transfer a percentage of the balance every Monday and Friday

curl
php
C#
go
elixir

curl https://api.omise.co/schedules \
  -u $OMISE_SECRET_KEY: \
  -d "every=1" \
  -d "period=week" \
  -d "on[weekdays][]=monday" \
  -d "on[weekdays][]=friday" \
  -d "start_date=2022-01-01" \
  -d "end_date=2022-12-31" \
  -d "transfer[recipient]=recp_test_5g03h1x1mbpgxp8h1fh" \
  -d "transfer[percentage_of_balance]=75"

<?php

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

define('OMISE_SECRET_KEY', 'skey_test_51fl8dfabe7sqnj8th2');

$scheduler = OmiseTransfer::schedule(array(
    'recipient'             => 'recp_test_586lkjci7y1h3a0uce3',
    'percentage_of_balance' => 75
));

$schedule  = $scheduler->every(1)
                       ->weeks(array('monday', 'friday'))
                       ->startDate('2017-09-17')
                       ->endDate('2018-09-17')
                       ->start();

var recipient = RetrieveRecipient();
var schedule = await Client.Schedules.Create(new CreateScheduleRequest
{
    Every = 1,
    Period = SchedulePeriod.Week,
    StartDate = DateTime.Now,
    EndDate = DateTime.Now.AddYears(2),
    On = new ScheduleOnRequest
    {
        Weekdays = new[] { Weekdays.Monday, Weekdays.Friday }
    },
    Transfer = new TransferScheduling
    {
        PercentageOfBalance = 75.0f,
        Recipient = recipient.Id,
    }
});

Console.WriteLine($"created schedule: {schedule.Id}");

var schd omise.Schedule
create = operations.CreateTransferSchedule{
	Every:  1,
	Period: schedule.PeriodWeek,
	Weekdays: schedule.Weekdays{
		schedule.Monday,
		schedule.Friday,
	},
	StartDate: "2017-05-01",
	EndDate:   "2018-04-01",

	Recipient:           "recp_test_57m2wcnfx96k634rkqq",
	PercentageOfBalance: 75,
}

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

fmt.Println("Create a weekly partial transfer schedule:", schd.ID)

Omise.configure(secret_key: "skey_test_4xs8breq3htbkj03d2x")

Omise.Schedule.create(
  every:      1,
  period:     "week",
  on:         [weekdays: ["monday", "friday"]],
  start_date: "2017-05-01",
  end_date:   "2018-05-01",
  transfer: [
    recipient: "recp_test_57m2wcnfx96k634rkqq",
    percentage_of_balance: 75,
  ]
)

Destroy a schedule

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

Destroys the schedule matching :id.

Example

Destroy a schedule

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

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

<?php

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

define('OMISE_SECRET_KEY', 'skey_test_51fl8dfabe7sqnj8th2');

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

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

require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

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

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

Request<Schedule> request =
        new Schedule.DeleteRequestBuilder("schd_test_57s33hm9fg1pzcqihxs").build();
Schedule schedule = client().sendRequest(request);

System.out.printf("Destroyed schedule: %s", schedule.getId());

import omise

omise.api_secret = "skey_test_no1t4tnemucod0e51mo"

schedule = omise.Schedule.retrieve("schd_test_no1t4tnemucod0e51mo")

schedule.destroy()

schedule.destroyed  # => true

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

List schedules

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

Returns a list of charge and transfer schedules belonging to your account.

Request Parameters

Name	Type	Description
from	string	(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`) 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`, one of: `chronological`, `reverse_chronological`) Order of records returned.
to	string	(optional) Latest UTC datetime for returned records in ISO 8601 format (`YYYY-MM-DDThh:mm:ssZ`).

Example

List all schedules

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

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

<?php

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

define('OMISE_SECRET_KEY', 'skey_test_51fl8dfabe7sqnj8th2');

$schedules = OmiseSchedule::retrieve();

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

require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

schedules = Omise::Schedule.list

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

Request<ScopedList<Schedule>> request = new Schedule.ListRequestBuilder().build();
ScopedList<Schedule> schedules = client().sendRequest(request);

System.out.printf("Total no. of schedules: %d", schedules.getTotal());

import omise

omise.api_secret = "skey_test_no1t4tnemucod0e51mo"

schedule = omise.Schedule.retrieve()

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

List charge schedules for customer

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

Returns a list of schedules belonging to customer matching :id.

Request Parameters

Name	Type	Description
from	string	(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`) 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`, one of: `chronological`, `reverse_chronological`) Order of records returned.
to	string	(optional) Latest UTC datetime for returned records in ISO 8601 format (`YYYY-MM-DDThh:mm:ssZ`).

Example

List all charge schedules for a customer

curl
php
node.js
ruby
C#
python
go
elixir

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

<?php

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

define('OMISE_SECRET_KEY', 'skey_test_51fl8dfabe7sqnj8th2');

$customer  = OmiseCustomer::retrieve('cust_test_58e7b94d2wfmfn6p2x1');
$schedules = $customer->schedules();

omise.customers.schedules('cust_test_4xsj4ndi9w22nod68', function(error, schedules){
    /* Response. */
});

require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

customer  = Omise::Customer.retrieve("cust_test_4xtrb759599jsxlhkrb")
schedules = customer.schedules

var customerId = "cust_test_59gbtlbjldnc8651pmp";
var schedules = await Client
    .Customer(customerId)
    .Schedules
    .GetList(order: Ordering.ReverseChronological);

Console.WriteLine($"total schedule for customer: {schedules.Total}");

import omise

omise.api_secret = "skey_test_no1t4tnemucod0e51mo"

customer = omise.Customer.retrieve("cust_test_no1t4tnemucod0e51mo")

schedule = customer.schedule()

var schds omise.ScheduleList
list := operations.ListCustomerChargeSchedules{
	CustomerID: "cust_test_4xsj4ndi9w22nod68"
	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.Customer.list_schedules("cust_test_4xtrb759599jsxlhkrb")

List transfer schedules for recipient

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

Returns a list of transfer schedules belonging to recipient matching :id.

Request Parameters

Name	Type	Description
from	string	(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`) 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`, one of: `chronological`, `reverse_chronological`) Order of records returned.
to	string	(optional) Latest UTC datetime for returned records in ISO 8601 format (`YYYY-MM-DDThh:mm:ssZ`).

Example

List all transfer schedules for recipient

curl
php
C#
go
elixir

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

<?php

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

define('OMISE_SECRET_KEY', 'skey_test_51fl8dfabe7sqnj8th2');

$recipient = OmiseRecipient::retrieve('recp_test_546s722se0adnqfenew');
$schedules = $recipient->schedules();

var recipientId = "recp_test_58fkcajowtvy3pax0ak";
var schedules = await Client
    .Recipient(recipientId)
    .Schedules
    .GetList(order: Ordering.ReverseChronological);

Console.WriteLine($"transfer schedule for recipients: {schedules.Total}");

var schds omise.ScheduleList
list := operations.ListRecipientTransferSchedules{
	RecipientID: "recp_test_4xsj4ndi9w22nod68"
	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.Recipient.list_schedules("recp_test_4xsj4ndi9w22nod68")

List transfer schedules

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

Returns a list of transfer schedules

Request Parameters

Name	Type	Description
from	string	(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`) 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`, one of: `chronological`, `reverse_chronological`) Order of records returned.
to	string	(optional) Latest UTC datetime for returned records in ISO 8601 format (`YYYY-MM-DDThh:mm:ssZ`).

Retrieve a schedule

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

Returns the schedule matching :id.

Example

Retrieve a schedule

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

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

<?php

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

define('OMISE_SECRET_KEY', 'skey_test_51fl8dfabe7sqnj8th2');

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

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

require "omise"

Omise.secret_api_key = "skey_test_4xs8breq3htbkj03d2x"

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

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

Request<Schedule> request = new Schedule.GetRequestBuilder("schd_test_57wedy7pc6v9i59xpbx").build();
Schedule schedule = client().sendRequest(request);

System.out.printf("Schedule retrieved: %s", schedule.getId());

import omise

omise.api_secret = "skey_test_no1t4tnemucod0e51mo"

schedule = omise.Schedule.retrieve("schd_test_no1t4tnemucod0e51mo")

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