Sign in
Schedules

Cancel a schedule

Cancels a schedule. No further payments will be attempted.

post/schedules/v1/{schedule_id}/cancel

Path parameters

schedule_idstring uuid required

The id of the schedule.

Request body

reasonstring nullable

An optional human readable reason for the action.

Response

The schedule was cancelled.

schedule_idstring uuid required

The id of the schedule the action was applied to.

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.
updated_atstring date-time required

The date and time the schedule was last updated.

Changes

No recorded changes to this endpoint across all 1 revision of this API.