List all cardholders

Changed on

Returns a list of Issuing Cardholder objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

get/v1/issuing/cardholders

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/issuing/cardholders
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Query parameters

OR
integer

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

emailstring

Only return cardholders that have the given email address.

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.

phone_numberstring

Only return cardholders that have the given phone number.

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.

status'active' | 'blocked' | 'inactive'

Only return cardholders that have the given status. One of active, inactive, or blocked.

type'company' | 'individual'

Only return cardholders that have the given type. One of individual or company.

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

  • e24a26de4188Revision changes
    • breaking

      removed the required property //////////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    This list may be incomplete.

Some revisions have not been checked yet.