--- title: "List Accounts" method: GET path: "/v1/linked_accounts" --- # List Accounts `GET /v1/linked_accounts` Returns a list of Financial Connections `Account` objects. ## Query parameters - `account_holder` object - `account` string - `customer` string - `customer_account` string - `ending_before` string - `expand` string[] - `limit` integer - `session` string - `starting_after` string ## Response `200` Successful response. - object - `data` FinancialConnectionsAccount[], required — Details about each object. - `account_holder` BankConnectionsResourceAccountholder - `account` union — The ID of the Stripe account that this account belongs to. Only available when `account_holder.type` is `account`. - string - Account — For new integrations, we recommend using the [Accounts v2 API](/api/v2/core/accounts), in place of /v1/accounts and /v1/customers to represent a user. This is an object representing a Stripe account. You can retrieve it to see properties on the account like its current requirements or if the account is enabled to make live charges or receive payouts. For accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, the properties below are always returned. For accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, some properties are only returned until you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions) to start Connect Onboarding. Learn about the [differences between accounts](/connect/accounts). - `business_profile` AccountBusinessProfile - `annual_revenue` AccountAnnualRevenue - … - `estimated_worker_count` integer, nullable — An estimated upper bound of employees, contractors, vendors, etc. currently working for the business. - `mcc` string, nullable — [The merchant category code for the account](/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide. - `minority_owned_business_designation` string[], nullable — Whether the business is a minority-owned, women-owned, and/or LGBTQI+ -owned business. - `monthly_estimated_revenue` AccountMonthlyEstimatedRevenue - … - `name` string, nullable — The customer-facing business name. - `product_description` string, nullable — Internal-only description of the product sold or service provided by the business. It's used by Stripe for risk and underwriting purposes. - `support_address` Address - … - `support_email` string, nullable — A publicly available email address for sending support issues to. - `support_phone` string, nullable — A publicly available phone number to call with support issues. - `support_url` string, nullable — A publicly available website for handling support issues. - `url` string, nullable — The business's publicly available website. - `business_type` 'company' | 'government_entity' | 'individual' | 'non_profit', nullable — The business type. - `capabilities` AccountCapabilities - `acss_debit_payments` 'active' | 'inactive' | 'pending' — The status of the Canadian pre-authorized debits payments capability of the account, or whether the account can directly process Canadian pre-authorized debits charges. - `affirm_payments` 'active' | 'inactive' | 'pending' — The status of the Affirm capability of the account, or whether the account can directly process Affirm charges. - `afterpay_clearpay_payments` 'active' | 'inactive' | 'pending' — The status of the Afterpay Clearpay capability of the account, or whether the account can directly process Afterpay Clearpay charges. - `alma_payments` 'active' | 'inactive' | 'pending' — The status of the Alma capability of the account, or whether the account can directly process Alma payments. - `amazon_pay_payments` 'active' | 'inactive' | 'pending' — The status of the AmazonPay capability of the account, or whether the account can directly process AmazonPay payments. - `app_distribution` 'active' | 'inactive' | 'pending' — The status of the `app_distribution` capability of the account, or whether the platform can distribute apps to other accounts. - `au_becs_debit_payments` 'active' | 'inactive' | 'pending' — The status of the BECS Direct Debit (AU) payments capability of the account, or whether the account can directly process BECS Direct Debit (AU) charges. - `bacs_debit_payments` 'active' | 'inactive' | 'pending' — The status of the Bacs Direct Debits payments capability of the account, or whether the account can directly process Bacs Direct Debits charges. - `bancontact_payments` 'active' | 'inactive' | 'pending' — The status of the Bancontact payments capability of the account, or whether the account can directly process Bancontact charges. - `bank_transfer_payments` 'active' | 'inactive' | 'pending' — The status of the customer_balance payments capability of the account, or whether the account can directly process customer_balance charges. - `billie_payments` 'active' | 'inactive' | 'pending' — The status of the Billie capability of the account, or whether the account can directly process Billie payments. - `bizum_payments` 'active' | 'inactive' | 'pending' — The status of the Bizum capability of the account, or whether the account can directly process Bizum payments. - `blik_payments` 'active' | 'inactive' | 'pending' — The status of the blik payments capability of the account, or whether the account can directly process blik charges. - `boleto_payments` 'active' | 'inactive' | 'pending' — The status of the boleto payments capability of the account, or whether the account can directly process boleto charges. - `card_issuing` 'active' | 'inactive' | 'pending' — The status of the card issuing capability of the account, or whether you can use Issuing to distribute funds on cards - `card_payments` 'active' | 'inactive' | 'pending' — The status of the card payments capability of the account, or whether the account can directly process credit and debit card charges. - `cartes_bancaires_payments` 'active' | 'inactive' | 'pending' — The status of the Cartes Bancaires payments capability of the account, or whether the account can directly process Cartes Bancaires card charges in EUR currency. - `cashapp_payments` 'active' | 'inactive' | 'pending' — The status of the Cash App Pay capability of the account, or whether the account can directly process Cash App Pay payments. - `crypto_payments` 'active' | 'inactive' | 'pending' — The status of the Crypto capability of the account, or whether the account can directly process Crypto payments. - `eps_payments` 'active' | 'inactive' | 'pending' — The status of the EPS payments capability of the account, or whether the account can directly process EPS charges. - `fpx_payments` 'active' | 'inactive' | 'pending' — The status of the FPX payments capability of the account, or whether the account can directly process FPX charges. - `gb_bank_transfer_payments` 'active' | 'inactive' | 'pending' — The status of the GB customer_balance payments (GBP currency) capability of the account, or whether the account can directly process GB customer_balance charges. - `giropay_payments` 'active' | 'inactive' | 'pending' — The status of the giropay payments capability of the account, or whether the account can directly process giropay charges. - `grabpay_payments` 'active' | 'inactive' | 'pending' — The status of the GrabPay payments capability of the account, or whether the account can directly process GrabPay charges. - `ideal_payments` 'active' | 'inactive' | 'pending' — The status of the iDEAL payments capability of the account, or whether the account can directly process iDEAL charges. - `india_international_payments` 'active' | 'inactive' | 'pending' — The status of the india_international_payments capability of the account, or whether the account can process international charges (non INR) in India. - `jcb_payments` 'active' | 'inactive' | 'pending' — The status of the JCB payments capability of the account, or whether the account (Japan only) can directly process JCB credit card charges in JPY currency. - `jp_bank_transfer_payments` 'active' | 'inactive' | 'pending' — The status of the Japanese customer_balance payments (JPY currency) capability of the account, or whether the account can directly process Japanese customer_balance charges. - `kakao_pay_payments` 'active' | 'inactive' | 'pending' — The status of the KakaoPay capability of the account, or whether the account can directly process KakaoPay payments. - `klarna_payments` 'active' | 'inactive' | 'pending' — The status of the Klarna payments capability of the account, or whether the account can directly process Klarna charges. - `konbini_payments` 'active' | 'inactive' | 'pending' — The status of the konbini payments capability of the account, or whether the account can directly process konbini charges. - `kr_card_payments` 'active' | 'inactive' | 'pending' — The status of the KrCard capability of the account, or whether the account can directly process KrCard payments. - `legacy_payments` 'active' | 'inactive' | 'pending' — The status of the legacy payments capability of the account. - `link_payments` 'active' | 'inactive' | 'pending' — The status of the link_payments capability of the account, or whether the account can directly process Link charges. - `mb_way_payments` 'active' | 'inactive' | 'pending' — The status of the MB WAY payments capability of the account, or whether the account can directly process MB WAY charges. - `mobilepay_payments` 'active' | 'inactive' | 'pending' — The status of the MobilePay capability of the account, or whether the account can directly process MobilePay charges. - `multibanco_payments` 'active' | 'inactive' | 'pending' — The status of the Multibanco payments capability of the account, or whether the account can directly process Multibanco charges. - `mx_bank_transfer_payments` 'active' | 'inactive' | 'pending' — The status of the Mexican customer_balance payments (MXN currency) capability of the account, or whether the account can directly process Mexican customer_balance charges. - `naver_pay_payments` 'active' | 'inactive' | 'pending' — The status of the NaverPay capability of the account, or whether the account can directly process NaverPay payments. - `nz_bank_account_becs_debit_payments` 'active' | 'inactive' | 'pending' — The status of the New Zealand BECS Direct Debit payments capability of the account, or whether the account can directly process New Zealand BECS Direct Debit charges. - `oxxo_payments` 'active' | 'inactive' | 'pending' — The status of the OXXO payments capability of the account, or whether the account can directly process OXXO charges. - `p24_payments` 'active' | 'inactive' | 'pending' — The status of the P24 payments capability of the account, or whether the account can directly process P24 charges. - `pay_by_bank_payments` 'active' | 'inactive' | 'pending' — The status of the pay_by_bank payments capability of the account, or whether the account can directly process pay_by_bank charges. - `payco_payments` 'active' | 'inactive' | 'pending' — The status of the Payco capability of the account, or whether the account can directly process Payco payments. - `paynow_payments` 'active' | 'inactive' | 'pending' — The status of the paynow payments capability of the account, or whether the account can directly process paynow charges. - `payto_payments` 'active' | 'inactive' | 'pending' — The status of the PayTo capability of the account, or whether the account can directly process PayTo charges. - `pix_payments` 'active' | 'inactive' | 'pending' — The status of the pix payments capability of the account, or whether the account can directly process pix charges. - `promptpay_payments` 'active' | 'inactive' | 'pending' — The status of the promptpay payments capability of the account, or whether the account can directly process promptpay charges. - `revolut_pay_payments` 'active' | 'inactive' | 'pending' — The status of the RevolutPay capability of the account, or whether the account can directly process RevolutPay payments. - `samsung_pay_payments` 'active' | 'inactive' | 'pending' — The status of the SamsungPay capability of the account, or whether the account can directly process SamsungPay payments. - `satispay_payments` 'active' | 'inactive' | 'pending' — The status of the Satispay capability of the account, or whether the account can directly process Satispay payments. - `scalapay_payments` 'active' | 'inactive' | 'pending' — The status of the Scalapay capability of the account, or whether the account can directly process Scalapay payments. - `sepa_bank_transfer_payments` 'active' | 'inactive' | 'pending' — The status of the SEPA customer_balance payments (EUR currency) capability of the account, or whether the account can directly process SEPA customer_balance charges. - `sepa_debit_payments` 'active' | 'inactive' | 'pending' — The status of the SEPA Direct Debits payments capability of the account, or whether the account can directly process SEPA Direct Debits charges. - `sofort_payments` 'active' | 'inactive' | 'pending' — The status of the Sofort payments capability of the account, or whether the account can directly process Sofort charges. - `sunbit_payments` 'active' | 'inactive' | 'pending' — The status of the Sunbit capability of the account, or whether the account can directly process Sunbit payments. - `swish_payments` 'active' | 'inactive' | 'pending' — The status of the Swish capability of the account, or whether the account can directly process Swish payments. - `tax_reporting_us_1099_k` 'active' | 'inactive' | 'pending' — The status of the tax reporting 1099-K (US) capability of the account. - `tax_reporting_us_1099_misc` 'active' | 'inactive' | 'pending' — The status of the tax reporting 1099-MISC (US) capability of the account. - `transfers` 'active' | 'inactive' | 'pending' — The status of the transfers capability of the account, or whether your platform can transfer funds to the account. - `treasury` 'active' | 'inactive' | 'pending' — The status of the banking capability, or whether the account can have bank accounts. - `twint_payments` 'active' | 'inactive' | 'pending' — The status of the TWINT capability of the account, or whether the account can directly process TWINT charges. - `upi_payments` 'active' | 'inactive' | 'pending' — The status of the upi payments capability of the account, or whether the account can directly process upi charges. - `us_bank_account_ach_payments` 'active' | 'inactive' | 'pending' — The status of the US bank account ACH payments capability of the account, or whether the account can directly process US bank account charges. - `us_bank_transfer_payments` 'active' | 'inactive' | 'pending' — The status of the US customer_balance payments (USD currency) capability of the account, or whether the account can directly process US customer_balance charges. - `zip_payments` 'active' | 'inactive' | 'pending' — The status of the Zip capability of the account, or whether the account can directly process Zip charges. - `charges_enabled` boolean — Whether the account can process charges. - `company` LegalEntityCompany - `address` Address - … - `address_kana` LegalEntityJapanAddress - … - `address_kanji` LegalEntityJapanAddress - … - `administrative_address` Address - … - `directors_provided` boolean — Whether the company's directors have been provided. This Boolean will be `true` if you've manually indicated that all directors are provided via [the `directors_provided` parameter](https://docs.stripe.com/api/accounts/update#update_account-company-directors_provided). - `directorship_declaration` LegalEntityDirectorshipDeclaration - … - `executives_provided` boolean — Whether the company's executives have been provided. This Boolean will be `true` if you've manually indicated that all executives are provided via [the `executives_provided` parameter](https://docs.stripe.com/api/accounts/update#update_account-company-executives_provided), or if Stripe determined that sufficient executives were provided. - `export_license_id` string — The export license ID number of the company, also referred as Import Export Code (India only). - `export_purpose_code` string — The purpose code to use for export transactions (India only). - `name` string, nullable — The company's legal name. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. - `name_kana` string, nullable — The Kana variation of the company's legal name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. - `name_kanji` string, nullable — The Kanji variation of the company's legal name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. - `owners_provided` boolean — Whether the company's owners have been provided. This Boolean will be `true` if you've manually indicated that all owners are provided via [the `owners_provided` parameter](https://docs.stripe.com/api/accounts/update#update_account-company-owners_provided), or if Stripe determined that sufficient owners were provided. Stripe determines ownership requirements using both the number of owners provided and their total percent ownership (calculated by adding the `percent_ownership` of each owner together). - `ownership_declaration` LegalEntityUboDeclaration - … - `ownership_exemption_reason` 'qualified_entity_exceeds_ownership_threshold' | 'qualifies_as_financial_institution' — This value is used to determine if a business is exempt from providing ultimate beneficial owners. See [this support article](https://support.stripe.com/questions/exemption-from-providing-ownership-details) and [changelog](https://docs.stripe.com/changelog/acacia/2025-01-27/ownership-exemption-reason-accounts-api) for more details. - `phone` string, nullable — The company's phone number (used for verification). - `principal_place_of_business` Address - … - `registration_date` LegalEntityRegistrationDate - … - `representative_declaration` LegalEntityRepresentativeDeclaration - … - `structure` 'free_zone_establishment' | 'free_zone_llc' | 'government_instrumentality' | 'governmental_unit' | 'incorporated_non_profit' | 'incorporated_partnership' | 'limited_liability_partnership' | 'llc' | 'multi_member_llc' | 'private_company' | 'private_corporation' | 'private_partnership' | 'public_company' | 'public_corporation' | 'public_partnership' | 'registered_charity' | 'single_member_llc' | 'sole_establishment' | 'sole_proprietorship' | 'tax_exempt_government_instrumentality' | 'unincorporated_association' | 'unincorporated_non_profit' | 'unincorporated_partnership' — The category identifying the legal structure of the company or legal entity. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. See [Business structure](https://docs.stripe.com/connect/identity-verification#business-structure) for more details. - `tax_id_provided` boolean — Whether the company's business ID number was provided. - `tax_id_registrar` string — The jurisdiction in which the `tax_id` is registered (Germany-based companies only). - `vat_id_provided` boolean — Whether the company's business VAT number was provided. - `verification` LegalEntityCompanyVerification - … - `controller` AccountUnificationAccountController - `fees` AccountUnificationAccountControllerFees - … - `is_controller` boolean — `true` if the Connect application retrieving the resource controls the account and can therefore exercise [platform controls](https://docs.stripe.com/connect/platform-controls-for-standard-accounts). Otherwise, this field is null. - `losses` AccountUnificationAccountControllerLosses - … - `requirement_collection` 'application' | 'stripe' — A value indicating responsibility for collecting requirements on this account. Only returned when the Connect application retrieving the resource controls the account. - `stripe_dashboard` AccountUnificationAccountControllerStripeDashboard - … - `type` 'account' | 'application', required — The controller type. Can be `application`, if a Connect application controls the account, or `account`, if the account controls itself. - `country` string — The account's country. - `created` integer — Time at which the account was connected. Measured in seconds since the Unix epoch. - `default_currency` string — Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://stripe.com/docs/payouts). - `details_submitted` boolean — Whether account details have been submitted. Accounts with Stripe Dashboard access, which includes Standard accounts, cannot receive payouts before this is true. Accounts where this is false should be directed to [an onboarding flow](/connect/onboarding) to finish submitting account details. - `email` string, nullable — An email address associated with the account. It's not used for authentication and Stripe doesn't market to this field without explicit approval from the platform. - `external_accounts` object — External accounts (bank accounts and debit cards) currently attached to this account. External accounts are only returned for requests where `controller[is_controller]` is true. - `data` union[], required — The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards. - … - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched. - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - `url` string, required — The URL where this list can be accessed. - `future_requirements` AccountFutureRequirements - `alternatives` AccountRequirementsAlternative[], nullable — Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same `original_fields_due`, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing `original_fields_due` also serves as a pathway for attempting to resolve the fields again. - … - `current_deadline` integer, nullable — Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on its enablement state prior to transitioning. - `currently_due` string[], nullable — Fields that need to be resolved to keep the account enabled. If not resolved by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash. - `disabled_reason` 'action_required.requested_capabilities' | 'listed' | 'other' | 'platform_paused' | 'rejected.fraud' | 'rejected.incomplete_verification' | 'rejected.listed' | 'rejected.other' | 'rejected.platform_fraud' | 'rejected.platform_other' | 'rejected.platform_terms_of_service' | 'rejected.terms_of_service' | 'requirements.past_due' | 'requirements.pending_verification' | 'under_review', nullable — This is typed as an enum for consistency with `requirements.disabled_reason`. - `errors` AccountRequirementsError[], nullable — Fields that are `currently_due` and need to be collected again because validation or verification failed. - … - `eventually_due` string[], nullable — Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well. - `past_due` string[], nullable — Fields that haven't been resolved by `requirements.current_deadline`. These fields need to be resolved to enable the capability on the account. `future_requirements.past_due` is a subset of `requirements.past_due`. - `pending_verification` string[], nullable — Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending. - `groups` AccountGroupMembership - `payments_pricing` string, nullable — The group the account is in to determine their payments pricing, and null if the account is on customized pricing. [See the Platform pricing tool documentation](https://docs.stripe.com/connect/platform-pricing-tools) for details. - `id` string, required — Unique identifier for the object. - `individual` Person — This is an object representing a person associated with a Stripe account. A platform can only access a subset of data in a person for an account where [account.controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding. See the [Standard onboarding](/connect/standard-accounts) or [Express onboarding](/connect/express-accounts) documentation for information about prefilling information and account onboarding steps. Learn more about [handling identity verification with the API](/connect/handling-api-verification#person-information). - `account` string, required — The account the person is associated with. - `additional_tos_acceptances` PersonAdditionalTosAcceptances - … - `address` Address - … - `address_kana` LegalEntityJapanAddress - … - `address_kanji` LegalEntityJapanAddress - … - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `dob` LegalEntityDob - … - `email` string, nullable — The person's email address. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. - `first_name` string, nullable — The person's first name. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. - `first_name_kana` string, nullable — The Kana variation of the person's first name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. - `first_name_kanji` string, nullable — The Kanji variation of the person's first name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. - `full_name_aliases` string[] — A list of alternate names or aliases that the person is known by. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. - `future_requirements` PersonFutureRequirements - … - `gender` string, nullable — The person's gender. - `id` string, required — Unique identifier for the object. - `id_number_provided` boolean — Whether the person's `id_number` was provided. True if either the full ID number was provided or if only the required part of the ID number was provided (ex. last four of an individual's SSN for the US indicated by `ssn_last_4_provided`). - `id_number_secondary_provided` boolean — Whether the person's `id_number_secondary` was provided. - `last_name` string, nullable — The person's last name. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. - `last_name_kana` string, nullable — The Kana variation of the person's last name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. - `last_name_kanji` string, nullable — The Kanji variation of the person's last name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. - `maiden_name` string, nullable — The person's maiden name. - `metadata` object — 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. - `nationality` string, nullable — The country where the person is a national. - `object` 'person', required — String representing the object's type. Objects of the same type share the same value. - `phone` string, nullable — The person's phone number. - `political_exposure` 'existing' | 'none' — Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction. - `registered_address` Address - … - `relationship` PersonRelationship - … - `requirements` PersonRequirements - … - `ssn_last_4_provided` boolean — Whether the last four digits of the person's Social Security number have been provided (U.S. only). - `us_cfpb_data` PersonUsCfpbData - … - `verification` LegalEntityPersonVerification - … - `metadata` object — 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. - `object` 'account', required — String representing the object's type. Objects of the same type share the same value. - `payouts_enabled` boolean — Whether the funds in this account can be paid out. - `requirements` AccountRequirements - `alternatives` AccountRequirementsAlternative[], nullable — Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same `original_fields_due`, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing `original_fields_due` also serves as a pathway for attempting to resolve the fields again. - … - `current_deadline` integer, nullable — Date by which the fields in `currently_due` must be collected to keep the account enabled. These fields may disable the account sooner if the next threshold is reached before they are collected. - `currently_due` string[], nullable — Fields that need to be resolved to keep the account enabled. If not resolved by `current_deadline`, these fields will appear in `past_due` as well, and the account will be disabled. - `disabled_reason` 'action_required.requested_capabilities' | 'listed' | 'other' | 'platform_paused' | 'rejected.fraud' | 'rejected.incomplete_verification' | 'rejected.listed' | 'rejected.other' | 'rejected.platform_fraud' | 'rejected.platform_other' | 'rejected.platform_terms_of_service' | 'rejected.terms_of_service' | 'requirements.past_due' | 'requirements.pending_verification' | 'under_review', nullable — If the account is disabled, this enum describes why. [Learn more about handling verification issues](https://docs.stripe.com/connect/handling-api-verification). - `errors` AccountRequirementsError[], nullable — Fields that are `currently_due` and need to be collected again because validation or verification failed. - … - `eventually_due` string[], nullable — Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set. - `past_due` string[], nullable — Fields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the account. - `pending_verification` string[], nullable — Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending. - `settings` AccountSettings - `bacs_debit_payments` AccountBacsDebitPaymentsSettings - … - `branding` AccountBrandingSettings, required - … - `card_issuing` AccountCardIssuingSettings - … - `card_payments` AccountCardPaymentsSettings, required - … - `dashboard` AccountDashboardSettings, required - … - `invoices` AccountInvoicesSettings - … - `payments` AccountPaymentsSettings, required - … - `payouts` AccountPayoutSettings - … - `sepa_debit_payments` AccountSepaDebitPaymentsSettings - … - `treasury` AccountTreasurySettings - … - `tos_acceptance` AccountTosAcceptance - `date` integer, nullable — The Unix timestamp marking when the account representative accepted their service agreement - `ip` string, nullable — The IP address from which the account representative accepted their service agreement - `service_agreement` string — The user's service agreement type - `user_agent` string, nullable — The user agent of the browser from which the account representative accepted their service agreement - `type` 'custom' | 'express' | 'none' | 'standard' — The Stripe account type. Can be `standard`, `express`, `custom`, or `none`. - `customer` union — The ID for an Account representing a customer that this account belongs to. Only available when `account_holder.type` is `customer`. - string - Customer — This object represents a customer of your business. Use it to [create recurring charges](https://docs.stripe.com/invoicing/customer), [save payment](https://docs.stripe.com/payments/save-during-payment) and contact information, and track payments that belong to the same customer. - `address` Address - `city` string, nullable — City, district, suburb, town, or village. - `country` string, nullable — Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). - `line1` string, nullable — Address line 1, such as the street, PO Box, or company name. - `line2` string, nullable — Address line 2, such as the apartment, suite, unit, or building. - `postal_code` string, nullable — ZIP or postal code. - `state` string, nullable — State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). - `balance` integer — The current balance, if any, that's stored on the customer in their default currency. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that's added to their next invoice. The balance only considers amounts that Stripe hasn't successfully applied to any invoice. It doesn't reflect unpaid invoices. This balance is only taken into account after invoices finalize. For multi-currency balances, see [invoice_credit_balance](https://docs.stripe.com/api/customers/object#customer_object-invoice_credit_balance). - `business_name` string — The customer's business name. - `cash_balance` CashBalance — A customer's `Cash balance` represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment and can eventually be paid out to your bank account. - `available` object, nullable — 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. Amounts are represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). - `customer` string, required — The ID of the customer whose cash balance this object represents. - `customer_account` string, nullable — The ID of an Account representing a customer whose cash balance this object represents. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `object` 'cash_balance', required — String representing the object's type. Objects of the same type share the same value. - `settings` CustomerBalanceCustomerBalanceSettings, required - … - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `currency` string, nullable — Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes. - `customer_account` string, nullable — The ID of an Account representing a customer. You can use this ID with any v1 API that accepts a customer_account parameter. - `default_source` union — ID of the default payment source for the customer. If you use payment methods created through the PaymentMethods API, see the [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) field instead. - string - BankAccount — These bank accounts are payment methods on `Customer` objects. On the other hand [External Accounts](/api#external_accounts) are transfer destinations on `Account` objects for connected accounts. They can be bank accounts or debit cards as well, and are documented in the links above. Related guide: [Bank debits and transfers](/payments/bank-debits-transfers) - … - Card — You can store multiple cards on a customer in order to charge the customer later. You can also store multiple debit cards on a recipient in order to transfer to those cards later. Related guide: [Card payments with Sources](https://docs.stripe.com/sources/cards) - … - Source — `Source` objects allow you to accept a variety of payment methods. They represent a customer's payment instrument, and can be used with the Stripe API just like a `Card` object: once chargeable, they can be charged, or can be attached to customers. Stripe doesn't recommend using the deprecated [Sources API](https://docs.stripe.com/api/sources). We recommend that you adopt the [PaymentMethods API](https://docs.stripe.com/api/payment_methods). This newer API provides access to our latest features and payment method types. Related guides: [Sources API](https://docs.stripe.com/sources) and [Sources & Customers](https://docs.stripe.com/sources/customers). - … - `delinquent` boolean, nullable — Tracks the most recent state change on any invoice belonging to the customer. Paying an invoice or marking it uncollectible via the API will set this field to false. An automatic payment failure or passing the `invoice.due_date` will set this field to `true`. If an invoice becomes uncollectible by [dunning](https://docs.stripe.com/billing/automatic-collection), `delinquent` doesn't reset to `false`. If you care whether the customer has paid their most recent subscription invoice, use `subscription.status` instead. Paying or marking uncollectible any customer invoice regardless of whether it is the latest invoice for a subscription will always set this field to `false`. - `description` string, nullable — An arbitrary string attached to the object. Often useful for displaying to users. - `discount` Discount — A discount represents the actual application of a [coupon](https://api.stripe.com#coupons) or [promotion code](https://api.stripe.com#promotion_codes). It contains information about when the discount began, when it will end, and what it is applied to. Related guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts) - `checkout_session` string, nullable — The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Not present for subscription mode. - `customer` union — The ID of the customer associated with this discount. - … - `customer_account` string, nullable — The ID of the account representing the customer associated with this discount. - `end` integer, nullable — 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` string, required — The ID of the discount object. Discounts can't be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array. - `invoice` string, nullable — The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice. - `invoice_item` string, nullable — 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. - `object` 'discount', required — String representing the object's type. Objects of the same type share the same value. - `promotion_code` union — The promotion code applied to create this discount. - … - `source` DiscountSource, required - … - `start` integer, required — Date that the coupon was applied. - `subscription` string, nullable — The subscription that this coupon is applied to, if it is applied to a particular subscription. - `subscription_item` string, nullable — The subscription item that this coupon is applied to, if it is applied to a particular subscription item. - `email` string, nullable — The customer's email address. - `id` string, required — Unique identifier for the object. - `individual_name` string — The customer's individual name. - `invoice_credit_balance` object — The current multi-currency balances, if any, that's stored on the customer. If positive in a currency, the customer has a credit to apply to their next invoice denominated in that currency. If negative, the customer has an amount owed that's added to their next invoice denominated in that currency. These balances don't apply to unpaid invoices. They solely track amounts that Stripe hasn't successfully applied to any invoice. Stripe only applies a balance in a specific currency to an invoice after that invoice (which is in the same currency) finalizes. - `invoice_prefix` string, nullable — The prefix for the customer used to generate unique invoice numbers. - `invoice_settings` InvoiceSettingCustomerSetting - `custom_fields` InvoiceSettingCustomField[], nullable — Default custom fields to be displayed on invoices for this customer. - … - `default_payment_method` union — ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices. - … - `footer` string, nullable — Default footer to be displayed on invoices for this customer. - `rendering_options` InvoiceSettingCustomerRenderingOptions - … - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `metadata` object — 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. - `name` string, nullable — The customer's full name or business name. - `next_invoice_sequence` integer — The suffix of the customer's next invoice number (for example, 0001). When the account uses account level sequencing, this parameter is ignored in API requests and the field omitted in API responses. - `object` 'customer', required — String representing the object's type. Objects of the same type share the same value. - `phone` string, nullable — The customer's phone number. - `preferred_locales` string[], nullable — The customer's preferred locales (languages), ordered by preference. - `shipping` Shipping - `address` Address - … - `carrier` string, nullable — The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. - `name` string — Recipient name. - `phone` string, nullable — Recipient phone (including extension). - `tracking_number` string, nullable — 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. - `sources` object — The customer's payment sources, if any. - `data` union[], required — Details about each object. - … - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched. - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - `url` string, required — The URL where this list can be accessed. - `subscriptions` object — The customer's current subscriptions, if any. - `data` Subscription[], required — Details about each object. - … - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched. - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - `url` string, required — The URL where this list can be accessed. - `tax` CustomerTax - `automatic_tax` 'failed' | 'not_collecting' | 'supported' | 'unrecognized_location', required — Surfaces if automatic tax computation is possible given the current customer location information. - `ip_address` string, nullable — A recent IP address of the customer used for tax reporting and tax location inference. - `location` CustomerTaxLocation - … - `provider` 'anrok' | 'avalara' | 'sphere' | 'stripe', required — The tax calculation provider used for location resolution. Defaults to `stripe` when not using a [third-party provider](/tax/third-party-apps). - `tax_exempt` 'exempt' | 'none' | 'reverse', nullable — Describes the customer's tax exemption status, which is `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the following text: **"Reverse charge"**. - `tax_ids` object — The customer's tax IDs. - `data` TaxId[], required — Details about each object. - … - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched. - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - `url` string, required — The URL where this list can be accessed. - `test_clock` union — ID of the test clock that this customer belongs to. - string - TestHelpersTestClock — A test clock enables deterministic control over objects in testmode. With a test clock, you can create objects at a frozen time in the past or future, and advance to a specific future time to observe webhooks and state changes. After the clock advances, you can either validate the current state of your scenario (and test your assumptions), change the current state of your scenario (and test more complex scenarios), or keep advancing forward in time. - … - `customer_account` string - `type` 'account' | 'customer', required — Type of account holder that this account belongs to. - `account_numbers` BankConnectionsResourceAccountNumberDetails[], nullable — Details about the account numbers. - `expected_expiry_date` integer, nullable — When the account number is expected to expire, if applicable. - `identifier_type` 'account_number' | 'tokenized_account_number', required — The type of account number associated with the account. - `status` 'deactivated' | 'transactable', required — Whether the account number is currently active and usable for transactions. - `supported_networks` string[], required — The payment networks that the account number can be used for. - `balance` BankConnectionsResourceBalance - `as_of` integer, required — The time that the external institution calculated this balance. Measured in seconds since the Unix epoch. - `cash` BankConnectionsResourceBalanceApiResourceCashBalance - `available` object, nullable — The funds available to the account holder. Typically this is the current balance after subtracting any outbound pending transactions and adding any inbound pending transactions. Each key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Each value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder. - `credit` BankConnectionsResourceBalanceApiResourceCreditBalance - `used` object, nullable — The credit that has been used by the account holder. Each key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Each value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder. - `current` object, required — The balances owed to (or by) the account holder, before subtracting any outbound pending transactions or adding any inbound pending transactions. Each key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Each value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder. - `type` 'cash' | 'credit', required — The `type` of the balance. An additional hash is included on the balance with a name matching this value. - `balance_refresh` BankConnectionsResourceBalanceRefresh - `last_attempted_at` integer, required — The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch. - `next_refresh_available_at` integer, nullable — Time at which the next balance refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch. - `status` 'failed' | 'pending' | 'succeeded', required — The status of the last refresh attempt. - `category` 'cash' | 'credit' | 'investment' | 'other', required — The type of the account. Account category is further divided in `subcategory`. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `display_name` string, nullable — A human-readable name that has been assigned to this account, either by the account holder or by the institution. - `id` string, required — Unique identifier for the object. - `institution_name` string, required — The name of the institution that holds this account. - `last4` string, nullable — The last 4 digits of the account number. If present, this will be 4 numeric characters. - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. - `object` 'financial_connections.account', required — String representing the object's type. Objects of the same type share the same value. - `ownership` union — The most recent information about the account's owners. - string - FinancialConnectionsAccountOwnership — Describes a snapshot of the owners of an account at a particular point in time. - `created` integer, required — Time at which the object was created. Measured in seconds since the Unix epoch. - `id` string, required — Unique identifier for the object. - `object` 'financial_connections.account_ownership', required — String representing the object's type. Objects of the same type share the same value. - `owners` object, required — A paginated list of owners for this account. - `data` FinancialConnectionsAccountOwner[], required — Details about each object. - `email` string, nullable — The email address of the owner. - `id` string, required — Unique identifier for the object. - `name` string, required — The full name of the owner. - `object` 'financial_connections.account_owner', required — String representing the object's type. Objects of the same type share the same value. - `ownership` string, required — The ownership object that this owner belongs to. - `phone` string, nullable — The raw phone number of the owner. - `raw_address` string, nullable — The raw physical address of the owner. - `refreshed_at` integer, nullable — The timestamp of the refresh that updated this owner. - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched. - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - `url` string, required — The URL where this list can be accessed. - `ownership_refresh` BankConnectionsResourceOwnershipRefresh - `last_attempted_at` integer, required — The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch. - `next_refresh_available_at` integer, nullable — Time at which the next ownership refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch. - `status` 'failed' | 'pending' | 'succeeded', required — The status of the last refresh attempt. - `permissions` string[], nullable — The list of permissions granted by this account. - `status` 'active' | 'disconnected' | 'inactive', required — The status of the link to the account. - `status_details` BankConnectionsResourceAccountStatusDetails - `active` BankConnectionsResourceAccountStatusDetailsApiResourceActiveStatusDetails - `action` 'none' | 'relink_required', required — The action (if any) to proactively relink the Account. - `cause` 'access_expired' | 'institution_requirement' | 'unspecified', required — The underlying cause of the Account becoming inactive. - `expected_deactivation_date` integer, required — When the Account is expected to become inactive, if applicable. - `subcategory` 'checking' | 'credit_card' | 'line_of_credit' | 'mortgage' | 'other' | 'savings', required — If `category` is `cash`, one of: - `checking` - `savings` - `other` If `category` is `credit`, one of: - `mortgage` - `line_of_credit` - `credit_card` - `other` If `category` is `investment` or `other`, this will be `other`. - `subscriptions` string[], nullable — The list of data refresh subscriptions requested on this account. - `supported_payment_method_types` string[], required — The [PaymentMethod type](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type)(s) that can be created from this account. - `transaction_refresh` BankConnectionsResourceTransactionRefresh - `id` string, required — Unique identifier for the object. - `last_attempted_at` integer, required — The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch. - `next_refresh_available_at` integer, nullable — Time at which the next transaction refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch. - `status` 'failed' | 'pending' | 'succeeded', required — The status of the last refresh attempt. - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched. - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`. - `url` string, required — The URL where this list can be accessed. ## Other responses - `default` — Error response. --- [API](https://skmtc.net/stripe/apis/stripe-api.md) · [All operations](https://skmtc.net/stripe/apis/stripe-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/stripe/stripe-api/versions/707de00b0616/schema)