Skip to main content

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/v3/invoice/{id}/cancel
  1. Provide the invoice id in the URL path
  2. The invoice status is updated to EXPIRED

Path Parameters​

▾
idSTRINGrequired

Invoice ID

Example: 1779261889474362606

Response Parameters​

▾
itemOBJECT

Updated invoice object (status will be EXPIRED). See [Get Invoices](./get-invoices) for the full field list.

codeSTRING

Result code ("SUCCESS" on success).