List all customers
GET {{baseUrl}}/v1/customers
Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
created[gt] | string | Only return customers that were created during the given date interval. | |
created[gte] | string | Only return customers that were created during the given date interval. | |
created[lt] | string | Only return customers that were created during the given date interval. | |
created[lte] | string | Only return customers that were created during the given date interval. | |
email | string | A case-sensitive filter on the list based on the customer's email field. The value must be a string. | |
ending_before | string | 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. | |
expand[0] | string | Specifies which fields in the response should be expanded. | |
expand[1] | string | Specifies which fields in the response should be expanded. | |
limit | string | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. | |
starting_after | string | 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_clock | string | 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. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
[{"id":"cus_NffrFeUfNV2Hib","object":"customer","address":null,"balance":0,"created":1680893993,"currency":null,"default_source":null,"delinquent":false,"description":null,"discount":null,"email":"jennyrosen@example.com","invoice_prefix":"0759376C","invoice_settings":{"custom_fields":null,"default_payment_method":null,"footer":null,"rendering_options":null},"livemode":false,"metadata":{},"name":"Jenny Rosen","next_invoice_sequence":1,"phone":null,"preferred_locales":[],"shipping":null,"tax_exempt":"none","test_clock":null}]