Customers

Get Customer

Retrieve a specific customer by their Lumen customer ID (cus_*). Returns all customer details including billing address, tax information, organization membership, and preferences. Excludes soft-deleted customers.

GET
/customers/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

Use your secret API key as the bearer token

In: header

Path Parameters

id*string

Lumen customer ID (must start with cus_)

Match^cus_[a-z0-9]+$

Response Body

application/json

application/json

application/json

curl -X GET "https://api.getlumen.dev/v1/customers/cus_01hrwzqrz4ytkwv07syv8k7g3z"

{
  "customer": {
    "id": "cus_01hrwzqrz4ytkwv07syv8k7g3z",
    "merchantId": "mrc_01hptv3p6xj173pfv96pxd5pke",
    "name": "Jane Doe",
    "email": "jane@example.com",
    "phoneNumber": "+1234567890",
    "externalCustomerId": "user_ext_abc123",
    "pspCustomerId": "cus_stripe_abc123",
    "billingAddressLine1": "123 Main St",
    "billingAddressLine2": "Apt 4B",
    "billingCity": "San Francisco",
    "billingStateProvince": "CA",
    "billingPostalCode": "94102",
    "billingCountry": "US",
    "businessName": null,
    "taxId": null,
    "taxExempt": false,
    "taxExemptionReason": null,
    "taxExemptionCertificate": null,
    "taxRateDefinitionId": null,
    "taxCalculationMethod": null,
    "invoicePrefix": null,
    "preferredLanguage": "en",
    "timezone": "America/Los_Angeles",
    "preferredCurrency": "USD",
    "metadata": {
      "internalUserId": "12345"
    },
    "customerOrganizationId": null,
    "orgRole": null,
    "createdAt": "2024-12-01T10:00:00.000Z",
    "updatedAt": "2024-12-15T14:30:00.000Z",
    "deletedAt": null
  }
}

{
  "error": "Customer not found or access denied"
}
{
  "error": "Failed to fetch customer",
  "details": "Database query timeout"
}