/v1/payment-schedules/{id}Destroy a schedule and its instalments
Really deletes one schedule and every instalment and allocation under it, in one transaction. Answers 204. Reach for it only for a schedule that should never have existed: to stop collecting on a live one use post_payment_schedules_id_pause, and to close out one that ran its course use post_payment_schedules_id_complete. Recorded cash flows SURVIVE with their link cut, because money that moved stays a fact, and the deletion is filed on the record's timeline with what it destroyed. A schedule belonging to another workspace deletes nothing and answers not found.
Access class: workspace.
Send request
Use the documented inputs to call this endpoint directly.
Parameters
Values are applied to the request and the example on the right.
Responses
the action's answer
a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}