Cancel an invoice
cancel_invoiceCancel an invoice before payment is received and require confirm: true so the buyer can no longer pay it; test keys only, and the action cannot be undone.
Instructions
Cancel an invoice.
Only while nothing has arrived. Money that arrives later is still seen (the address stays watched) and lands in review.
Test keys only: refused with a live key.
Cannot be undone — Cancels the invoice: its buyer can no longer pay it. Ask the person first, then call with confirm: true.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The object's id. | |
| confirm | Yes | true once the person has agreed to this exact call. Without it nothing is done. |