InvoicesCredit notes
List credit notes against an invoice
GET
Newest first, at most 200.
apiKeyheader
AuthorizationBearer <token>An API key from the Developers page. rhq_test_ keys reach the sandbox, rhq_live_ keys the live side.
id*stringSuccess
application/json- response
Success
data*array<>curl -X GET "https://example.com/v1/invoices/inv_01K6XJ4Q8ZT3M9R5V2B7WDHNCA/credit-notes"{ "data": [ { "id": "crn_01K6XJ4Q8ZT3M9R5V2B7WDHNCA", "number": "CN-0001", "invoiceId": "inv_01K6XJ4Q8ZT3M9R5V2B7WDHNCA", "invoiceNumber": "INV-0001", "customerId": "cus_01K6XJ4Q8ZT3M9R5V2B7WDHNCA", "currency": "USD", "lines": [ { "saleId": "sal_01K6XJ4Q8ZT3M9R5V2B7WDHNCA", "description": "northwind-telecom.com, 2 years", "quantity": 2, "unitPrice": 1439, "total": 1439 } ], "subtotal": 2878, "taxBps": 2000, "tax": 576, "total": 3454, "reason": "Customer cancelled a seat", "issuedAt": "2026-10-07T11:04:31.000Z", "shared": true, "issuer": { "name": "Northwind Telecom", "legalName": null, "addressLines": [], "taxId": null, "billingEmail": null } } ]}Issue a credit note POST
Corrects an invoice already issued, by named lines or by a flat amount, instead of editing it: an invoice is never rewritten once sent. A fully credited open invoice moves to `credited`; a paid invoice stays `paid`. Send an Idempotency-Key header so a retry can never credit twice.
See what is left to credit on an invoice GET
What is left uncredited on this invoice, line by line and in total. A void invoice answers with everything at zero.