Credit an invoice
Creates a draft credit note against an invoice, crediting it at the prices and tax it was issued with rather than calculating tax again. Omit line_items to credit everything still uncredited on the invoice. Give line_items to credit specific invoice lines, each by the quantity of units to credit, which may be fractional. Every line here credits an invoice line item; to credit an amount that is not on the invoice, use create-credit-note instead.
Authorizations
API key authentication. Pass your API key as a Bearer token.
Headers
2026-04-01 A unique string used to ensure the request is processed exactly once. If you retry a request with the same idempotency key within 24 hours, the original response is returned without re-executing the operation.
255"ik_a1b2c3d4e5f6"
Path Parameters
Unique identifier for the invoice
Body
Invoice lines to credit and how many units of each. Omit to credit everything still uncredited on the invoice.
Response
Success
Attachments on this credit note
Timestamp when the credit note was created
"2026-04-01T10:00:00Z"
Currency code
"USD"
Customer this credit note belongs to
"cust_01H1VECT"
Description of the credit note
"Overcharge credit"
External reference identifier
Unique identifier for the credit note
"cn_01H1VECT"
Whether a PDF is available for download
Line items on this credit note
Current status of the credit note
draft, applied, void, pending_refund "draft"
Subtotal before tax
"100.00"
Whether accounting sync is enabled
Tax amount
"10.00"
Total amount including tax
"110.00"
Timestamp when the credit note was last updated
"2026-04-01T12:30:00Z"
Credit note ID in the accounting system
URL to the credit note in the accounting system
Accounting integration ID
Accounting provider name
Date the credit note was applied
"2026-03-01T00:00:00Z"
End of the billing period
"2026-01-31T23:59:59Z"
Start of the billing period
"2026-01-01T00:00:00Z"
Date of the credit
"2026-03-01T00:00:00Z"
Associated invoice ID
Date of the last refund
ID of the last refund
Legal entity ID
Sub-merchant the credited invoice was issued for; inherited from that invoice
"mrch_01H8XGJWBWBAQ4PLwXYZ"
Purchase order number
Date the credit note was voided