provider GET
/v1/issuing/cardholders @utdk/stripe
/v1/issuing/cardholders List all cardholders
<p>Returns a list of Issuing <code>Cardholder</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.</p>
- created query
- Only return cardholders that were created during the given date interval.
- email query
- Only return cardholders that have the given email address.
- 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
- phone_number query
- Only return cardholders that have the given phone number.
- string
- 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
- status query
- Only return cardholders that have the given status. One of `active`, `inactive`, or `blocked`.
- enum: active, blocked, inactive
- type query
- Only return cardholders that have the given type. One of `individual` or `company`.
- enum: company, individual
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.
Code snippet
Updates live as you fill in the form above.
TypeScript
import stripe from '@utdk/stripe';
await stripe.getissuingcardholders()