Credit notes
Create, retrieve, void, and list credit notes that adjust finalized invoices.
A credit note adjusts a finalized invoice — for example when a customer was overcharged or a partial refund is due. Credit notes reduce the invoice's amount due without modifying the original invoice.
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 credit note objectAsk
idstringUnique identifier for the credit note, e.g. cn_6Dp3fQwH.
invoicestringExpandableThe ID of the invoice this credit note adjusts, e.g. inv_1Ab5cDe6. Expand to retrieve the
full invoice object.
amountintegerThe credit amount in the smallest currency unit, e.g. 1500 for €15.00.
currencystringThree-letter ISO currency code matching the invoice, e.g. EUR.
statusenumCurrent state of the credit note: issued or void.
reasonenumWhy the credit was issued: duplicate, fraudulent, order_change, or product_unsatisfactory.
memostringOptional free-text note shown on the credit note PDF.
createdintegerUnix timestamp of when the credit note was created, e.g. 1716300000.
Create a credit noteAsk
Pass the invoice ID, the amount to credit, and a reason. The credit note is immediately
issued and the invoice's amount due is reduced.
Retrieve a credit noteAsk
Void a credit noteAsk
Voiding moves the credit note to void status and reverses its effect on the invoice's amount due.
Only issued credit notes can be voided.
List credit notesAsk
Related eventsAsk
credit_note.created and credit_note.voided. See Events.
