StripeKit - Void Invoice

`kit.invoices.voidInvoice()`

Voids an invoice that hasn't been paid, permanently marking it uncollectable and closing it out. This does not issue a refund; it is for invoices that were never paid in the first place.

Signature

Example request

Example response

Same shape as retrieve()'s response, with status set to 'void'.

Errors

Exception	When
`StripeOperationError`	The invoice has already been paid, or is already void, or does not exist. Only `open` or `draft` invoices can be voided.

Notes

If a storage adapter is configured, StripeKit calls markInvoiceDeleted($invoiceId) in addition to saveInvoice(), so your own schema can treat voided invoices distinctly if it needs to, for example excluding them from revenue reports.

To refund a payment that already succeeded, use the underlying Stripe client via kit.raw; StripeKit does not currently expose a refund method.

Void

kit.invoices.voidInvoice()#

Signature#

Example request#

Example response#