Customers
Authorization
apiKey AuthorizationBearer <token>
Organisation-scoped key from Settings → API Keys.
In: header
Path Parameters
id*string
Customer id.
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/customers/cus_abc123"{ "statusCode": 200, "statusDetail": { "status": "SUCCESS", "message": "OK" }, "result": { "customer": { "id": "cus_abc123", "externalId": "acme-42", "slug": "acme-inc", "name": "Acme Inc", "description": "AI meeting-notes startup — growth tier", "email": "ops@acme.com", "website": "https://acme.com", "phone": "+1 415 555 0100", "legalName": "Acme Incorporated", "addressLine1": "500 Market Street", "city": "San Francisco", "state": "CA", "country": "United States", "pincode": "94105", "taxId": "US-EIN 12-3456789", "currencyCode": "USD", "createdAt": "2026-07-01T09:30:00.000Z", "updatedAt": "2026-07-18T11:12:00.000Z" } }}{ "statusCode": 401, "statusDetail": { "status": "ERROR", "message": "Invalid API key." }, "result": {}}{ "statusCode": 404, "statusDetail": { "status": "ERROR", "message": "No customer with id \"cus_abc123\"." }, "result": {}}{ "statusCode": 500, "statusDetail": { "status": "ERROR", "message": "Could not complete the request." }, "result": {}}The same call, addressed by YOUR id for the customer (its externalId) instead of ours. Same response.
Authorization
apiKey AuthorizationBearer <token>
Organisation-scoped key from Settings → API Keys.
In: header
Path Parameters
externalId*string
Your own id for the customer (its externalId): 1–32 letters, numbers or "-", matched exactly (case-sensitive).
Match
^[A-Za-z0-9-]{1,32}$Length
1 <= length <= 32Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/customers/ext/acme-42"{ "statusCode": 200, "statusDetail": { "status": "SUCCESS", "message": "OK" }, "result": { "customer": { "id": "cus_abc123", "externalId": "acme-42", "slug": "acme-inc", "name": "Acme Inc", "description": "AI meeting-notes startup — growth tier", "email": "ops@acme.com", "website": "https://acme.com", "phone": "+1 415 555 0100", "legalName": "Acme Incorporated", "addressLine1": "500 Market Street", "city": "San Francisco", "state": "CA", "country": "United States", "pincode": "94105", "taxId": "US-EIN 12-3456789", "currencyCode": "USD", "createdAt": "2026-07-01T09:30:00.000Z", "updatedAt": "2026-07-18T11:12: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": 404, "statusDetail": { "status": "ERROR", "message": "No customer with id \"cus_abc123\"." }, "result": {}}{ "statusCode": 500, "statusDetail": { "status": "ERROR", "message": "Could not complete the request." }, "result": {}}