Attributes
- idstring
Unique identifier for the object.
- billingobject
The cardholder’s billing information.
- billing.
addressobject The cardholder’s billing address.
- billing.
address. citynullable string City, district, suburb, town, or village.
- billing.
address. countrynullable string Two-letter country code (ISO 3166-1 alpha-2).
- billing.
address. line1nullable string Address line 1 (e.g., street, PO Box, or company name).
- billing.
address. line2nullable string Address line 2 (e.g., apartment, suite, unit, or building).
- billing.
address. postal_ codenullable string ZIP or postal code.
- billing.
address. statenullable string State, county, province, or region.
- emailnullable string
The cardholder’s email address.
- metadataobject
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- namestring
The cardholder’s name. This will be printed on cards issued to them.
- phone_
numbernullable string The cardholder’s phone number. This is required for all cardholders who will be creating EU cards. See the 3D Secure documentation for more details.
More attributes
- objectstring
String representing the object’s type. Objects of the same type share the same value.
- companynullable object
Additional information about a
company
cardholder.- company.
tax_ id_ providedboolean Whether the company’s business ID number was provided.
- createdtimestamp
Time at which the object was created. Measured in seconds since the Unix epoch.
- individualnullable object
Additional information about an
individual
cardholder.- individual.
card_ issuingnullable object Information related to the card_issuing program for this cardholder.
- individual.
card_issuing. user_ terms_ acceptancenullable object Information about cardholder acceptance of Celtic Authorized User Terms. Required for cards backed by a Celtic program.
- individual.
card_issuing. user_terms_acceptance. datenullable timestamp The Unix timestamp marking when the cardholder accepted the Authorized User Terms.
- individual.
card_issuing. user_terms_acceptance. ipnullable string The IP address from which the cardholder accepted the Authorized User Terms.
- individual.
card_issuing. user_terms_acceptance. user_ agentnullable string The user agent of the browser from which the cardholder accepted the Authorized User Terms.
- individual.
dobnullable object The date of birth of this cardholder.
- individual.
dob. daynullable integer The day of birth, between 1 and 31.
- individual.
dob. monthnullable integer The month of birth, between 1 and 12.
- individual.
dob. yearnullable integer The four-digit year of birth.
- individual.
first_ namenullable string 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.
- individual.
last_ namenullable string 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.
- individual.
verificationnullable object Government-issued ID document for this cardholder.
- individual.
verification. documentnullable object An identifying document, either a passport or local ID card.
- individual.
verification. document. backnullable stringExpandable The back of a document returned by a file upload with a
purpose
value ofidentity_
.document - individual.
verification. document. frontnullable stringExpandable The front of a document returned by a file upload with a
purpose
value ofidentity_
.document
- livemodeboolean
Has the value
true
if the object exists in live mode or the valuefalse
if the object exists in test mode. - preferred_
localesnullable array of enums The cardholder’s preferred locales (languages), ordered by preference. Locales can be
de
,en
,es
,fr
, orit
. This changes the language of the 3D Secure flow and one-time password messages sent to the cardholder. - requirementsobject
Information about verification requirements for the cardholder.
- requirements.
disabled_ reasonnullable enum If
disabled_
is present, all cards will decline authorizations withreason cardholder_
reason.verification_ required Possible enum valueslisted
Account might be on a prohibited persons or companies list. The
past_
field contains information that you need to provide before the cardholder can approve authorizations.due rejected.
listed Cardholder is rejected because they are on a third-party prohibited persons or companies list (such as financial services provider or government). Their status will be
blocked
.requirements.
past_ due Cardholder has outstanding requirements. The
past_
field contains information that you need to provide before the cardholder can activate cards.due under_
review This cardholder has raised additional review. Stripe will make a decision and update the
disabled_
field.reason - requirements.
past_ duenullable array of enums Array of fields that need to be collected in order to verify and re-enable the cardholder.
Possible enum valuescompany.
tax_ id The cardholder’s business number (Tax ID).
individual.
card_ issuing. user_ terms_ acceptance. date The Unix timestamp marking when the Cardholder accepted their Authorized User Terms. Required for Celtic Spend Card users.
individual.
card_ issuing. user_ terms_ acceptance. ip The IP address from which the Cardholder accepted their Authorized User Terms. Required for Celtic Spend Card users.
individual.
dob. day The cardholder’s date of birth’s day.
individual.
dob. month The cardholder’s date of birth’s month.
individual.
dob. year The cardholder’s date of birth’s year.
individual.
first_ name The cardholder’s legal first name.
individual.
last_ name The cardholder’s legal last name.
individual.
verification. document The front and back of a government-issued form of identification.
- spending_
controlsnullable object Rules that control spending across this cardholder’s cards. Refer to our documentation for more details.
- spending_controls.
allowed_ categoriesnullable array of enums Array of strings containing categories of authorizations to allow. All other categories will be blocked. Cannot be set with
blocked_
.categories Possible enum valuesac_
refrigeration_ repair accounting_
bookkeeping_ services advertising_
services agricultural_
cooperative airlines_
air_ carriers airports_
flying_ fields ambulance_
services amusement_
parks_ carnivals antique_
reproductions antique_
shops Show 285 more - spending_controls.
allowed_ merchant_ countriesnullable array of strings Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g.
US
). Cannot be set withblocked_
. Provide an empty value to unset this control.merchant_ countries - spending_controls.
blocked_ categoriesnullable array of enums Array of strings containing categories of authorizations to decline. All other categories will be allowed. Cannot be set with
allowed_
.categories Possible enum valuesac_
refrigeration_ repair accounting_
bookkeeping_ services advertising_
services agricultural_
cooperative airlines_
air_ carriers airports_
flying_ fields ambulance_
services amusement_
parks_ carnivals antique_
reproductions antique_
shops Show 285 more - spending_controls.
blocked_ merchant_ countriesnullable array of strings Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g.
US
). Cannot be set withallowed_
. Provide an empty value to unset this control.merchant_ countries - spending_controls.
spending_ limitsnullable array of objects Limit spending with amount-based rules that apply across this cardholder’s cards.
- spending_controls.
spending_limits. amountinteger Maximum amount allowed to spend per interval. This amount is in the card’s currency and in the smallest currency unit.
- spending_controls.
spending_limits. categoriesnullable array of enums Array of strings containing categories this limit applies to. Omitting this field will apply the limit to all categories.
Possible enum valuesac_
refrigeration_ repair accounting_
bookkeeping_ services advertising_
services agricultural_
cooperative airlines_
air_ carriers airports_
flying_ fields ambulance_
services amusement_
parks_ carnivals antique_
reproductions antique_
shops Show 285 more - spending_controls.
spending_limits. intervalenum Interval (or event) to which the amount applies.
Possible enum valuesall_
time Limit applies to all transactions.
daily
Limit applies to a day, starting at midnight UTC.
monthly
Limit applies to a month, starting on the 1st at midnight UTC.
per_
authorization Limit applies to each authorization.
weekly
Limit applies to a week, starting on Sunday at midnight UTC.
yearly
Limit applies to a year, starting on January 1st at midnight UTC.
- spending_controls.
spending_ limits_ currencynullable enum Currency of the amounts within
spending_
.limits
- statusenum
Specifies whether to permit authorizations on this cardholder’s cards.
Possible enum valuesactive
Cards attached to this cardholder can approve authorizations.
blocked
Cards attached to this cardholder will decline all authorizations with the
cardholder_
reason. This status is non-reversible.blocked inactive
Cards attached to this cardholder will decline all authorizations with the
cardholder_
reason.inactive - typeenum
One of
individual
orcompany
. See Choose a cardholder type for more details.Possible enum valuescompany
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.
{ "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"}