Skip to main content
GET
List customers

Authorizations

Authorization
string
header
required

Use a Bearer token to access this API.

Query Parameters

starting_after
string | null

A cursor for use in pagination. starting_after is a customer ID that defines your place in the list. For instance, if you make a list request and receive 20 customers, ending with cus_xyz, your subsequent call can include starting_after=cus_xyz to fetch the next page.

Example:

"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

ending_before
string | null

A cursor for use in pagination. ending_before is a customer ID that defines your place in the list. For instance, if you make a list request and receive 20 customers, starting with cus_abc, your subsequent call can include ending_before=cus_abc to fetch the previous page.

Example:

"fcus_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

limit
integer<int32> | null

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Example:

10

offset
integer<int32> | null

Number of objects to skip before returning results.

Example:

3

email
string<email> | null

Filter results by customer email address.

Example:

"john.doe@example.com"

Response

An envelope wrapping a list of customer objects.

An envelope wrapping a list of customer objects.

customers
object[]
required

The list of customers.