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.

Table Specific Information

Select

Server-Side Query Support

The cmdlet uses the Stripe API to filter the results by the following columns and operators while the rest of the filter is executed client-side within the cmdlet.

Id supports the following operator: =.
Created supports the following operator: =.
Email supports the following operator: =.
PhoneNumber supports the following operator: =.
Status supports the following operator: =.
Type supports the following operator: =.

You can select from BalanceTransactions with the following queries:

    SELECT * FROM Cardholders WHERE Id = 'ich_1OctV22eZvKYlo2C6ETSndgk'
    SELECT * FROM Cardholders WHERE Created = '2024-01-18 02:16:47.0'
    SELECT * FROM Cardholders WHERE PhoneNumber = '+1234567890'
    SELECT * FROM Cardholders WHERE Email = '[email protected]'

Columns


Name	Type	References	Description
Id [KEY]	String		Unique identifier for the object.
BillingAddressCity	String		City, district, suburb, town, or village.
BillingAddressCountry	String		Two-letter country code
BillingAddressLine1	String		Address line 1
BillingAddressLine2	String		Address line 2
BillingAddressPostalCode	String		ZIP or postal code.
BillingAddressState	String		State, county, province, or region.
Email	String		The cardholders email address.
MetadataAggregate	String		The set of key/value pairs that you can attach to a an object.
Name	String		The cardholders name. This will be printed on cards issued to them.
IsCompanyTaxIdProvided	Boolean		The cardholders phone number.
Created	Datetime		Time at which the object was created. Measured in seconds since the Unix epoch.
Individual	String		Additional information about an individual cardholder.
Livemode	Boolean		Has the value true if the object exists in live mode or the value false if the object exists in test mode.
Object	String		String representing the objects type. Objects of the same type share the same value.
PhoneNumber	String		The cardholders phone number.
RequirementsDisabledReason	String		If disabled_reason is present, all cards will decline authorizations with cardholder_verification_required reason.
RequirementsPastDue	String		Array of fields that need to be collected in order to verify and re-enable the cardholder.
SpendingControlsAllowedCategories	String		Array of strings containing categories of authorizations to allow.
SpendingControlsBlockedCategories	String		Array of strings containing categories of authorizations to decline.
SpendingControlsSpendingLimits	String		Limit spending with amount-based rules that apply across this cardholders cards.
SpendingControlsSpendingLimitsCurrency	String		Currency of the amounts within spending_limits.
Status	String		Specifies whether to permit authorizations on this cardholders cards.
Type	String		One of individual or company.
PreferredLocales	String		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 and one-time password messages sent to the cardholder.
SpendingControlsAllowedMerchantCountries	String		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 with blocked_merchant_countries. Provide an empty value to unset this control.
SpendingControlsBlockedMerchantCountries	String		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 with allowed_merchant_countries. Provide an empty value to unset this control.

Cmdlets for Stripe

Cardholders

Table Specific Information

Select

Server-Side Query Support

Columns