Invoices
Create, finalize, pay, void, and list invoices for customers.
An invoice collects line items and billing details for a customer, moving through a lifecycle from draft to open to paid (or voided). VINR can advance invoices automatically or give you full manual control over each transition.
Illustrative content. Hand-authored to demonstrate the Standard/Advanced pattern; the production page will be generated from the VINR OpenAPI spec (roadmap item #1). Field names are representative.
The invoice objectAsk
idstringUnique identifier for the invoice, e.g. inv_4Xk9b3Mw.
customerobjectExpandableThe customer this invoice belongs to. Expand to retrieve the full object.
statusenumOne of draft, open, paid, void, or uncollectible.
amount_dueintegerTotal amount due, in the smallest currency unit (e.g. cents).
amount_paidintegerAmount already collected, in the smallest currency unit.
currencystringThree-letter ISO currency code, e.g. EUR.
due_dateintegerUnix timestamp of when payment is due, if set.
linesarrayArray of line items included in the invoice. Each item has id, description, amount, and quantity.
createdintegerUnix timestamp of when the invoice was created.
Create an invoiceAsk
Creates a draft invoice for a customer. Set auto_advance: true to let VINR automatically finalize
and attempt payment when the invoice is ready.
Retrieve an invoiceAsk
Update an invoiceAsk
Updates a draft invoice. Only description and footer may be modified after finalization.
Finalize an invoiceAsk
Moves a draft invoice to open, making it ready for payment. Once finalized, line items are locked.
Pay an invoiceAsk
Charges the customer's default payment method and transitions the invoice to paid.
Void an invoiceAsk
Cancels an open invoice. A voided invoice cannot be re-opened or paid.
List invoicesAsk
Returns invoices for your account, optionally filtered by customer or status.
Related eventsAsk
invoice.created, invoice.finalized, invoice.payment_succeeded, invoice.payment_failed, and
invoice.voided. See Events.
