StripeAPI.Types.Customer

address: The customer's address.

balance: Current balance, if any, being stored on the customer. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that will be added to their next invoice. The balance does not refer to any unpaid invoices; it solely takes into account amounts that have yet to be successfully applied to any invoice. This balance is only taken into account as invoices are finalized.

cash_balance: The current funds being held by Stripe on behalf of the customer. These funds can be applied towards payment intents with source "cash_balance".The settings[reconciliation_mode] field describes whether these funds are applied to such payment intents manually or automatically.

created: Time at which the object was created. Measured in seconds since the Unix epoch.

currency: Three-letter ISO code for the currency the customer can be charged in for recurring billing purposes.

Constraints:

• Maximum length of 5000

default_source: ID of the default payment source for the customer.

If you are using payment methods created via the PaymentMethods API, see the invoice_settings.default_payment_method field instead.

delinquent: When the customer's latest invoice is billed by charging automatically, `delinquent` is `true` if the invoice's latest charge failed. When the customer's latest invoice is billed by sending an invoice, `delinquent` is `true` if the invoice isn't paid by its due date.

If an invoice is marked uncollectible by dunning, `delinquent` doesn't get reset to `false`.

description: An arbitrary string attached to the object. Often useful for displaying to users.

Constraints:

• Maximum length of 5000

discount: Describes the current discount active on the customer, if there is one.

email: The customer's email address.

Constraints:

• Maximum length of 5000

id: Unique identifier for the object.

Constraints:

• Maximum length of 5000

invoice_prefix: The prefix for the customer used to generate unique invoice numbers.

Constraints:

• Maximum length of 5000

invoice_settings:

livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

metadata: 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.

name: The customer's full name or business name.

Constraints:

• Maximum length of 5000

next_invoice_sequence: The suffix of the customer's next invoice number, e.g., 0001.

phone: The customer's phone number.

Constraints:

• Maximum length of 5000

preferred_locales: The customer's preferred locales (languages), ordered by preference.

shipping: Mailing and shipping address for the customer. Appears on invoices emailed to this customer.

sources: The customer's payment sources, if any.

subscriptions: The customer's current subscriptions, if any.

tax:

tax_exempt: Describes the customer's tax exemption status. One of `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the text **"Reverse charge"**.

tax_ids: The customer's tax IDs.

test_clock: ID of the test clock this customer belongs to.

city: City, district, suburb, town, or village.

Constraints:

• Maximum length of 5000

country: Two-letter country code (ISO 3166-1 alpha-2).

Constraints:

• Maximum length of 5000

line1: Address line 1 (e.g., street, PO Box, or company name).

Constraints:

• Maximum length of 5000

line2: Address line 2 (e.g., apartment, suite, unit, or building).

Constraints:

• Maximum length of 5000

postal_code: ZIP or postal code.

Constraints:

• Maximum length of 5000

state: State, county, province, or region.

Constraints:

• Maximum length of 5000

available: A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0.

customer: The ID of the customer whose cash balance this object represents.

Constraints:

• Maximum length of 5000

livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

object: String representing the object's type. Objects of the same type share the same value.

settings:

checkout_session: The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode.

Constraints:

• Maximum length of 5000

coupon: A coupon contains information about a percent-off or amount-off discount you might want to apply to a customer. Coupons may be applied to subscriptions, invoices, checkout sessions, quotes, and more. Coupons do not work with conventional one-off charges or payment intents.

customer: The ID of the customer associated with this discount.

end: If the coupon has a duration of `repeating`, the date that this discount will end. If the coupon has a duration of `once` or `forever`, this attribute will be null.

id: The ID of the discount object. Discounts cannot be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array.

Constraints:

• Maximum length of 5000

invoice: The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice.

Constraints:

• Maximum length of 5000

invoice_item: The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item.

Constraints:

• Maximum length of 5000

object: String representing the object's type. Objects of the same type share the same value.

promotion_code: The promotion code applied to create this discount.

start: Date that the coupon was applied.

subscription: The subscription that this coupon is applied to, if it is applied to a particular subscription.

Constraints:

• Maximum length of 5000

address:

carrier: The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.

Constraints:

• Maximum length of 5000

name: Recipient name.

Constraints:

• Maximum length of 5000

phone: Recipient phone (including extension).

Constraints:

• Maximum length of 5000

tracking_number: The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.

Constraints:

• Maximum length of 5000

data: Details about each object.

has_more: True if this list has another page of items after this one that can be fetched.

url: The URL where this list can be accessed.

Constraints:

• Maximum length of 5000

account: The ID of the account that the bank account is associated with.

account_holder_name: The name of the person or business that owns the bank account.

Constraints:

• Maximum length of 5000

account_holder_type: The type of entity that holds the account. This can be either `individual` or `company`.

Constraints:

• Maximum length of 5000

account_type: The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`.

Constraints:

• Maximum length of 5000

ach_credit_transfer

ach_debit

acss_debit

active: True when this bitcoin receiver has received a non-zero amount of bitcoin.

address_city: City/District/Suburb/Town/Village.

Constraints:

• Maximum length of 5000

address_country: Billing address country, if provided when creating card.

Constraints:

• Maximum length of 5000

address_line1: Address line 1 (Street address/PO Box/Company name).

Constraints:

• Maximum length of 5000

address_line1_check: If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.

Constraints:

• Maximum length of 5000

address_line2: Address line 2 (Apartment/Suite/Unit/Building).

Constraints:

• Maximum length of 5000

address_state: State/County/Province/Region.

Constraints:

• Maximum length of 5000

address_zip: ZIP or postal code.

Constraints:

• Maximum length of 5000

address_zip_check: If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.

Constraints:

• Maximum length of 5000

alipay

amount: The amount of `currency` that you are collecting as payment.

amount_received: The amount of `currency` to which `bitcoin_amount_received` has been converted.

au_becs_debit

available_payout_methods: A set of available payout methods for this bank account. Only values from this set should be passed as the `method` when creating a payout.

bancontact

bank_name: Name of the bank associated with the routing number (e.g., `WELLS FARGO`).

Constraints:

• Maximum length of 5000

bitcoin_amount: The amount of bitcoin that the customer should send to fill the receiver. The `bitcoin_amount` is denominated in Satoshi: there are 10^8 Satoshi in one bitcoin.

bitcoin_amount_received: The amount of bitcoin that has been sent by the customer to this receiver.

bitcoin_uri: This URI can be displayed to the customer as a clickable link (to activate their bitcoin client) or as a QR code (for mobile wallets).

Constraints:

• Maximum length of 5000

brand: Card brand. Can be `American Express`, `Diners Club`, `Discover`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.

Constraints:

• Maximum length of 5000

card

card_present

client_secret: The client secret of the source. Used for client-side retrieval using a publishable key.

Constraints:

• Maximum length of 5000

code_verification:

country: Two-letter ISO code representing the country the bank account is located in.

Constraints:

• Maximum length of 5000

created: Time at which the object was created. Measured in seconds since the Unix epoch.

currency: Three-letter ISO code for the currency paid out to the bank account.

customer: The ID of the customer associated with this Alipay Account.

cvc_check: If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see Check if a card is valid without a charge.

Constraints:

• Maximum length of 5000

default_for_currency: Whether this bank account is the default external account for its currency.

description: An arbitrary string attached to the object. Often useful for displaying to users.

Constraints:

• Maximum length of 5000

dynamic_last4: (For tokenized numbers only.) The last four digits of the device account number.

Constraints:

• Maximum length of 5000

email: The customer's email address, set by the API call that creates the receiver.

Constraints:

• Maximum length of 5000

eps

exp_month: Two-digit number representing the card's expiration month.

exp_year: Four-digit number representing the card's expiration year.

filled: This flag is initially false and updates to true when the customer sends the `bitcoin_amount` to this receiver.

fingerprint: Uniquely identifies the account and will be the same across all Alipay account objects that are linked to the same Alipay account.

Constraints:

• Maximum length of 5000

flow: The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`.

Constraints:

• Maximum length of 5000

funding: Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.

Constraints:

• Maximum length of 5000

giropay

id: Unique identifier for the object.

Constraints:

• Maximum length of 5000

ideal

inbound_address: A bitcoin address that is specific to this receiver. The customer can send bitcoin to this address to fill the receiver.

Constraints:

• Maximum length of 5000

klarna

last4: The last four digits of the bank account number.

Constraints:

• Maximum length of 5000

livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

metadata: 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.

multibanco

name: Cardholder name.

Constraints:

• Maximum length of 5000

object: String representing the object's type. Objects of the same type share the same value.

owner: Information about the owner of the payment instrument that may be used or required by particular source types.

p24

payment: The ID of the payment created from the receiver, if any. Hidden when viewing the receiver with a publishable key.

Constraints:

• Maximum length of 5000

payment_amount: If the Alipay account object is not reusable, the exact amount that you can create a charge for.

payment_currency: If the Alipay account object is not reusable, the exact currency that you can create a charge for.

receiver:

recipient: The recipient that this card belongs to. This attribute will not be in the card object if the card belongs to a customer or account instead.

redirect:

refund_address: The refund address of this bitcoin receiver.

Constraints:

• Maximum length of 5000

reusable: True if you can create multiple payments using this account. If the account is reusable, then you can freely choose the amount of each payment.

routing_number: The routing transit number for the bank account.

Constraints:

• Maximum length of 5000

sepa_debit

sofort

source_order:

statement_descriptor: Extra information about a source. This will appear on your customer's statement every time you charge the source.

Constraints:

• Maximum length of 5000

status: For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a transfer sent to this bank account fails, we'll set the status to `errored` and will not continue to send transfers until the bank details are updated.

For external accounts, possible values are `new` and `errored`. Validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply. If a transfer fails, the status is set to `errored` and transfers are stopped until account details are updated.

Constraints:

• Maximum length of 5000

three_d_secure

tokenization_method: If the card number is tokenized, this is the method that was used. Can be `android_pay` (includes Google Pay), `apple_pay`, `masterpass`, `visa_checkout`, or null.

Constraints:

• Maximum length of 5000

transactions: A list with one entry for each time that the customer sent bitcoin to the receiver. Hidden when viewing the receiver with a publishable key.

type: The `type` of the source. The `type` is a payment method, one of `ach_credit_transfer`, `ach_debit`, `alipay`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `multibanco`, `klarna`, `p24`, `sepa_debit`, `sofort`, `three_d_secure`, or `wechat`. An additional hash is included on the source with a name matching this value. It contains additional information specific to the payment method used.

uncaptured_funds: This receiver contains uncaptured funds that can be used for a payment or refunded.

usage: Either `reusable` or `single_use`. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned.

Constraints:

• Maximum length of 5000

used: Whether this Alipay account object has ever been used for a payment.

used_for_payment: Indicate if this source is used for payment.

username: The username for the Alipay account.

Constraints:

• Maximum length of 5000

wechat

address: Owner's address.

email: Owner's email address.

Constraints:

• Maximum length of 5000

name: Owner's full name.

Constraints:

• Maximum length of 5000

phone: Owner's phone number (including extension).

Constraints:

• Maximum length of 5000

verified_address: Verified owner's address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.

verified_email: Verified owner's email address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.

Constraints:

• Maximum length of 5000

verified_name: Verified owner's full name. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.

Constraints:

• Maximum length of 5000

verified_phone: Verified owner's phone number (including extension). Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated.

Constraints:

• Maximum length of 5000

city: City, district, suburb, town, or village.

Constraints:

• Maximum length of 5000

country: Two-letter country code (ISO 3166-1 alpha-2).

Constraints:

• Maximum length of 5000

line1: Address line 1 (e.g., street, PO Box, or company name).

Constraints:

• Maximum length of 5000

line2: Address line 2 (e.g., apartment, suite, unit, or building).

Constraints:

• Maximum length of 5000

postal_code: ZIP or postal code.

Constraints:

• Maximum length of 5000

state: State, county, province, or region.

Constraints:

• Maximum length of 5000

city: City, district, suburb, town, or village.

Constraints:

• Maximum length of 5000

country: Two-letter country code (ISO 3166-1 alpha-2).

Constraints:

• Maximum length of 5000

line1: Address line 1 (e.g., street, PO Box, or company name).

Constraints:

• Maximum length of 5000

line2: Address line 2 (e.g., apartment, suite, unit, or building).

Constraints:

• Maximum length of 5000

postal_code: ZIP or postal code.

Constraints:

• Maximum length of 5000

state: State, county, province, or region.

Constraints:

• Maximum length of 5000

data: Details about each object.

has_more: True if this list has another page of items after this one that can be fetched.

url: The URL where this list can be accessed.

Constraints:

• Maximum length of 5000

data: Details about each object.

has_more: True if this list has another page of items after this one that can be fetched.

url: The URL where this list can be accessed.

Constraints:

• Maximum length of 5000

data: Details about each object.

has_more: True if this list has another page of items after this one that can be fetched.

url: The URL where this list can be accessed.

Constraints:

• Maximum length of 5000