Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Reserves
Fraud
Issuing
Terminal
Treasury
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Privacy
Webhooks

List all cardholders 

Issuing
Cardholders
List all cardholders

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.

Parameters

No parameters.

More parameters

  • createdobject

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

    • created.gtinteger

      Minimum value to filter by (exclusive)

    • created.gteinteger

      Minimum value to filter by (inclusive)

    • created.ltinteger

      Maximum value to filter by (exclusive)

    • created.lteinteger

      Maximum value to filter by (inclusive)

  • 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.

  • 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.

  • statusenum

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

    Possible enum values
    active

    Cards attached to this cardholder can approve authorizations.

    blocked

    Cards attached to this cardholder will decline all authorizations with the cardholder_blocked reason. This status is non-reversible.

    inactive

    Cards attached to this cardholder will decline all authorizations with the cardholder_inactive reason.

  • typeenum

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

    Possible enum values
    company

    The cardholder is a company or business entity, and additional information includes their tax ID. This option may not be available if your use case only supports individual cardholders.

    individual

    The cardholder is a person, and additional information includes first and last name, date of birth, etc. If you’re issuing Celtic Spend Cards, then Individual cardholders must accept Authorized User Terms prior to activating their card.

Returns

A dictionary with a data property that contains an array of up to limit cardholders, starting after cardholder starting_after. Each entry in the array is a separate Issuing Cardholder object. If no more cardholders are available, the resulting array will be empty.

GET /v1/issuing/cardholders
curl -G https://api.stripe.com/v1/issuing/cardholders \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d limit=3
Response
{
  "object": "list",
  "url": "/v1/issuing/cardholders",
  "has_more": false,
  "data": [
    {
      "id": "ich_1MsKAB2eZvKYlo2C3eZ2BdvK",
      "object": "issuing.cardholder",
      "billing": {
        "address": {
          "line1": "1234 Main Street",
          "city": "San Francisco",
          "state": "CA",
          "country": "US",
          "postal_code": "94111"
        }
      },
      "company": null,
      "created": 1680415995,
      "email": "jenny.rosen@example.com",
      "individual": null,
      "livemode": false,
      "metadata": {},
      "name": "Jenny Rosen",
      "phone_number": "+18888675309",
      "redaction": null,
      "requirements": {
        "disabled_reason": "requirements.past_due",
        "past_due": [
          "individual.card_issuing.user_terms_acceptance.ip",
          "individual.card_issuing.user_terms_acceptance.date",
          "individual.first_name",
          "individual.last_name"
        ]
      },
      "spending_controls": {
        "allowed_categories": [],
        "blocked_categories": [],
        "spending_limits": [],
        "spending_limits_currency": null
      },
      "status": "active",
      "type": "individual"
    }
  ]
}