Search customers
GET {{baseUrl}}/v1/customers/search?query=<string>
Search for customers you’ve previously created using Stripe’s Search Query Language. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
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. | |
page | string | A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. | |
query | string | (Required) The search query string. See search query language and the list of supported query fields for customers. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"object":"search_result","url":"/v1/customers/search","has_more":false,"data":[{"id":"cus_NeGfPRiPKxeBi1","object":"customer","address":null,"balance":0,"created":1680569616,"currency":null,"default_source":null,"delinquent":false,"description":null,"discount":null,"email":null,"invoice_prefix":"47D37F8F","invoice_settings":{"custom_fields":null,"default_payment_method":"pm_1Msy7wLkdIwHu7ixsxmFvcz7","footer":null,"rendering_options":null},"livemode":false,"metadata":{"foo":"bar"},"name":"Jane Doe","next_invoice_sequence":1,"phone":null,"preferred_locales":[],"shipping":null,"tax_exempt":"none","test_clock":null}]}