Sample - Stripe API
GET/v1/customers

List all customers

Lists customers sorted by creation date, with the most recently created customers first. Filter results by creation interval, email address, or test clock, and use cursor parameters to paginate through the collection. The response includes customer objects and list pagination metadata.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

7 parameters
createdobjectoptional
Filter customers by creation time using a timestamp or a range with `gt`, `gte`, `lt`, or `lte`.
emailstringoptional
A case-sensitive customer email filter; maximum 512 characters.
ending_beforestringoptional
An object ID cursor that retrieves the page of customers before the specified item.
expandarray<string>optional
Fields to expand in the response.
limitintegeroptional
The number of customers to return. Must range from 1 to 100 and defaults to 10 when omitted.
starting_afterstringoptional
An object ID cursor that retrieves the page of customers after the specified item.
test_clockstringoptional
The unique identifier of a test clock; when provided, lists only customers associated with that test clock.

2 status codes
200Returns a list object containing customer objects in `data`, a `has_more` pagination flag, the `list` object type, and the collection URL.
dataarray<Customer>required
has_morebooleanrequired
True if this list has another page of items after this one that can be fetched.
objectstringrequired
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
Allowed:list
urlstringrequired
The URL where this list can be accessed.
defaultError response.
errorobjectrequired

Error handling

limit must range from 1 to 100 and defaults to 10 when omitted. email must be a string of no more than 512 characters, while created and test_clock must use the supported filter representations and customer or test clock identifiers.