Account
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
is application, which includes Custom accounts, the properties below are always
returned.
For accounts where controller.requirement_collection
is stripe, which includes Standard and Express accounts, some properties are only returned
until you create an Account Link or Account Session
to start Connect Onboarding. Learn about the differences between accounts.
Summary
Types
@type business_profile() :: %{ optional(:annual_revenue) => business_profile_annual_revenue() | nil, optional(:estimated_worker_count) => integer() | nil, optional(:mcc) => String.t() | nil, optional(:minority_owned_business_designation) => [String.t()] | nil, optional(:monthly_estimated_revenue) => business_profile_monthly_estimated_revenue() | nil, optional(:name) => String.t() | nil, optional(:product_description) => String.t() | nil, optional(:support_address) => Stripe.Resources.Address.t() | nil, optional(:support_email) => String.t() | nil, optional(:support_phone) => String.t() | nil, optional(:support_url) => String.t() | nil, optional(:url) => String.t() | nil, optional(String.t()) => term() }
annual_revenue- The applicant's gross annual revenue for its preceding fiscal year. Nullable.estimated_worker_count- An estimated upper bound of employees, contractors, vendors, etc. currently working for the business. Nullable.mcc- The merchant category code for the account. MCCs are used to classify businesses based on the goods or services they provide. Max length: 5000. Nullable.minority_owned_business_designation- Whether the business is a minority-owned, women-owned, and/or LGBTQI+ -owned business. Nullable.monthly_estimated_revenuename- The customer-facing business name. Max length: 5000. Nullable.product_description- Internal-only description of the product sold or service provided by the business. It's used by Stripe for risk and underwriting purposes. Max length: 40000. Nullable.support_address- A publicly available mailing address for sending support issues to. Nullable.support_email- A publicly available email address for sending support issues to. Max length: 5000. Nullable.support_phone- A publicly available phone number to call with support issues. Max length: 5000. Nullable.support_url- A publicly available website for handling support issues. Max length: 5000. Nullable.url- The business's publicly available website. Max length: 5000. Nullable.
@type business_profile_annual_revenue() :: %{ optional(:amount) => integer() | nil, optional(:currency) => String.t() | nil, optional(:fiscal_year_end) => String.t() | nil, optional(String.t()) => term() }
amount- A non-negative integer representing the amount in the smallest currency unit. Nullable.currency- Three-letter ISO currency code, in lowercase. Must be a supported currency. Format: ISO 4217 currency code. Nullable.fiscal_year_end- The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023. Max length: 5000. Nullable.
@type business_profile_monthly_estimated_revenue() :: %{ optional(:amount) => integer() | nil, optional(:currency) => String.t() | nil, optional(String.t()) => term() }
amount- A non-negative integer representing how much to charge in the smallest currency unit.currency- Three-letter ISO currency code, in lowercase. Must be a supported currency. Format: ISO 4217 currency code.
@type capabilities() :: %{ optional(:acss_debit_payments) => String.t() | nil, optional(:affirm_payments) => String.t() | nil, optional(:afterpay_clearpay_payments) => String.t() | nil, optional(:alma_payments) => String.t() | nil, optional(:amazon_pay_payments) => String.t() | nil, optional(:au_becs_debit_payments) => String.t() | nil, optional(:bacs_debit_payments) => String.t() | nil, optional(:bancontact_payments) => String.t() | nil, optional(:bank_transfer_payments) => String.t() | nil, optional(:billie_payments) => String.t() | nil, optional(:blik_payments) => String.t() | nil, optional(:boleto_payments) => String.t() | nil, optional(:card_issuing) => String.t() | nil, optional(:card_payments) => String.t() | nil, optional(:cartes_bancaires_payments) => String.t() | nil, optional(:cashapp_payments) => String.t() | nil, optional(:crypto_payments) => String.t() | nil, optional(:eps_payments) => String.t() | nil, optional(:fpx_payments) => String.t() | nil, optional(:gb_bank_transfer_payments) => String.t() | nil, optional(:giropay_payments) => String.t() | nil, optional(:grabpay_payments) => String.t() | nil, optional(:ideal_payments) => String.t() | nil, optional(:india_international_payments) => String.t() | nil, optional(:jcb_payments) => String.t() | nil, optional(:jp_bank_transfer_payments) => String.t() | nil, optional(:kakao_pay_payments) => String.t() | nil, optional(:klarna_payments) => String.t() | nil, optional(:konbini_payments) => String.t() | nil, optional(:kr_card_payments) => String.t() | nil, optional(:legacy_payments) => String.t() | nil, optional(:link_payments) => String.t() | nil, optional(:mb_way_payments) => String.t() | nil, optional(:mobilepay_payments) => String.t() | nil, optional(:multibanco_payments) => String.t() | nil, optional(:mx_bank_transfer_payments) => String.t() | nil, optional(:naver_pay_payments) => String.t() | nil, optional(:nz_bank_account_becs_debit_payments) => String.t() | nil, optional(:oxxo_payments) => String.t() | nil, optional(:p24_payments) => String.t() | nil, optional(:pay_by_bank_payments) => String.t() | nil, optional(:payco_payments) => String.t() | nil, optional(:paynow_payments) => String.t() | nil, optional(:payto_payments) => String.t() | nil, optional(:pix_payments) => String.t() | nil, optional(:promptpay_payments) => String.t() | nil, optional(:revolut_pay_payments) => String.t() | nil, optional(:samsung_pay_payments) => String.t() | nil, optional(:satispay_payments) => String.t() | nil, optional(:sepa_bank_transfer_payments) => String.t() | nil, optional(:sepa_debit_payments) => String.t() | nil, optional(:sofort_payments) => String.t() | nil, optional(:swish_payments) => String.t() | nil, optional(:tax_reporting_us_1099_k) => String.t() | nil, optional(:tax_reporting_us_1099_misc) => String.t() | nil, optional(:transfers) => String.t() | nil, optional(:treasury) => String.t() | nil, optional(:twint_payments) => String.t() | nil, optional(:us_bank_account_ach_payments) => String.t() | nil, optional(:us_bank_transfer_payments) => String.t() | nil, optional(:zip_payments) => String.t() | nil, optional(String.t()) => term() }
acss_debit_payments- 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. Possible values:active,inactive,pending.affirm_payments- The status of the Affirm capability of the account, or whether the account can directly process Affirm charges. Possible values:active,inactive,pending.afterpay_clearpay_payments- The status of the Afterpay Clearpay capability of the account, or whether the account can directly process Afterpay Clearpay charges. Possible values:active,inactive,pending.alma_payments- The status of the Alma capability of the account, or whether the account can directly process Alma payments. Possible values:active,inactive,pending.amazon_pay_payments- The status of the AmazonPay capability of the account, or whether the account can directly process AmazonPay payments. Possible values:active,inactive,pending.au_becs_debit_payments- 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. Possible values:active,inactive,pending.bacs_debit_payments- The status of the Bacs Direct Debits payments capability of the account, or whether the account can directly process Bacs Direct Debits charges. Possible values:active,inactive,pending.bancontact_payments- The status of the Bancontact payments capability of the account, or whether the account can directly process Bancontact charges. Possible values:active,inactive,pending.bank_transfer_payments- The status of the customer_balance payments capability of the account, or whether the account can directly process customer_balance charges. Possible values:active,inactive,pending.billie_payments- The status of the Billie capability of the account, or whether the account can directly process Billie payments. Possible values:active,inactive,pending.blik_payments- The status of the blik payments capability of the account, or whether the account can directly process blik charges. Possible values:active,inactive,pending.boleto_payments- The status of the boleto payments capability of the account, or whether the account can directly process boleto charges. Possible values:active,inactive,pending.card_issuing- The status of the card issuing capability of the account, or whether you can use Issuing to distribute funds on cards Possible values:active,inactive,pending.card_payments- The status of the card payments capability of the account, or whether the account can directly process credit and debit card charges. Possible values:active,inactive,pending.cartes_bancaires_payments- 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. Possible values:active,inactive,pending.cashapp_payments- The status of the Cash App Pay capability of the account, or whether the account can directly process Cash App Pay payments. Possible values:active,inactive,pending.crypto_payments- The status of the Crypto capability of the account, or whether the account can directly process Crypto payments. Possible values:active,inactive,pending.eps_payments- The status of the EPS payments capability of the account, or whether the account can directly process EPS charges. Possible values:active,inactive,pending.fpx_payments- The status of the FPX payments capability of the account, or whether the account can directly process FPX charges. Possible values:active,inactive,pending.gb_bank_transfer_payments- 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. Possible values:active,inactive,pending.giropay_payments- The status of the giropay payments capability of the account, or whether the account can directly process giropay charges. Possible values:active,inactive,pending.grabpay_payments- The status of the GrabPay payments capability of the account, or whether the account can directly process GrabPay charges. Possible values:active,inactive,pending.ideal_payments- The status of the iDEAL payments capability of the account, or whether the account can directly process iDEAL charges. Possible values:active,inactive,pending.india_international_payments- The status of the india_international_payments capability of the account, or whether the account can process international charges (non INR) in India. Possible values:active,inactive,pending.jcb_payments- 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. Possible values:active,inactive,pending.jp_bank_transfer_payments- 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. Possible values:active,inactive,pending.kakao_pay_payments- The status of the KakaoPay capability of the account, or whether the account can directly process KakaoPay payments. Possible values:active,inactive,pending.klarna_payments- The status of the Klarna payments capability of the account, or whether the account can directly process Klarna charges. Possible values:active,inactive,pending.konbini_payments- The status of the konbini payments capability of the account, or whether the account can directly process konbini charges. Possible values:active,inactive,pending.kr_card_payments- The status of the KrCard capability of the account, or whether the account can directly process KrCard payments. Possible values:active,inactive,pending.legacy_payments- The status of the legacy payments capability of the account. Possible values:active,inactive,pending.link_payments- The status of the link_payments capability of the account, or whether the account can directly process Link charges. Possible values:active,inactive,pending.mb_way_payments- The status of the MB WAY payments capability of the account, or whether the account can directly process MB WAY charges. Possible values:active,inactive,pending.mobilepay_payments- The status of the MobilePay capability of the account, or whether the account can directly process MobilePay charges. Possible values:active,inactive,pending.multibanco_payments- The status of the Multibanco payments capability of the account, or whether the account can directly process Multibanco charges. Possible values:active,inactive,pending.mx_bank_transfer_payments- 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. Possible values:active,inactive,pending.naver_pay_payments- The status of the NaverPay capability of the account, or whether the account can directly process NaverPay payments. Possible values:active,inactive,pending.nz_bank_account_becs_debit_payments- 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. Possible values:active,inactive,pending.oxxo_payments- The status of the OXXO payments capability of the account, or whether the account can directly process OXXO charges. Possible values:active,inactive,pending.p24_payments- The status of the P24 payments capability of the account, or whether the account can directly process P24 charges. Possible values:active,inactive,pending.pay_by_bank_payments- The status of the pay_by_bank payments capability of the account, or whether the account can directly process pay_by_bank charges. Possible values:active,inactive,pending.payco_payments- The status of the Payco capability of the account, or whether the account can directly process Payco payments. Possible values:active,inactive,pending.paynow_payments- The status of the paynow payments capability of the account, or whether the account can directly process paynow charges. Possible values:active,inactive,pending.payto_payments- The status of the PayTo capability of the account, or whether the account can directly process PayTo charges. Possible values:active,inactive,pending.pix_payments- The status of the pix payments capability of the account, or whether the account can directly process pix charges. Possible values:active,inactive,pending.promptpay_payments- The status of the promptpay payments capability of the account, or whether the account can directly process promptpay charges. Possible values:active,inactive,pending.revolut_pay_payments- The status of the RevolutPay capability of the account, or whether the account can directly process RevolutPay payments. Possible values:active,inactive,pending.samsung_pay_payments- The status of the SamsungPay capability of the account, or whether the account can directly process SamsungPay payments. Possible values:active,inactive,pending.satispay_payments- The status of the Satispay capability of the account, or whether the account can directly process Satispay payments. Possible values:active,inactive,pending.sepa_bank_transfer_payments- 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. Possible values:active,inactive,pending.sepa_debit_payments- The status of the SEPA Direct Debits payments capability of the account, or whether the account can directly process SEPA Direct Debits charges. Possible values:active,inactive,pending.sofort_payments- The status of the Sofort payments capability of the account, or whether the account can directly process Sofort charges. Possible values:active,inactive,pending.swish_payments- The status of the Swish capability of the account, or whether the account can directly process Swish payments. Possible values:active,inactive,pending.tax_reporting_us_1099_k- The status of the tax reporting 1099-K (US) capability of the account. Possible values:active,inactive,pending.tax_reporting_us_1099_misc- The status of the tax reporting 1099-MISC (US) capability of the account. Possible values:active,inactive,pending.transfers- The status of the transfers capability of the account, or whether your platform can transfer funds to the account. Possible values:active,inactive,pending.treasury- The status of the banking capability, or whether the account can have bank accounts. Possible values:active,inactive,pending.twint_payments- The status of the TWINT capability of the account, or whether the account can directly process TWINT charges. Possible values:active,inactive,pending.us_bank_account_ach_payments- The status of the US bank account ACH payments capability of the account, or whether the account can directly process US bank account charges. Possible values:active,inactive,pending.us_bank_transfer_payments- 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. Possible values:active,inactive,pending.zip_payments- The status of the Zip capability of the account, or whether the account can directly process Zip charges. Possible values:active,inactive,pending.
@type company() :: %{ optional(:address) => Stripe.Resources.Address.t() | nil, optional(:address_kana) => company_address_kana() | nil, optional(:address_kanji) => company_address_kanji() | nil, optional(:directors_provided) => boolean() | nil, optional(:directorship_declaration) => company_directorship_declaration() | nil, optional(:executives_provided) => boolean() | nil, optional(:export_license_id) => String.t() | nil, optional(:export_purpose_code) => String.t() | nil, optional(:name) => String.t() | nil, optional(:name_kana) => String.t() | nil, optional(:name_kanji) => String.t() | nil, optional(:owners_provided) => boolean() | nil, optional(:ownership_declaration) => company_ownership_declaration() | nil, optional(:ownership_exemption_reason) => String.t() | nil, optional(:phone) => String.t() | nil, optional(:registration_date) => company_registration_date() | nil, optional(:representative_declaration) => company_representative_declaration() | nil, optional(:structure) => String.t() | nil, optional(:tax_id_provided) => boolean() | nil, optional(:tax_id_registrar) => String.t() | nil, optional(:vat_id_provided) => boolean() | nil, optional(:verification) => company_verification() | nil, optional(String.t()) => term() }
addressaddress_kana- The Kana variation of the company's primary address (Japan only). Nullable.address_kanji- The Kanji variation of the company's primary address (Japan only). Nullable.directors_provided- Whether the company's directors have been provided. This Boolean will betrueif you've manually indicated that all directors are provided via thedirectors_providedparameter.directorship_declaration- This hash is used to attest that the director information provided to Stripe is both current and correct. Nullable.executives_provided- Whether the company's executives have been provided. This Boolean will betrueif you've manually indicated that all executives are provided via theexecutives_providedparameter, or if Stripe determined that sufficient executives were provided.export_license_id- The export license ID number of the company, also referred as Import Export Code (India only). Max length: 5000.export_purpose_code- The purpose code to use for export transactions (India only). Max length: 5000.name- The company's legal name. Also available for accounts where controller.requirement_collection isstripe. Max length: 5000. Nullable.name_kana- The Kana variation of the company's legal name (Japan only). Also available for accounts where controller.requirement_collection isstripe. Max length: 5000. Nullable.name_kanji- The Kanji variation of the company's legal name (Japan only). Also available for accounts where controller.requirement_collection isstripe. Max length: 5000. Nullable.owners_provided- Whether the company's owners have been provided. This Boolean will betrueif you've manually indicated that all owners are provided via theowners_providedparameter, 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 thepercent_ownershipof each owner together).ownership_declaration- This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct. Nullable.ownership_exemption_reason- This value is used to determine if a business is exempt from providing ultimate beneficial owners. See this support article and changelog for more details. Possible values:qualified_entity_exceeds_ownership_threshold,qualifies_as_financial_institution.phone- The company's phone number (used for verification). Max length: 5000. Nullable.registration_daterepresentative_declaration- This hash is used to attest that the representative is authorized to act as the representative of their legal entity. Nullable.structure- The category identifying the legal structure of the company or legal entity. Also available for accounts where controller.requirement_collection isstripe. See Business structure for more details. Possible values: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.tax_id_provided- Whether the company's business ID number was provided.tax_id_registrar- The jurisdiction in which thetax_idis registered (Germany-based companies only). Max length: 5000.vat_id_provided- Whether the company's business VAT number was provided.verification- Information on the verification state of the company. Nullable.
@type company_address_kana() :: %{ optional(:city) => String.t() | nil, optional(:country) => String.t() | nil, optional(:line1) => String.t() | nil, optional(:line2) => String.t() | nil, optional(:postal_code) => String.t() | nil, optional(:state) => String.t() | nil, optional(:town) => String.t() | nil, optional(String.t()) => term() }
city- City/Ward. Max length: 5000. Nullable.country- Two-letter country code (ISO 3166-1 alpha-2). Max length: 5000. Nullable.line1- Block/Building number. Max length: 5000. Nullable.line2- Building details. Max length: 5000. Nullable.postal_code- ZIP or postal code. Max length: 5000. Nullable.state- Prefecture. Max length: 5000. Nullable.town- Town/cho-me. Max length: 5000. Nullable.
@type company_address_kanji() :: %{ optional(:city) => String.t() | nil, optional(:country) => String.t() | nil, optional(:line1) => String.t() | nil, optional(:line2) => String.t() | nil, optional(:postal_code) => String.t() | nil, optional(:state) => String.t() | nil, optional(:town) => String.t() | nil, optional(String.t()) => term() }
city- City/Ward. Max length: 5000. Nullable.country- Two-letter country code (ISO 3166-1 alpha-2). Max length: 5000. Nullable.line1- Block/Building number. Max length: 5000. Nullable.line2- Building details. Max length: 5000. Nullable.postal_code- ZIP or postal code. Max length: 5000. Nullable.state- Prefecture. Max length: 5000. Nullable.town- Town/cho-me. Max length: 5000. Nullable.
@type company_directorship_declaration() :: %{ optional(:date) => integer() | nil, optional(:ip) => String.t() | nil, optional(:user_agent) => String.t() | nil, optional(String.t()) => term() }
date- The Unix timestamp marking when the directorship declaration attestation was made. Format: Unix timestamp. Nullable.ip- The IP address from which the directorship declaration attestation was made. Max length: 5000. Nullable.user_agent- The user-agent string from the browser where the directorship declaration attestation was made. Max length: 5000. Nullable.
@type company_ownership_declaration() :: %{ optional(:date) => integer() | nil, optional(:ip) => String.t() | nil, optional(:user_agent) => String.t() | nil, optional(String.t()) => term() }
date- The Unix timestamp marking when the beneficial owner attestation was made. Format: Unix timestamp. Nullable.ip- The IP address from which the beneficial owner attestation was made. Max length: 5000. Nullable.user_agent- The user-agent string from the browser where the beneficial owner attestation was made. Max length: 5000. Nullable.
@type company_registration_date() :: %{ optional(:day) => integer() | nil, optional(:month) => integer() | nil, optional(:year) => integer() | nil, optional(String.t()) => term() }
day- The day of registration, between 1 and 31. Nullable.month- The month of registration, between 1 and 12. Nullable.year- The four-digit year of registration. Nullable.
@type company_representative_declaration() :: %{ optional(:date) => integer() | nil, optional(:ip) => String.t() | nil, optional(:user_agent) => String.t() | nil, optional(String.t()) => term() }
date- The Unix timestamp marking when the representative declaration attestation was made. Format: Unix timestamp. Nullable.ip- The IP address from which the representative declaration attestation was made. Max length: 5000. Nullable.user_agent- The user-agent string from the browser where the representative declaration attestation was made. Max length: 5000. Nullable.
@type company_verification() :: %{ optional(:document) => company_verification_document() | nil, optional(String.t()) => term() }
document
@type company_verification_document() :: %{ optional(:back) => String.t() | Stripe.Resources.File.t() | nil, optional(:details) => String.t() | nil, optional(:details_code) => String.t() | nil, optional(:front) => String.t() | Stripe.Resources.File.t() | nil, optional(String.t()) => term() }
back- The back of a document returned by a file upload with apurposevalue ofadditional_verification. Note thatadditional_verificationfiles are not downloadable. Nullable.details- A user-displayable string describing the verification state of this document. Max length: 5000. Nullable.details_code- One ofdocument_corrupt,document_expired,document_failed_copy,document_failed_greyscale,document_failed_other,document_failed_test_mode,document_fraudulent,document_incomplete,document_invalid,document_manipulated,document_not_readable,document_not_uploaded,document_type_not_supported, ordocument_too_large. A machine-readable code specifying the verification state for this document. Max length: 5000. Nullable.front- The front of a document returned by a file upload with apurposevalue ofadditional_verification. Note thatadditional_verificationfiles are not downloadable. Nullable.
@type controller() :: %{ optional(:fees) => controller_fees() | nil, optional(:is_controller) => boolean() | nil, optional(:losses) => controller_losses() | nil, optional(:requirement_collection) => String.t() | nil, optional(:stripe_dashboard) => controller_stripe_dashboard() | nil, optional(:type) => String.t() | nil, optional(String.t()) => term() }
feesis_controller-trueif the Connect application retrieving the resource controls the account and can therefore exercise platform controls. Otherwise, this field is null.lossesrequirement_collection- A value indicating responsibility for collecting requirements on this account. Only returned when the Connect application retrieving the resource controls the account. Possible values:application,stripe.stripe_dashboardtype- The controller type. Can beapplication, if a Connect application controls the account, oraccount, if the account controls itself. Possible values:account,application.
@type controller_fees() :: %{ optional(:payer) => String.t() | nil, optional(String.t()) => term() }
payer- A value indicating the responsible payer of a bundle of Stripe fees for pricing-control eligible products on this account. Learn more about fee behavior on connected accounts. Possible values:account,application,application_custom,application_express.
@type controller_losses() :: %{ optional(:payments) => String.t() | nil, optional(String.t()) => term() }
payments- A value indicating who is liable when this account can't pay back negative balances from payments. Possible values:application,stripe.
@type controller_stripe_dashboard() :: %{ optional(:type) => String.t() | nil, optional(String.t()) => term() }
type- A value indicating the Stripe dashboard this account has access to independent of the Connect application. Possible values:express,full,none.
@type external_accounts() :: %{ optional(:data) => [Stripe.Resources.ExternalAccount.t()] | nil, optional(:has_more) => boolean() | nil, optional(:object) => String.t() | nil, optional(:url) => String.t() | nil, optional(String.t()) => term() }
data- The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards.has_more- True if this list has another page of items after this one that can be fetched.object- String representing the object's type. Objects of the same type share the same value. Always has the valuelist. Possible values:list.url- The URL where this list can be accessed. Max length: 5000.
@type future_requirements() :: %{ optional(:alternatives) => [future_requirements_alternatives()] | nil, optional(:current_deadline) => integer() | nil, optional(:currently_due) => [String.t()] | nil, optional(:disabled_reason) => String.t() | nil, optional(:errors) => [future_requirements_errors()] | nil, optional(:eventually_due) => [String.t()] | nil, optional(:past_due) => [String.t()] | nil, optional(:pending_verification) => [String.t()] | nil, optional(String.t()) => term() }
alternatives- Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the sameoriginal_fields_due, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providingoriginal_fields_duealso serves as a pathway for attempting to resolve the fields again. Nullable.current_deadline- Date on whichfuture_requirementsbecomes the mainrequirementshash andfuture_requirementsbecomes empty. After the transition,currently_duerequirements may immediately becomepast_due, but the account may also be given a grace period depending on its enablement state prior to transitioning. Format: Unix timestamp. Nullable.currently_due- Fields that need to be resolved to keep the account enabled. If not resolved byfuture_requirements[current_deadline], these fields will transition to the mainrequirementshash. Nullable.disabled_reason- This is typed as an enum for consistency withrequirements.disabled_reason. Possible values: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.errors- Details about validation and verification failures forduerequirements that must be resolved. Nullable.eventually_due- Fields you must collect when all thresholds are reached. As they become required, they appear incurrently_dueas well. Nullable.past_due- Fields that haven't been resolved byrequirements.current_deadline. These fields need to be resolved to enable the capability on the account.future_requirements.past_dueis a subset ofrequirements.past_due. Nullable.pending_verification- Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move toeventually_due,currently_due,past_dueoralternatives. Fields might appear ineventually_due,currently_due,past_dueoralternativesand inpending_verificationif one verification fails but another is still pending. Nullable.
@type future_requirements_alternatives() :: %{ optional(:alternative_fields_due) => [String.t()] | nil, optional(:original_fields_due) => [String.t()] | nil, optional(String.t()) => term() }
alternative_fields_due- Fields that can be provided to resolve all fields inoriginal_fields_due.original_fields_due- Fields that are due and can be resolved by providing all fields inalternative_fields_due.
@type future_requirements_errors() :: %{ optional(:code) => String.t() | nil, optional(:reason) => String.t() | nil, optional(:requirement) => String.t() | nil, optional(String.t()) => term() }
code- The code for the type of error. Possible values:external_request,information_missing,invalid_address_city_state_postal_code,invalid_address_highway_contract_box,invalid_address_private_mailbox,invalid_business_profile_name,invalid_business_profile_name_denylisted,invalid_company_name_denylisted,invalid_dob_age_over_maximum,invalid_dob_age_under_18,invalid_dob_age_under_minimum,invalid_product_description_length,invalid_product_description_url_match,invalid_representative_country,invalid_signator,invalid_statement_descriptor_business_mismatch,invalid_statement_descriptor_denylisted,invalid_statement_descriptor_length,invalid_statement_descriptor_prefix_denylisted,invalid_statement_descriptor_prefix_mismatch,invalid_street_address,invalid_tax_id,invalid_tax_id_format,invalid_tos_acceptance,invalid_url_denylisted,invalid_url_format,invalid_url_length,invalid_url_web_presence_detected,invalid_url_website_business_information_mismatch,invalid_url_website_empty,invalid_url_website_inaccessible,invalid_url_website_inaccessible_geoblocked,invalid_url_website_inaccessible_password_protected,invalid_url_website_incomplete,invalid_url_website_incomplete_cancellation_policy,invalid_url_website_incomplete_customer_service_details,invalid_url_website_incomplete_legal_restrictions,invalid_url_website_incomplete_refund_policy,invalid_url_website_incomplete_return_policy,invalid_url_website_incomplete_terms_and_conditions,invalid_url_website_incomplete_under_construction,invalid_url_website_other,invalid_value_other,unsupported_business_type,verification_directors_mismatch,verification_document_address_mismatch,verification_document_address_missing,verification_document_corrupt,verification_document_country_not_supported,verification_document_directors_mismatch,verification_document_dob_mismatch,verification_document_duplicate_type,verification_document_expired,verification_document_failed_copy,verification_document_failed_greyscale,verification_document_failed_other,verification_document_failed_test_mode,verification_document_fraudulent,verification_document_id_number_mismatch,verification_document_id_number_missing,verification_document_incomplete,verification_document_invalid,verification_document_issue_or_expiry_date_missing,verification_document_manipulated,verification_document_missing_back,verification_document_missing_front,verification_document_name_mismatch,verification_document_name_missing,verification_document_nationality_mismatch,verification_document_not_readable,verification_document_not_signed,verification_document_not_uploaded,verification_document_photo_mismatch,verification_document_too_large,verification_document_type_not_supported,verification_extraneous_directors,verification_failed_address_match,verification_failed_authorizer_authority,verification_failed_business_iec_number,verification_failed_document_match,verification_failed_id_number_match,verification_failed_keyed_identity,verification_failed_keyed_match,verification_failed_name_match,verification_failed_other,verification_failed_representative_authority,verification_failed_residential_address,verification_failed_tax_id_match,verification_failed_tax_id_not_issued,verification_legal_entity_structure_mismatch,verification_missing_directors,verification_missing_executives,verification_missing_owners,verification_rejected_ownership_exemption_reason,verification_requires_additional_memorandum_of_associations,verification_requires_additional_proof_of_registration,verification_supportability.reason- An informative message that indicates the error type and provides additional details about the error. Max length: 5000.requirement- The specific user onboarding requirement field (in the requirements hash) that needs to be resolved. Max length: 5000.
@type groups() :: %{ optional(:payments_pricing) => String.t() | nil, optional(String.t()) => term() }
payments_pricing- 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 for details. Max length: 5000. Nullable.
@type requirements() :: %{ optional(:alternatives) => [requirements_alternatives()] | nil, optional(:current_deadline) => integer() | nil, optional(:currently_due) => [String.t()] | nil, optional(:disabled_reason) => String.t() | nil, optional(:errors) => [requirements_errors()] | nil, optional(:eventually_due) => [String.t()] | nil, optional(:past_due) => [String.t()] | nil, optional(:pending_verification) => [String.t()] | nil, optional(String.t()) => term() }
alternatives- Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the sameoriginal_fields_due, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providingoriginal_fields_duealso serves as a pathway for attempting to resolve the fields again. Nullable.current_deadline- Date by which the fields incurrently_duemust be collected to keep the account enabled. These fields may disable the account sooner if the next threshold is reached before they are collected. Format: Unix timestamp. Nullable.currently_due- Fields that need to be resolved to keep the account enabled. If not resolved bycurrent_deadline, these fields will appear inpast_dueas well, and the account is disabled. Nullable.disabled_reason- If the account is disabled, this enum describes why. Learn more about handling verification issues. Possible values: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.errors- Details about validation and verification failures forduerequirements that must be resolved. Nullable.eventually_due- Fields you must collect when all thresholds are reached. As they become required, they appear incurrently_dueas well, andcurrent_deadlinebecomes set. Nullable.past_due- Fields that haven't been resolved bycurrent_deadline. These fields need to be resolved to enable the account. Nullable.pending_verification- Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move toeventually_due,currently_due,past_dueoralternatives. Fields might appear ineventually_due,currently_due,past_dueoralternativesand inpending_verificationif one verification fails but another is still pending. Nullable.
@type requirements_alternatives() :: %{ optional(:alternative_fields_due) => [String.t()] | nil, optional(:original_fields_due) => [String.t()] | nil, optional(String.t()) => term() }
alternative_fields_due- Fields that can be provided to resolve all fields inoriginal_fields_due.original_fields_due- Fields that are due and can be resolved by providing all fields inalternative_fields_due.
@type requirements_errors() :: %{ optional(:code) => String.t() | nil, optional(:reason) => String.t() | nil, optional(:requirement) => String.t() | nil, optional(String.t()) => term() }
code- The code for the type of error. Possible values:external_request,information_missing,invalid_address_city_state_postal_code,invalid_address_highway_contract_box,invalid_address_private_mailbox,invalid_business_profile_name,invalid_business_profile_name_denylisted,invalid_company_name_denylisted,invalid_dob_age_over_maximum,invalid_dob_age_under_18,invalid_dob_age_under_minimum,invalid_product_description_length,invalid_product_description_url_match,invalid_representative_country,invalid_signator,invalid_statement_descriptor_business_mismatch,invalid_statement_descriptor_denylisted,invalid_statement_descriptor_length,invalid_statement_descriptor_prefix_denylisted,invalid_statement_descriptor_prefix_mismatch,invalid_street_address,invalid_tax_id,invalid_tax_id_format,invalid_tos_acceptance,invalid_url_denylisted,invalid_url_format,invalid_url_length,invalid_url_web_presence_detected,invalid_url_website_business_information_mismatch,invalid_url_website_empty,invalid_url_website_inaccessible,invalid_url_website_inaccessible_geoblocked,invalid_url_website_inaccessible_password_protected,invalid_url_website_incomplete,invalid_url_website_incomplete_cancellation_policy,invalid_url_website_incomplete_customer_service_details,invalid_url_website_incomplete_legal_restrictions,invalid_url_website_incomplete_refund_policy,invalid_url_website_incomplete_return_policy,invalid_url_website_incomplete_terms_and_conditions,invalid_url_website_incomplete_under_construction,invalid_url_website_other,invalid_value_other,unsupported_business_type,verification_directors_mismatch,verification_document_address_mismatch,verification_document_address_missing,verification_document_corrupt,verification_document_country_not_supported,verification_document_directors_mismatch,verification_document_dob_mismatch,verification_document_duplicate_type,verification_document_expired,verification_document_failed_copy,verification_document_failed_greyscale,verification_document_failed_other,verification_document_failed_test_mode,verification_document_fraudulent,verification_document_id_number_mismatch,verification_document_id_number_missing,verification_document_incomplete,verification_document_invalid,verification_document_issue_or_expiry_date_missing,verification_document_manipulated,verification_document_missing_back,verification_document_missing_front,verification_document_name_mismatch,verification_document_name_missing,verification_document_nationality_mismatch,verification_document_not_readable,verification_document_not_signed,verification_document_not_uploaded,verification_document_photo_mismatch,verification_document_too_large,verification_document_type_not_supported,verification_extraneous_directors,verification_failed_address_match,verification_failed_authorizer_authority,verification_failed_business_iec_number,verification_failed_document_match,verification_failed_id_number_match,verification_failed_keyed_identity,verification_failed_keyed_match,verification_failed_name_match,verification_failed_other,verification_failed_representative_authority,verification_failed_residential_address,verification_failed_tax_id_match,verification_failed_tax_id_not_issued,verification_legal_entity_structure_mismatch,verification_missing_directors,verification_missing_executives,verification_missing_owners,verification_rejected_ownership_exemption_reason,verification_requires_additional_memorandum_of_associations,verification_requires_additional_proof_of_registration,verification_supportability.reason- An informative message that indicates the error type and provides additional details about the error. Max length: 5000.requirement- The specific user onboarding requirement field (in the requirements hash) that needs to be resolved. Max length: 5000.
@type settings() :: %{ optional(:bacs_debit_payments) => settings_bacs_debit_payments() | nil, optional(:branding) => settings_branding() | nil, optional(:card_issuing) => settings_card_issuing() | nil, optional(:card_payments) => settings_card_payments() | nil, optional(:dashboard) => settings_dashboard() | nil, optional(:invoices) => settings_invoices() | nil, optional(:payments) => settings_payments() | nil, optional(:payouts) => settings_payouts() | nil, optional(:sepa_debit_payments) => settings_sepa_debit_payments() | nil, optional(:treasury) => settings_treasury() | nil, optional(String.t()) => term() }
bacs_debit_paymentsbrandingcard_issuingcard_paymentsdashboardinvoicespaymentspayoutssepa_debit_paymentstreasury
@type settings_bacs_debit_payments() :: %{ optional(:display_name) => String.t() | nil, optional(:service_user_number) => String.t() | nil, optional(String.t()) => term() }
display_name- The Bacs Direct Debit display name for this account. For payments made with Bacs Direct Debit, this name appears on the mandate as the statement descriptor. Mobile banking apps display it as the name of the business. To use custom branding, set the Bacs Direct Debit Display Name during or right after creation. Custom branding incurs an additional monthly fee for the platform. The fee appears 5 business days after requesting Bacs. If you don't set the display name before requesting Bacs capability, it's automatically set as "Stripe" and the account is onboarded to Stripe branding, which is free. Max length: 5000. Nullable.service_user_number- The Bacs Direct Debit Service user number for this account. For payments made with Bacs Direct Debit, this number is a unique identifier of the account with our banking partners. Max length: 5000. Nullable.
@type settings_branding() :: %{ optional(:icon) => String.t() | Stripe.Resources.File.t() | nil, optional(:logo) => String.t() | Stripe.Resources.File.t() | nil, optional(:primary_color) => String.t() | nil, optional(:secondary_color) => String.t() | nil, optional(String.t()) => term() }
icon- (ID of a file upload) An icon for the account. Must be square and at least 128px x 128px. Nullable.logo- (ID of a file upload) A logo for the account that will be used in Checkout instead of the icon and without the account's name next to it if provided. Must be at least 128px x 128px. Nullable.primary_color- A CSS hex color value representing the primary branding color for this account Max length: 5000. Nullable.secondary_color- A CSS hex color value representing the secondary branding color for this account Max length: 5000. Nullable.
@type settings_card_issuing() :: %{ optional(:tos_acceptance) => settings_card_issuing_tos_acceptance() | nil, optional(String.t()) => term() }
tos_acceptance
@type settings_card_issuing_tos_acceptance() :: %{ optional(:date) => integer() | nil, optional(:ip) => String.t() | nil, optional(:user_agent) => String.t() | nil, optional(String.t()) => term() }
date- The Unix timestamp marking when the account representative accepted the service agreement. Nullable.ip- The IP address from which the account representative accepted the service agreement. Max length: 5000. Nullable.user_agent- The user agent of the browser from which the account representative accepted the service agreement. Max length: 5000.
@type settings_card_payments() :: %{ optional(:decline_on) => settings_card_payments_decline_on() | nil, optional(:statement_descriptor_prefix) => String.t() | nil, optional(:statement_descriptor_prefix_kana) => String.t() | nil, optional(:statement_descriptor_prefix_kanji) => String.t() | nil, optional(String.t()) => term() }
decline_onstatement_descriptor_prefix- The default text that appears on credit card statements when a charge is made. This field prefixes any dynamicstatement_descriptorspecified on the charge.statement_descriptor_prefixis useful for maximizing descriptor space for the dynamic portion. Max length: 5000. Nullable.statement_descriptor_prefix_kana- The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamicstatement_descriptor_suffix_kanaspecified on the charge.statement_descriptor_prefix_kanais useful for maximizing descriptor space for the dynamic portion. Max length: 5000. Nullable.statement_descriptor_prefix_kanji- The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamicstatement_descriptor_suffix_kanjispecified on the charge.statement_descriptor_prefix_kanjiis useful for maximizing descriptor space for the dynamic portion. Max length: 5000. Nullable.
@type settings_card_payments_decline_on() :: %{ optional(:avs_failure) => boolean() | nil, optional(:cvc_failure) => boolean() | nil, optional(String.t()) => term() }
avs_failure- Whether Stripe automatically declines charges with an incorrect ZIP or postal code. This setting only applies when a ZIP or postal code is provided and they fail bank verification.cvc_failure- Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification.
@type settings_dashboard() :: %{ optional(:display_name) => String.t() | nil, optional(:timezone) => String.t() | nil, optional(String.t()) => term() }
display_name- The display name for this account. This is used on the Stripe Dashboard to differentiate between accounts. Max length: 5000. Nullable.timezone- The timezone used in the Stripe Dashboard for this account. A list of possible time zone values is maintained at the IANA Time Zone Database. Max length: 5000. Nullable.
@type settings_invoices() :: %{ optional(:default_account_tax_ids) => [String.t() | Stripe.Resources.TaxId.t()] | nil, optional(:hosted_payment_method_save) => String.t() | nil, optional(String.t()) => term() }
default_account_tax_ids- The list of default Account Tax IDs to automatically include on invoices. Account Tax IDs get added when an invoice is finalized. Nullable.hosted_payment_method_save- Whether to save the payment method after a payment is completed for a one-time invoice or a subscription invoice when the customer already has a default payment method on the hosted invoice page. Possible values:always,never,offer. Nullable.
@type settings_payments() :: %{ optional(:statement_descriptor) => String.t() | nil, optional(:statement_descriptor_kana) => String.t() | nil, optional(:statement_descriptor_kanji) => String.t() | nil, optional(:statement_descriptor_prefix_kana) => String.t() | nil, optional(:statement_descriptor_prefix_kanji) => String.t() | nil, optional(String.t()) => term() }
statement_descriptor- The default text that appears on credit card statements when a charge is made. This field prefixes any dynamicstatement_descriptorspecified on the charge. Max length: 5000. Nullable.statement_descriptor_kana- The Kana variation ofstatement_descriptorused for charges in Japan. Japanese statement descriptors have special requirements. Max length: 5000. Nullable.statement_descriptor_kanji- The Kanji variation ofstatement_descriptorused for charges in Japan. Japanese statement descriptors have special requirements. Max length: 5000. Nullable.statement_descriptor_prefix_kana- The Kana variation ofstatement_descriptor_prefixused for card charges in Japan. Japanese statement descriptors have special requirements. Max length: 5000. Nullable.statement_descriptor_prefix_kanji- The Kanji variation ofstatement_descriptor_prefixused for card charges in Japan. Japanese statement descriptors have special requirements. Max length: 5000. Nullable.
@type settings_payouts() :: %{ optional(:debit_negative_balances) => boolean() | nil, optional(:schedule) => settings_payouts_schedule() | nil, optional(:statement_descriptor) => String.t() | nil, optional(String.t()) => term() }
debit_negative_balances- A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See Understanding Connect account balances for details. The default value isfalsewhen controller.requirement_collection isapplication, which includes Custom accounts, otherwisetrue.schedulestatement_descriptor- The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard. Max length: 5000. Nullable.
@type settings_payouts_schedule() :: %{ optional(:delay_days) => integer() | nil, optional(:interval) => String.t() | nil, optional(:monthly_anchor) => integer() | nil, optional(:monthly_payout_days) => [integer()] | nil, optional(:weekly_anchor) => String.t() | nil, optional(:weekly_payout_days) => [String.t()] | nil, optional(String.t()) => term() }
delay_days- The number of days charges for the account will be held before being paid out.interval- How frequently funds will be paid out. One ofmanual(payouts only created via API call),daily,weekly, ormonthly. Max length: 5000.monthly_anchor- The day of the month funds will be paid out. Only shown ifintervalis monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months.monthly_payout_days- The days of the month funds will be paid out. Only shown ifintervalis monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months.weekly_anchor- The day of the week funds will be paid out, of the style 'monday', 'tuesday', etc. Only shown ifintervalis weekly. Max length: 5000.weekly_payout_days- The days of the week when available funds are paid out, specified as an array, for example, [monday,tuesday]. Only shown ifintervalis weekly.
@type settings_sepa_debit_payments() :: %{ optional(:creditor_id) => String.t() | nil, optional(String.t()) => term() }
creditor_id- SEPA creditor identifier that identifies the company making the payment. Max length: 5000.
@type settings_treasury() :: %{ optional(:tos_acceptance) => settings_treasury_tos_acceptance() | nil, optional(String.t()) => term() }
tos_acceptance
@type settings_treasury_tos_acceptance() :: %{ optional(:date) => integer() | nil, optional(:ip) => String.t() | nil, optional(:user_agent) => String.t() | nil, optional(String.t()) => term() }
date- The Unix timestamp marking when the account representative accepted the service agreement. Nullable.ip- The IP address from which the account representative accepted the service agreement. Max length: 5000. Nullable.user_agent- The user agent of the browser from which the account representative accepted the service agreement. Max length: 5000.
@type t() :: %Stripe.Resources.Account{ business_profile: business_profile() | nil, business_type: String.t() | nil, capabilities: capabilities() | nil, charges_enabled: boolean() | nil, company: company() | nil, controller: controller() | nil, country: String.t() | nil, created: integer() | nil, default_currency: String.t() | nil, details_submitted: boolean() | nil, email: String.t() | nil, external_accounts: external_accounts() | nil, future_requirements: future_requirements() | nil, groups: groups() | nil, id: String.t(), individual: Stripe.Resources.Person.t() | nil, metadata: %{required(String.t()) => String.t()} | nil, object: String.t(), payouts_enabled: boolean() | nil, requirements: requirements() | nil, settings: settings() | nil, tos_acceptance: tos_acceptance() | nil, type: String.t() | nil }
business_profile- Business information about the account. Nullable. Expandable.business_type- The business type. Possible values:company,government_entity,individual,non_profit. Nullable.capabilities- Expandable.charges_enabled- Whether the account can process charges.company- Expandable.controller- Expandable.country- The account's country. Max length: 5000.created- Time at which the account was connected. Measured in seconds since the Unix epoch. Format: Unix timestamp.default_currency- 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. Max length: 5000.details_submitted- 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 to finish submitting account details.email- 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. Max length: 5000. Nullable.external_accounts- External accounts (bank accounts and debit cards) currently attached to this account. External accounts are only returned for requests wherecontroller[is_controller]is true. Expandable.future_requirements- Expandable.groups- The groups associated with the account. Nullable. Expandable.id- Unique identifier for the object. Max length: 5000.individual- Expandable.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.object- String representing the object's type. Objects of the same type share the same value. Possible values:account.payouts_enabled- Whether the funds in this account can be paid out.requirements- Expandable.settings- Options for customizing how the account functions within Stripe. Nullable. Expandable.tos_acceptance- Expandable.type- The Stripe account type. Can bestandard,express,custom, ornone. Possible values:custom,express,none,standard.
@type tos_acceptance() :: %{ optional(:date) => integer() | nil, optional(:ip) => String.t() | nil, optional(:service_agreement) => String.t() | nil, optional(:user_agent) => String.t() | nil, optional(String.t()) => term() }
date- The Unix timestamp marking when the account representative accepted their service agreement Format: Unix timestamp. Nullable.ip- The IP address from which the account representative accepted their service agreement Max length: 5000. Nullable.service_agreement- The user's service agreement type Max length: 5000.user_agent- The user agent of the browser from which the account representative accepted their service agreement Max length: 5000. Nullable.