The schedule object

{
    "object": "schedule",
    "id": "8cjyfzm6d0e2jecq98x1tnii",
    "interval": "month",
    "intervalCount": 1,
    "atHour": 21,
    "atMinute": 0,
    "anchor": "start",
    "dateNext": "2020-04-01T21:00:00.000Z",
    "dateStart": "2020-04-01T21:00:00.000Z",
    "timesRan": 0,
    "timesToRun": 12,
    "status": "active",
    "created": "2020-03-16T14:40:10.000Z",
    "lastUpdated": "2020-03-16T14:40:11.000Z"
  }

Object Keys

id string
The unique id of the payment.

object string, value is "schedule"

interval string, possible values: week, month, year
The interval for this schedule.

intervalCount integer

atHour integer

atMinute integer

anchor string
Specifies an anchor for intervals. Each interval can have the following anchor values.

Interval week can have values monday, tuesday, wednesday, thursday, friday, saturday, sunday

Interval month can have values start, end

Interval year can have possible values start, end

dateNext datestring
The date when the schedule will run next.

dateStart datestring
The date when the schedule starts to run.

timesRan integer
The number of times the schedule has ran.

timesToRun integer
The number of times the schedule needs to run.

status string, values are: active, running, stopped, complete, inactive

active
The schedule is active.

stopped
The schedule has been stopped.

running
The schedule is actively processing.

complete
The schedule has run it course and finished.

inactive
The schedule has been deactivated.

created datestring
The date the schedule was created.

lastUpdated datestring
The date the schedule was last updated.