Customers
List Customers
Retrieve all customers for the authenticated merchant. Excludes soft-deleted customers and seat members (orgRole='member'). Use includePaymentData to get aggregated payment statistics.
Authorization
bearerAuth AuthorizationBearer <token>
Use your secret API key as the bearer token
In: header
Query Parameters
includePaymentData?string
Include payment aggregations (totalPaymentsCents, paymentCount, currency) by joining invoices and payments tables. Only counts 'succeeded' and 'paid' payments.
Default
"false"Value in
"true" | "false"Response Body
application/json
application/json
curl -X GET "https://api.getlumen.dev/v1/customers"{
"customers": [
{
"id": "cus_01hrwzqrz4ytkwv07syv8k7g3z",
"merchantId": "mrc_01hptv3p6xj173pfv96pxd5pke",
"name": "Jane Doe",
"email": "jane@example.com",
"phoneNumber": "+1234567890",
"externalCustomerId": "user_ext_123",
"pspCustomerId": "cus_stripe_abc123",
"billingCountry": "US",
"preferredCurrency": "USD",
"createdAt": "2024-12-01T10:00:00.000Z"
}
]
}{
"error": "string",
"details": "string"
}