List all customers

Authorizations

Authorization

string

header

required

The API key to use for authentication

Query Parameters

string | null

Search for a customer by name, email, phone number, or description

Example:

"John Doe"

cursor

string | null

Cursor for pagination, representing the last item from the previous page

Example:

"eyJpZCI6IjEyMyJ9"

limit

number

default:10

The number of customers to return (1-100)

Required range: 1 <= x <= 100

Example:

10

start

string<date-time> | null

Start date (inclusive) for filtering customers in ISO 8601 format

Example:

"2024-12-01T00:00:00.000Z"

end

string<date-time> | null

End date (inclusive) for filtering customers in ISO 8601 format

Example:

"2024-12-31T23:59:59.999Z"

sortOrder

enum<string>

default:desc

The order in which to sort results. Defaults to 'desc'. Use 'asc' for ascending (oldest first) or 'desc' for descending (newest first).

Available options:

asc,

desc

Example:

"desc"

sortBy

enum<string>

default:createdAt

The field to sort results by. Defaults to 'createdAt'. Supported fields include any sortable customer property.

Available options:

createdAt,

name,

lastActiveAt,

countryCode,

email,

phoneNumber,

firstTransactionAt,

isActive,

isVerified

Example:

"createdAt"

Response

List of all customers

data

object[]

required

Show child attributes

data.id

string

required

Unique identifier for the customer, prefixed with 'cus_'

Maximum string length: 255

Example:

"cus_GqfKXLmg61LURZhB"

data.object

string

required

Example:

"customer"

data.environment

enum<string>

required

The environment of the customer. Either 'sandbox' or 'production'

Available options:

sandbox,

production

Example:

"sandbox"

data.name

string | null

required

The name of the customer

Minimum string length: 2

Example:

"John Doe"

data.email

string | null

required

The email of the customer

Example:

"[email protected]"

data.phoneNumber

string

required

The phone number of the customer

Example:

"254712345678"

data.description

string | null

required

The description of the customer

Example:

"VIP customer with recurring payments"

data.countryCode

string

required

The country code of the customer

Maximum string length: 2

Example:

"KE"

data.isActive

boolean

required

Whether the customer is active

Example:

true

data.isVerified

boolean

required

Whether the customer is verified

Example:

true

data.lastActiveAt

string | null

required

Timestamp when the customer was last active (ISO 8601 format)

Example:

"2024-12-19T16:45:00.000Z"

data.firstTransactionAt

string | null

required

Timestamp when the customer made their first transaction (ISO 8601 format)

Example:

"2024-12-15T09:15:00.000Z"

data.preferredPaymentMethod

string | null

required

The preferred payment method of the customer

Maximum string length: 50

Example:

"m-pesa"

data.source

enum<string>

required

Source where the customer was created (api, dashboard, checkout, import)

Available options:

api,

dashboard,

checkout

Example:

"api"

data.metadata

object

required

Key-value object allowing you to store additional information.

Key Requirements:

Must be a string
Maximum length of 40 characters

Value Types:

String (maximum 500 characters)
Integer
Floating-point number
Boolean

Limits:

Maximum of 50 key-value pairs

Show child attributes

data.metadata.{key}

Maximum string length: 500

Example:

{
  "user_preference": "dark_mode",
  "last_login": 1640995200,
  "is_premium": true,
  "account_balance": 1250.75,
  "notifications_enabled": false
}

data.createdAt

string

required

Timestamp when the customer was created (ISO 8601 format)

Example:

"2024-12-10T08:30:00.000Z"

data.updatedAt

string

required

Timestamp when the customer was last updated (ISO 8601 format)

Example:

"2024-12-19T14:22:00.000Z"

Getting Started

APIs

Authorizations

Query Parameters

Response