InvoicesCredit notes
Get a credit note
GET
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
id*stringnumber*stringCounts up from CN-0001 across your account, with no gaps
invoiceId*stringinvoiceNumber*stringcustomerId*stringcurrency*stringThe currency of every amount on the credit note
Value in
"USD""EUR""GBP""CAD""AUD""NZD""CHF""SEK""NOK""DKK""PLN""INR""SGD""HKD""AED""ZAR""BRL""MXN"lines*array<>subtotal*integerThe lines added up, before tax
Range
0 <= valuetaxBps*|Copied from the invoice's rate. Null when the invoice carried no tax
tax*integerMinor units of the invoice's currency
Range
0 <= valuetotal*integerWhat this credit note comes to: subtotal plus tax
Range
0 <= valuereason*stringissuedAt*stringFormat
date-timeshared*booleanTrue once POST /credit-notes/{id}/share has made a public link for this credit note, false again once revoked. The token itself is never in this response or the list
issuer*|The account as it billed the invoice this credit note corrects
curl -X GET "https://example.com/v1/credit-notes/crn_01K6XJ4Q8ZT3M9R5V2B7WDHNCA"{ "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 }}