StripeKit - Finalize Draft Invoice

`kit.invoices.finalize()`

Finalizes a draft invoice, locking its line items and making it payable. Most invoices Stripe generates for subscriptions are finalized automatically; this method is for invoices you created manually and left as a draft, or for adjusting a draft invoice's auto-advance behavior before finalizing.

Signature

Parameters

Field	Type	Description
`invoiceId`	`string`	The draft invoice to finalize.
`autoAdvance`	`boolean`	Defaults to `true`. If `true`, Stripe automatically attempts to collect payment after finalizing, following the customer's normal collection method. If `false`, the invoice becomes `open` but nothing is charged automatically.

Example request

Example response

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

Errors

Exception	When
`StripeOperationError`	The invoice is not in `draft` status, or does not exist.

Notes

If a storage adapter is configured, the result is persisted via saveInvoice().

Finalize

kit.invoices.finalize()#

Signature#

Parameters#

Example request#

Example response#

Errors#