InvoicesCredit notes

List credit notes

GET
/v1/credit-notes

Newest first.

Authorization

apiKey
headerAuthorizationBearer <token>

An API key from the Developers page. rhq_test_ keys reach the sandbox, rhq_live_ keys the live side.

Query Parameters

limit?integer

How many to return

Range1 <= value <= 100
Default25
cursor?string

nextCursor from the previous page

customerId?string
invoiceId?string
q?string

Text to look for in the credit note number, or in the customer's name or email

Length1 <= length <= 100

Response Body

Success

application/json
  1. response

Success

data*array<>
nextCursor*|

Pass as cursor for the next page. null on the last page

total*integer

How many match across every page

Range0 <= value
curl -X GET "https://example.com/v1/credit-notes?customerId=cus_01K6XJ4Q8ZT3M9R5V2B7WDHNCA&invoiceId=inv_01K6XJ4Q8ZT3M9R5V2B7WDHNCA"
{  "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      }    }  ],  "nextCursor": null,  "total": 1}