Properties
| Name | Type | Description |
|---|---|---|
| time_start | string | The schedule start time (UTC). |
| time_end | string | The schedule end time (UTC). |
| recurrence_unit | string | The schedule recurrence unit, options: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY, YEARLY |
| recurrence_size | integer | The schedule recurrence size. For example size 4 and unit WEEKLY means the recurrence is every 4 weeks. |
| status | string | The schedule status, options: ACTIVE, FINISHED, CANCELLED. |
| object | object | The scheduled object. (Payment, PaymentBatch) |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/ScheduleListing",
"title": "ScheduleListing",
"type": "object",
"properties": {
"time_start": {
"type": "string",
"description": "The schedule start time (UTC).",
"readOnly": true,
"writeOnly": false
},
"time_end": {
"type": "string",
"description": "The schedule end time (UTC).",
"readOnly": true,
"writeOnly": false
},
"recurrence_unit": {
"type": "string",
"description": "The schedule recurrence unit, options: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY, YEARLY",
"readOnly": true,
"writeOnly": false
},
"recurrence_size": {
"type": "integer",
"description": "The schedule recurrence size. For example size 4 and unit WEEKLY means the recurrence is every 4 weeks.",
"readOnly": true,
"writeOnly": false
},
"status": {
"type": "string",
"description": "The schedule status, options: ACTIVE, FINISHED, CANCELLED.",
"readOnly": true,
"writeOnly": false
},
"object": {
"type": "object",
"description": "The scheduled object. (Payment, PaymentBatch)",
"readOnly": true,
"writeOnly": false,
"$ref": "#/components/schemas/ScheduleAnchorObject"
}
}
}