provider GET /v1/customers
@utdk/stripe /v1/customers
List all customers
<p>Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.</p>
created query
Only return customers that were created during the given date interval.
email query
A case-sensitive filter on the list based on the customer's `email` field. The value must be a string.
string
ending_before query
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.
string
expand query
Specifies which fields in the response should be expanded.
array
limit query
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
integer
starting_after query
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.
string
test_clock query
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.
string

Try it

Authentication
Configure credentials for Stripe API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

getcustomers
GET/v1/customers
<p>Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.</p>

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

A case-sensitive filter on the list based on the customer's `email` field. The value must be a 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.

Specifies which fields in the response should be expanded.

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

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.

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.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import stripe from '@utdk/stripe';

await stripe.getcustomers()