Charge Schedule

Create, retrieve, and delete Charge Schedules, a type of schedule. To create a Charge Schedule, create a schedule and populate the charge field with the scheduled_charge object.

Note: Use of this API is disabled for 3DS-enabled accounts.


Name Type Description
object string

The string scheduled_charge.

id string

The scheduled charge identifier matching /rchg(_test)?_[0-9a-z]+/.

livemode boolean

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

amount integer

Scheduled charge amount in smallest unit of charge currency.

card object_id_expandable

Identifier for card to be charged. If a card was not specified at charge schedule creation, this is the customer's current default card.

created_at string

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

currency string

Currency for scheduled charge as three-letter ISO 4217 code.

customer object_id_expandable

Identifier for customer to be charged.

default_card boolean

Whether card is default card of customer.

description string

Scheduled charge description.

metadata object

Custom metadata (e.g. {"answer": 42}) for charge schedule.


  • JSON Response

List charge schedules


Returns a list of charge 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).


  • List all charge schedules

Omise uses cookies to improve your overall site experience and collect information on your visits and browsing behavior. By continuing to browse our website, you agree to our Privacy Policy. Learn more