Cancel Invoice
Cancels a pending invoice. Only invoices with PENDING status can be cancelled.
When to Use
▾
Use this endpoint when:
- Voiding an invoice that is no longer needed before it is paid
note
After cancellation, the invoice status becomes EXPIRED.
How to Use
▾
Endpoint
POST
/api/v3/invoice/{id}/cancel- Provide the invoice
idin the URL path - The invoice status is updated to
EXPIRED
Path Parameters
▾
Invoice ID
Example: 1779261889474362606
Response Parameters
▾
Updated invoice object (status will be EXPIRED). See [Get Invoices](./get-invoices) for the full field list.
Result code ("SUCCESS" on success).