Invoices
List invoices
Authorization
apiKey AuthorizationBearer <token>
Per-organisation API key from Settings → API Keys, sent as Authorization: Bearer cnk_…. Missing, unknown or expired keys return 401.
In: header
Query Parameters
customerId?string
Restrict results to this customer.
status?string
Filter by invoice status (case-insensitive).
Value in
- "OPEN"
- "PAID"
- "VOID"
limit?integer
Maximum rows to return. Must be a positive number; clamped to 1–200.
Range
1 <= value <= 200Default
50Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/invoices?customerId=cus_abc123&status=OPEN&limit=25"{ "statusCode": 200, "statusDetail": { "status": "SUCCESS", "message": "OK" }, "result": { "invoices": [ { "id": "inv_jkl012", "invoiceNumber": "INV-2026-0042", "purchaseNumber": "PUR-2026-0042", "purchaseId": "pur_ghi789", "customerId": "cus_abc123", "customerName": "Acme Inc", "planName": "Growth", "billingCycle": "MONTHLY", "cycleIndex": 0, "amount": 499, "currencyCode": "USD", "status": "OPEN", "issuedAt": "2026-07-01T09:45:05.000Z", "paidAt": "2026-07-01T10:02:00.000Z" } ] }}{ "statusCode": 400, "statusDetail": { "status": "ERROR", "message": "Request body must be valid JSON." }, "result": {}}{ "statusCode": 401, "statusDetail": { "status": "ERROR", "message": "Invalid API key." }, "result": {}}{ "statusCode": 500, "statusDetail": { "status": "ERROR", "message": "Could not complete the request." }, "result": {}}