Sign in
CreditNotes

Create a credit note (line-based, or commit relief)

Changed on

Two shapes. LINE-BASED (regular invoices): lines[] + refund/credit/out_of_band allocation; capped by the invoice's remaining creditable gross. COMMIT RELIEF (ADR-080, paid commit invoices only): pass commit_relief and NO lines — the server retires commit credits and derives the refundable cash from the telescoping price-ratio anchor (discounted commits refund at the purchase rate, never at face). The relief credit note is created AND issued in one transaction; the credit-balance channel is forbidden on relief. Unpaid commit invoices: void the invoice instead.

post/v1/credit-notes

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/v1/credit-notes
  • Auth: HTTP bearer

Request body

invoice_idstring required
reasonstring
refund_amount_centsinteger
credit_amount_centsinteger
out_of_band_amount_centsinteger
auto_issueboolean

Response

Credit note (issued immediately for commit relief)

Changes