Instalment Schedule
Cancel an instalment schedule
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.
post/instalment_schedules/{instalment_schedule_id}/actions/cancel
Request
- Base URLhttps://api.gocardless.com
- AuthHTTP bearer
Path parameters
instalment_schedule_idstring required
The instalment schedule id
Headers
GoCardless-Versionstring required
Request body
Response
Action completed successfully
Example response
{
"instalment_schedules": {
"id": "IS123",
"created_at": "2014-01-01T12:00:00.000Z",
"total_amount": 1000,
"name": "Invoice 4404",
"currency": "EUR",
"status": "active",
"payment_errors": {
"0": [
{
"field": "charge_date",
"message": "must be on or after mandate's next_possible_customer_charge_date"
}
]
},
"links": {
"mandate": "MD123",
"customer": "CU123",
"payments": [
"PM123",
"PM456"
]
}
}
}Changes
No recorded changes to this operation across all 1 revision of this API.