Payments
List payments
A payment is a PAID invoice.
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.
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/payments?customerId=cus_abc123&limit=25"{ "statusCode": 200, "statusDetail": { "status": "SUCCESS", "message": "OK" }, "result": { "payments": [ { "id": "inv_jkl012", "paymentNumber": "PAY-2026-0031", "invoiceNumber": "INV-2026-0042", "purchaseNumber": "PUR-2026-0042", "customerId": "cus_abc123", "customerName": "Acme Inc", "planName": "Growth", "amount": 499, "currencyCode": "USD", "paymentMode": "STRIPE", "paymentReference": "pi_3Rt8kX2eZvKYlo2C", "paidAt": "2026-07-01T10:02:00.000Z", "paidByName": "Dana Whitman" } ] }}{ "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": {}}