Cancel an Instalment Schedule

POST {{url}}/instalment_schedules/{{instalment_schedule}}/actions/cancel

Immediately cancels an instalment schedule; no further payments will be collected for it.

This will fail with a cancellation_failed error if the instalment schedule is already cancelled or has completed.

Cancel an instalment schedule API Docs

RESPONSES

status: OK

{"instalment_schedules":{"id":"IS000063XHF9FF","created_at":"2024-03-22T21:08:36.452Z","total_amount":2500,"currency":"GBP","status":"cancelled","name":"Intelligent Fresh Sausages","metadata":{"key":"value"},"payment_errors":{},"links":{"mandate":"MD000ZS5F79P1E","customer":"CU0014DQSA7A4W","payments":["PM009N4VPD9XQB","PM009N4VPEZPRS"]}}}