Sign in
Schedules

Get schedule details

Returns the full details of a single schedule.

get/schedules/v1/{schedule_id}

Path parameters

schedule_idstring uuid required

The id of the schedule.

Response

The schedule details.

schedule_idstring uuid required

The id of the schedule.

consent_idstring uuid required

The id of the consent the schedule belongs to.

application_idstring uuid required

The id of the application that owns the schedule.

kind'RECURRING' | 'EXPLICIT' required

Discriminates between recurring and explicit schedules.

status'PENDING' | 'ACTIVE' | 'PAUSED' | 'CONSENT_BLOCKED' | 'CANCELLED' | 'COMPLETED' required

The lifecycle status of a schedule.

  • PENDING — registered, not yet active.
  • ACTIVE — active; payments are attempted on their due dates.
  • PAUSED — temporarily paused; no payments attempted until resumed.
  • CONSENT_BLOCKED — the underlying consent is no longer usable.
  • CANCELLED — terminated by the client or due to consent state.
  • COMPLETED — all planned payments have been executed.
created_atstring date-time required

The date and time the schedule was created.

updated_atstring date-time nullable

The date and time the schedule was last updated.

Changes