Stripe: List all cardholders

← Issuing operations · Get started

Operation stripe.getissuingcardholders

Provider route: GET /v1/issuing/cardholders. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/stripe with npm, or alter-sdk-stripe with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { StripeIntegration } from "@alter-ai/stripe";

async function execute(input: Parameters<StripeIntegration["issuing"]["getIssuingCardholders"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new StripeIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.issuing.getIssuingCardholders(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_stripe import StripeIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = StripeIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.issuing.get_issuing_cardholders(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.created	JSON	Optional
query.created (anyOf 1)	object	Alternative
query.created (anyOf 1).gt	integer	Optional
query.created (anyOf 1).gte	integer	Optional
query.created (anyOf 1).lt	integer	Optional
query.created (anyOf 1).lte	integer	Optional
query.created (anyOf 2)	integer	Alternative
query.email	string	Optional
query.ending_before	string	Optional	Maximum length: 5000
query.expand	array	Optional
query.expand[]	string	Each item	Maximum length: 5000
query.limit	integer	Optional
query.phone_number	string	Optional
query.starting_after	string	Optional	Maximum length: 5000
query.status	string	Optional	One of: active, blocked, inactive
query.type	string	Optional	One of: company, individual

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	object	Root
data	array	Required within parent
data[]	Model	Each item	Expand Create a cardholder — response body
has_more	boolean	Required within parent	True if this list has another page of items after this one that can be fetched.
object	string	Required within parent	String representing the object’s type. Objects of the same type share the same value. Always has the value `list`. Known values: list
url	string	Required within parent	The URL where this list can be accessed. Maximum length: 5000 Pattern: ^/v1/issuing/cardholders

Referenced models: Create a cardholder — response body

Schemas

10 more schemas are linked from the tables above, on the schema pages.

Create a cardholder — response body

Field	Type	Presence	Description and constraints
$	object	Root	An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://docs.stripe.com/issuing) cards. Related guide: [How to create a cardholder](https://docs.stripe.com/issuing/cards/virtual/issue-cards#create-cardholder)
billing	Model	Required within parent	Expand Create a cardholder — response body — billing
company	JSON	Optional
company (anyOf 1)	JSON	Alternative	Additional information about a `company` cardholder.
company (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a cardholder — response body — company value tax id provided
company (anyOf 2)	null	Alternative
created	JSON	Required within parent
created (anyOf 1)	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
created (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
email	JSON	Optional
email (anyOf 1)	string	Alternative	The cardholder's email address. Maximum length: 5000
email (anyOf 2)	null	Alternative
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
individual	JSON	Optional
individual (anyOf 1)	JSON	Alternative	Additional information about an `individual` cardholder.
individual (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a cardholder — response body — individual value card issuing, dob, first name, last name, verification
individual (anyOf 2)	null	Alternative
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
metadata	object	Required within parent	Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Additional keys: see wildcard field
metadata.*	string	Additional keys	Maximum length: 500
name	string	Required within parent	The cardholder's name. This will be printed on cards issued to them. Maximum length: 5000
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: issuing.cardholder
phone_number	JSON	Optional
phone_number (anyOf 1)	string	Alternative	The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://docs.stripe.com/issuing/3d-secure#when-is-3d-secure-applied) for more details. Maximum length: 5000
phone_number (anyOf 2)	null	Alternative
preferred_locales	JSON	Optional
preferred_locales (anyOf 1)	array	Alternative	The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`. This changes the language of the [3D Secure flow](https://docs.stripe.com/issuing/3d-secure) and one-time password messages sent to the cardholder.
preferred_locales (anyOf 1)[]	string	Each item	Known values: de, en, es, fr, it
preferred_locales (anyOf 2)	null	Alternative
requirements	Model	Required within parent	Expand Create a cardholder — response body — requirements
spending_controls	JSON	Optional
spending_controls (anyOf 1)	JSON	Alternative	Rules that control spending across this cardholder's cards. Refer to our [documentation](https://docs.stripe.com/issuing/controls/spending-controls) for more details.
spending_controls (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a cardholder — response body — spending controls value allowed card presences, allowed categories, allowed merchant countries, blocked card presences, blocked categories, blocked merchant countries, spending limits, spending limits currency
spending_controls (anyOf 2)	null	Alternative
status	string	Required within parent	Specifies whether to permit authorizations on this cardholder's cards. Known values: active, blocked, inactive
type	string	Required within parent	One of `individual` or `company`. See [Choose a cardholder type](https://docs.stripe.com/issuing/other/choose-cardholder) for more details. Known values: company, individual

Referenced models: Create a cardholder — response body — billing, Create a cardholder — response body — spending controls value allowed card presences, allowed categories, allowed merchant countries, blocked card presences, blocked categories, blocked merchant countries, spending limits, spending limits currency, Create a cardholder — response body — company value tax id provided, Create a cardholder — response body — individual value card issuing, dob, first name, last name, verification, Create a cardholder — response body — requirements

Create a cardholder — response body — billing

Field	Type	Presence	Description and constraints
$	object	Root
address	Model	Required within parent	Expand Create a Location — response body — address

Referenced models: Create a Location — response body — address

Create a cardholder — response body — company value tax id provided

Field	Type	Presence	Description and constraints
$	object	Root
tax_id_provided	boolean	Required within parent	Whether the company's business ID number was provided.

Create a cardholder — response body — individual value card issuing, dob, first name, last name, verification

Field	Type	Presence	Description and constraints
$	object	Root
card_issuing	JSON	Optional
card_issuing (anyOf 1)	JSON	Alternative	Information related to the card_issuing program for this cardholder.
card_issuing (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a cardholder — response body — individual value card issuing, dob, first name, last name, verification card issuing value user terms acceptance
card_issuing (anyOf 2)	null	Alternative
dob	JSON	Optional
dob (anyOf 1)	JSON	Alternative	The date of birth of this cardholder.
dob (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a person — accounts post Accounts Account People — response body — dob
dob (anyOf 2)	null	Alternative
first_name	JSON	Optional
first_name (anyOf 1)	string	Alternative	The first name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters. Maximum length: 5000
first_name (anyOf 2)	null	Alternative
last_name	JSON	Optional
last_name (anyOf 1)	string	Alternative	The last name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters. Maximum length: 5000
last_name (anyOf 2)	null	Alternative
verification	JSON	Optional
verification (anyOf 1)	JSON	Alternative	Government-issued ID document for this cardholder.
verification (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a cardholder — response body — individual value card issuing, dob, first name, last name, verification verification Government-issued ID document for this cardholder document
verification (anyOf 2)	null	Alternative

Referenced models: Create a cardholder — response body — individual value card issuing, dob, first name, last name, verification card issuing value user terms acceptance, Create a person — accounts post Accounts Account People — response body — dob, Create a cardholder — response body — individual value card issuing, dob, first name, last name, verification verification Government-issued ID document for this cardholder document

Create a cardholder — response body — requirements

Field	Type	Presence	Description and constraints
$	object	Root
disabled_reason	JSON	Optional
disabled_reason (anyOf 1)	string	Alternative	If `disabled_reason` is present, all cards will decline authorizations with `cardholder_verification_required` reason. Known values: listed, rejected.listed, requirements.past_due, under_review
disabled_reason (anyOf 2)	null	Alternative
past_due	JSON	Optional
past_due (anyOf 1)	array	Alternative	Array of fields that need to be collected in order to verify and re-enable the cardholder.
past_due (anyOf 1)[]	string	Each item	Known values: company.tax_id, individual.card_issuing.user_terms_acceptance.date, individual.card_issuing.user_terms_acceptance.ip, individual.dob.day, individual.dob.month, individual.dob.year, individual.first_name, individual.last_name, individual.verification.document
past_due (anyOf 2)	null	Alternative

Policy, approvals and errors

SDK function policy ID: stripe.getissuingcardholders. Catalog operation: GetIssuingCardholders. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"Stripe-Version": "2026-09-30.endive"}

Official provider source