Skip to main content
POST
/
api
/
v1
/
schedules
/
{scheduleId}
/
cancel
Cancel Schedule
curl --request POST \
  --url https://www.{baseurl}.com/api/v1/schedules/{scheduleId}/cancel \
  --header 'x-client-id: <x-client-id>'
{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "Bad Request",
  "status": 400,
  "detail": "Schedule cannot be cancelled."
}
Work in progressThis section is currently under active development as part of improvements planned for 2026. Content may change as we expand product capabilities.If you’re interested in early access or want to learn more about what’s coming, feel free to reach out to the team.
Cancel an active recurring payment schedule. This stops all future payments that have not yet been submitted.

​
When Cancellation is Allowed

A schedule can be cancelled as long as it has remaining future payments. Payments that have already been submitted to Payments Canada are not affected by the cancellation. A successful cancellation returns an empty 200 OK response.

Headers

​
x-client-id
string
required

Your API key provided during onboarding.

Path Parameters

​
scheduleId
string<uuid>
required

The schedule identifier to cancel.

Response

Schedule cancelled successfully