List all customers

Changed on

Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.

get/v1/customers

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/customers
  • Auth: HTTP bearer

Query parameters

OR
integer

Only return customers that were created during the given date interval.

emailstring

A case-sensitive filter on the list based on the customer's email field. The value must be a string.

ending_beforestring

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

expandstring[]

Specifies which fields in the response should be expanded.

limitinteger

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

starting_afterstring

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

test_clockstring

Provides a list of customers that are associated with the specified test clock. The response will not include customers with test clocks if this parameter is not set.

Response

Successful response.

has_moreboolean required

True if this list has another page of items after this one that can be fetched.

object'list' required

String representing the object's type. Objects of the same type share the same value. Always has the value list.

urlstring required

The URL where this list can be accessed.

Changes