Skip to main content

Customers

Customer data is currently exposed primarily through merchant-scoped billing and dashboard operations.

The Customer object​

{
  "id": "cus_abc123",
  "object": "customer",
  "name": "Aminata Koné",
  "email": "aminata@example.com",
  "phone": "+2250700000000",
  "currency": "XOF",
  "balance": 0,
  "metadata": {},
  "created": 1708300800
}

Implemented route family​

Current customer retrieval operations are available under the merchant route family:

  • GET /api/v1/merchant/customers
  • GET /api/v1/merchant/customers/{id}

Legacy-compatible merchant paths may also be available under api/merchant/*.

List customers​

GET /api/v1/merchant/customers
ParameterTypeDescription
pageintegerPage number
limitintegerNumber of results per page
searchstringSearch term

Retrieve a customer​

GET /api/v1/merchant/customers/{id}

Integration note​

The docs should not currently present a generic public customer CRUD API unless a dedicated customer controller and route family are explicitly exposed.