Remove installment

Removes an existing installment by ID.

Use this operation when the installment should no longer remain active and still meets the conditions required for deletion.

⚠️

Conditions for removal

Removal is only allowed when the installment's payments are awaiting payment or overdue, there is no anticipation process in progress, and there is no associated payment dunning process.

❗️

Permanent removal

A removed installment cannot be restored. There is no operation to recover an installment after deletion.

If the goal is to remove only the pending or overdue payments of an installment without affecting payments that have already been confirmed, use Cancel payments of an installment.

Removing an installment triggers PAYMENT_DELETED events for the removed payments. See the Webhook events for payments.

Related content

Guides

Path Params
string
required

Unique identifier of the installment to be removed.

Responses

404

Not found

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json