Invoices

List invoices

GET
/v1/invoices

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
status?string

credited was corrected in full by credit notes and asks for nothing

Value in"open""paid""void""credited"
q?string

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

Length1 <= length <= 100
overdue?string

true for open invoices whose due date has passed, false for the rest

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/invoices?customerId=cus_01K6XJ4Q8ZT3M9R5V2B7WDHNCA"
{  "data": [    {      "id": "inv_01K6XJ4Q8ZT3M9R5V2B7WDHNCA",      "number": "INV-0001",      "customerId": "cus_01K6XJ4Q8ZT3M9R5V2B7WDHNCA",      "currency": "USD",      "lines": [        {          "saleId": "sal_01K6XJ4Q8ZT3M9R5V2B7WDHNCA",          "description": "northwind-telecom.com, 2 years",          "quantity": 2,          "unitPrice": 1439,          "total": 2878        }      ],      "subtotal": 2878,      "taxBps": 2000,      "tax": 576,      "taxLines": [        {          "name": "string",          "rateBps": 2000,          "amount": 2878        }      ],      "reverseCharge": {        "note": "string",        "sellerTaxId": "string",        "customerTaxId": "string"      },      "total": 3454,      "status": "open",      "overdue": true,      "shared": true,      "issuedAt": "2026-10-07T11:04:31.000Z",      "dueAt": "2026-10-21T11:04:31.000Z",      "paidAt": null,      "voidedAt": null,      "note": "Thank you for your business",      "credited": 2878,      "paidAmount": 2878,      "amountDue": 2878,      "creditedAt": null,      "issuer": {        "name": "Northwind Telecom",        "legalName": null,        "addressLines": [],        "taxId": null,        "billingEmail": null      },      "actor": {        "kind": "user",        "label": "string"      },      "voidedBy": {        "kind": "user",        "label": "string"      },      "paidBy": {        "kind": "user",        "label": "string"      },      "sharedBy": {        "kind": "user",        "label": "string"      }    }  ],  "nextCursor": null,  "total": 1}