stripe
Version:
Stripe API wrapper
930 lines • 265 kB
TypeScript
import { StripeResource } from '../StripeResource.js';
import { Capability } from './Capabilities.js';
import { DeletedExternalAccount, ExternalAccount } from './ExternalAccounts.js';
import { LoginLink } from './LoginLinks.js';
import { DeletedPerson, Person } from './Persons.js';
import { File } from './Files.js';
import { TaxId } from './TaxIds.js';
import { Emptyable, MetadataParam, AddressParam, JapanAddressParam, PaginationParams, RangeQueryParam, Metadata, Address } from '../shared.js';
import { RequestOptions, Response, ApiListPromise, ApiList } from '../lib.js';
export declare class AccountResource extends StripeResource {
/**
* With [Connect](https://docs.stripe.com/connect), you can delete accounts you manage.
*
* Test-mode accounts can be deleted at any time.
*
* Live-mode accounts that have access to the standard dashboard and Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. All other Live-mode accounts, can be deleted when all [balances](https://docs.stripe.com/api/balance/balance_object) are zero.
*
* If you want to delete your own account, use the [account information tab in your account settings](https://dashboard.stripe.com/settings/account) instead.
*/
del(id: string, params?: AccountDeleteParams, options?: RequestOptions): Promise<Response<DeletedAccount>>;
/**
* Retrieves the details of an account. Pass `null` as the account id to retrieve details about your own account.
*/
retrieve(id: string | null, params?: AccountRetrieveParams, options?: RequestOptions): Promise<Response<Account>>;
/**
* Updates a [connected account](https://docs.stripe.com/connect/accounts) by setting the values of the parameters passed. Any parameters not provided are
* left unchanged.
*
* For accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection)
* is application, which includes Custom accounts, you can update any information on the account.
*
* For accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection)
* is stripe, which includes Standard and Express accounts, you can update all information until you create
* an [Account Link or <a href="/api/account_sessions">Account Session](https://docs.stripe.com/api/account_links) to start Connect onboarding,
* after which some properties can no longer be updated.
*
* To update your own account, use the [Dashboard](https://dashboard.stripe.com/settings/account). Refer to our
* [Connect](https://docs.stripe.com/docs/connect/updating-accounts) documentation to learn more about updating accounts.
*/
update(id: string, params?: AccountUpdateParams, options?: RequestOptions): Promise<Response<Account>>;
/**
* Retrieves the details of an account.
*/
retrieveCurrent(params?: AccountRetrieveCurrentParams, options?: RequestOptions): Promise<Response<Account>>;
/**
* Returns a list of accounts connected to your platform via [Connect](https://docs.stripe.com/docs/connect). If you're not a platform, the list is empty.
*/
list(params?: AccountListParams, options?: RequestOptions): ApiListPromise<Account>;
/**
* With [Connect](https://docs.stripe.com/docs/connect), you can create Stripe accounts for your users.
* To do this, you'll first need to [register your platform](https://dashboard.stripe.com/account/applications/settings).
*
* If you've already collected information for your connected accounts, you [can prefill that information](https://docs.stripe.com/docs/connect/best-practices#onboarding) when
* creating the account. Connect Onboarding won't ask for the prefilled information during account onboarding.
* You can prefill any information on the account.
*/
create(params?: AccountCreateParams, options?: RequestOptions): Promise<Response<Account>>;
/**
* With [Connect](https://docs.stripe.com/connect), you can reject accounts that you have flagged as suspicious.
*
* Only accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be rejected. Test-mode accounts can be rejected at any time. Live-mode accounts can only be rejected after all balances are zero.
*/
reject(id: string, params: AccountRejectParams, options?: RequestOptions): Promise<Response<Account>>;
/**
* Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.
*/
listCapabilities(id: string, params?: AccountListCapabilitiesParams, options?: RequestOptions): ApiListPromise<Capability>;
/**
* Retrieves information about the specified Account Capability.
*/
retrieveCapability(accountId: string, id: string, params?: AccountRetrieveCapabilityParams, options?: RequestOptions): Promise<Response<Capability>>;
/**
* Updates an existing Account Capability. Request or remove a capability by updating its requested parameter.
*/
updateCapability(accountId: string, id: string, params?: AccountUpdateCapabilityParams, options?: RequestOptions): Promise<Response<Capability>>;
/**
* Delete a specified external account for a given account.
*/
deleteExternalAccount(accountId: string, id: string, params?: AccountDeleteExternalAccountParams, options?: RequestOptions): Promise<Response<DeletedExternalAccount>>;
/**
* Retrieve a specified external account for a given account.
*/
retrieveExternalAccount(accountId: string, id: string, params?: AccountRetrieveExternalAccountParams, options?: RequestOptions): Promise<Response<ExternalAccount>>;
/**
* Updates the metadata, account holder name, account holder type of a bank account belonging to
* a connected account and optionally sets it as the default for its currency. Other bank account
* details are not editable by design.
*
* You can only update bank accounts when [account.controller.requirement_collection is application, which includes <a href="/connect/custom-accounts">Custom accounts](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection).
*
* You can re-enable a disabled bank account by performing an update call without providing any
* arguments or changes.
*/
updateExternalAccount(accountId: string, id: string, params?: AccountUpdateExternalAccountParams, options?: RequestOptions): Promise<Response<ExternalAccount>>;
/**
* List external accounts for an account.
*/
listExternalAccounts(id: string, params?: AccountListExternalAccountsParams, options?: RequestOptions): ApiListPromise<ExternalAccount>;
/**
* Create an external account for a given account.
*/
createExternalAccount(id: string, params: AccountCreateExternalAccountParams, options?: RequestOptions): Promise<Response<ExternalAccount>>;
/**
* Creates a login link for a connected account to access the Express Dashboard.
*
* You can only create login links for accounts that use the [Express Dashboard](https://docs.stripe.com/connect/express-dashboard) and are connected to your platform.
*/
createLoginLink(id: string, params?: AccountCreateLoginLinkParams, options?: RequestOptions): Promise<Response<LoginLink>>;
/**
* Deletes an existing person's relationship to the account's legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.
*/
deletePerson(accountId: string, id: string, params?: AccountDeletePersonParams, options?: RequestOptions): Promise<Response<DeletedPerson>>;
/**
* Retrieves an existing person.
*/
retrievePerson(accountId: string, id: string, params?: AccountRetrievePersonParams, options?: RequestOptions): Promise<Response<Person>>;
/**
* Updates an existing person.
*/
updatePerson(accountId: string, id: string, params?: AccountUpdatePersonParams, options?: RequestOptions): Promise<Response<Person>>;
/**
* Returns a list of people associated with the account's legal entity. The people are returned sorted by creation date, with the most recent people appearing first.
*/
listPersons(id: string, params?: AccountListPersonsParams, options?: RequestOptions): ApiListPromise<Person>;
/**
* Creates a new person.
*/
createPerson(id: string, params?: AccountCreatePersonParams, options?: RequestOptions): Promise<Response<Person>>;
}
export interface Account {
/**
* Unique identifier for the object.
*/
id: string;
/**
* String representing the object's type. Objects of the same type share the same value.
*/
object: 'account';
/**
* Business information about the account.
*/
business_profile?: Account.BusinessProfile | null;
/**
* The business type.
*/
business_type?: Account.BusinessType | null;
capabilities?: Account.Capabilities;
/**
* Whether the account can process charges.
*/
charges_enabled: boolean;
company?: Account.Company;
controller?: Account.Controller;
/**
* The account's country.
*/
country?: string;
/**
* Time at which the account was connected. Measured in seconds since the Unix epoch.
*/
created?: number;
/**
* 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).
*/
default_currency?: string;
/**
* Always true for a deleted object
*/
deleted?: void;
/**
* 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](https://docs.stripe.com/connect/onboarding) to finish submitting account details.
*/
details_submitted: boolean;
/**
* 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.
*/
email: string | null;
/**
* 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.
*/
external_accounts?: ApiList<ExternalAccount>;
future_requirements?: Account.FutureRequirements;
/**
* The groups associated with the account.
*/
groups?: Account.Groups | null;
/**
* 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](https://docs.stripe.com/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](https://docs.stripe.com/connect/standard-accounts) or [Express onboarding](https://docs.stripe.com/connect/express-accounts) documentation for information about prefilling information and account onboarding steps. Learn more about [handling identity verification with the API](https://docs.stripe.com/connect/handling-api-verification#person-information).
*/
individual?: Person;
/**
* 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.
*/
metadata?: Metadata;
/**
* Whether the funds in this account can be paid out.
*/
payouts_enabled: boolean;
requirements?: Account.Requirements;
/**
* Options for customizing how the account functions within Stripe.
*/
settings?: Account.Settings | null;
tos_acceptance?: Account.TosAcceptance;
/**
* The Stripe account type. Can be `standard`, `express`, `custom`, or `none`.
*/
type: Account.Type;
}
export interface DeletedAccount {
/**
* Unique identifier for the object.
*/
id: string;
/**
* String representing the object's type. Objects of the same type share the same value.
*/
object: 'account';
/**
* Always true for a deleted object
*/
deleted: true;
}
export declare namespace Account {
interface BusinessProfile {
/**
* The applicant's gross annual revenue for its preceding fiscal year.
*/
annual_revenue?: BusinessProfile.AnnualRevenue | null;
/**
* An estimated upper bound of employees, contractors, vendors, etc. currently working for the business.
*/
estimated_worker_count?: number | null;
/**
* [The merchant category code for the account](https://docs.stripe.com/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide.
*/
mcc: string | null;
/**
* Whether the business is a minority-owned, women-owned, and/or LGBTQI+ -owned business.
*/
minority_owned_business_designation: Array<BusinessProfile.MinorityOwnedBusinessDesignation> | null;
monthly_estimated_revenue?: BusinessProfile.MonthlyEstimatedRevenue;
/**
* The customer-facing business name.
*/
name: string | null;
/**
* Internal-only description of the product sold or service provided by the business. It's used by Stripe for risk and underwriting purposes.
*/
product_description?: string | null;
/**
* A publicly available mailing address for sending support issues to.
*/
support_address: Address | null;
/**
* A publicly available email address for sending support issues to.
*/
support_email: string | null;
/**
* A publicly available phone number to call with support issues.
*/
support_phone: string | null;
/**
* A publicly available website for handling support issues.
*/
support_url: string | null;
/**
* The business's publicly available website.
*/
url: string | null;
}
type BusinessType = 'company' | 'government_entity' | 'individual' | 'non_profit';
interface Capabilities {
/**
* 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.
*/
acss_debit_payments?: Capabilities.AcssDebitPayments;
/**
* The status of the Affirm capability of the account, or whether the account can directly process Affirm charges.
*/
affirm_payments?: Capabilities.AffirmPayments;
/**
* The status of the Afterpay Clearpay capability of the account, or whether the account can directly process Afterpay Clearpay charges.
*/
afterpay_clearpay_payments?: Capabilities.AfterpayClearpayPayments;
/**
* The status of the Alma capability of the account, or whether the account can directly process Alma payments.
*/
alma_payments?: Capabilities.AlmaPayments;
/**
* The status of the AmazonPay capability of the account, or whether the account can directly process AmazonPay payments.
*/
amazon_pay_payments?: Capabilities.AmazonPayPayments;
/**
* 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.
*/
au_becs_debit_payments?: Capabilities.AuBecsDebitPayments;
/**
* The status of the Bacs Direct Debits payments capability of the account, or whether the account can directly process Bacs Direct Debits charges.
*/
bacs_debit_payments?: Capabilities.BacsDebitPayments;
/**
* The status of the Bancontact payments capability of the account, or whether the account can directly process Bancontact charges.
*/
bancontact_payments?: Capabilities.BancontactPayments;
/**
* The status of the customer_balance payments capability of the account, or whether the account can directly process customer_balance charges.
*/
bank_transfer_payments?: Capabilities.BankTransferPayments;
/**
* The status of the Billie capability of the account, or whether the account can directly process Billie payments.
*/
billie_payments?: Capabilities.BilliePayments;
/**
* The status of the blik payments capability of the account, or whether the account can directly process blik charges.
*/
blik_payments?: Capabilities.BlikPayments;
/**
* The status of the boleto payments capability of the account, or whether the account can directly process boleto charges.
*/
boleto_payments?: Capabilities.BoletoPayments;
/**
* The status of the card issuing capability of the account, or whether you can use Issuing to distribute funds on cards
*/
card_issuing?: Capabilities.CardIssuing;
/**
* The status of the card payments capability of the account, or whether the account can directly process credit and debit card charges.
*/
card_payments?: Capabilities.CardPayments;
/**
* 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.
*/
cartes_bancaires_payments?: Capabilities.CartesBancairesPayments;
/**
* The status of the Cash App Pay capability of the account, or whether the account can directly process Cash App Pay payments.
*/
cashapp_payments?: Capabilities.CashappPayments;
/**
* The status of the Crypto capability of the account, or whether the account can directly process Crypto payments.
*/
crypto_payments?: Capabilities.CryptoPayments;
/**
* The status of the EPS payments capability of the account, or whether the account can directly process EPS charges.
*/
eps_payments?: Capabilities.EpsPayments;
/**
* The status of the FPX payments capability of the account, or whether the account can directly process FPX charges.
*/
fpx_payments?: Capabilities.FpxPayments;
/**
* 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.
*/
gb_bank_transfer_payments?: Capabilities.GbBankTransferPayments;
/**
* The status of the giropay payments capability of the account, or whether the account can directly process giropay charges.
*/
giropay_payments?: Capabilities.GiropayPayments;
/**
* The status of the GrabPay payments capability of the account, or whether the account can directly process GrabPay charges.
*/
grabpay_payments?: Capabilities.GrabpayPayments;
/**
* The status of the iDEAL payments capability of the account, or whether the account can directly process iDEAL charges.
*/
ideal_payments?: Capabilities.IdealPayments;
/**
* The status of the india_international_payments capability of the account, or whether the account can process international charges (non INR) in India.
*/
india_international_payments?: Capabilities.IndiaInternationalPayments;
/**
* 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.
*/
jcb_payments?: Capabilities.JcbPayments;
/**
* 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.
*/
jp_bank_transfer_payments?: Capabilities.JpBankTransferPayments;
/**
* The status of the KakaoPay capability of the account, or whether the account can directly process KakaoPay payments.
*/
kakao_pay_payments?: Capabilities.KakaoPayPayments;
/**
* The status of the Klarna payments capability of the account, or whether the account can directly process Klarna charges.
*/
klarna_payments?: Capabilities.KlarnaPayments;
/**
* The status of the konbini payments capability of the account, or whether the account can directly process konbini charges.
*/
konbini_payments?: Capabilities.KonbiniPayments;
/**
* The status of the KrCard capability of the account, or whether the account can directly process KrCard payments.
*/
kr_card_payments?: Capabilities.KrCardPayments;
/**
* The status of the legacy payments capability of the account.
*/
legacy_payments?: Capabilities.LegacyPayments;
/**
* The status of the link_payments capability of the account, or whether the account can directly process Link charges.
*/
link_payments?: Capabilities.LinkPayments;
/**
* The status of the MB WAY payments capability of the account, or whether the account can directly process MB WAY charges.
*/
mb_way_payments?: Capabilities.MbWayPayments;
/**
* The status of the MobilePay capability of the account, or whether the account can directly process MobilePay charges.
*/
mobilepay_payments?: Capabilities.MobilepayPayments;
/**
* The status of the Multibanco payments capability of the account, or whether the account can directly process Multibanco charges.
*/
multibanco_payments?: Capabilities.MultibancoPayments;
/**
* 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.
*/
mx_bank_transfer_payments?: Capabilities.MxBankTransferPayments;
/**
* The status of the NaverPay capability of the account, or whether the account can directly process NaverPay payments.
*/
naver_pay_payments?: Capabilities.NaverPayPayments;
/**
* 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.
*/
nz_bank_account_becs_debit_payments?: Capabilities.NzBankAccountBecsDebitPayments;
/**
* The status of the OXXO payments capability of the account, or whether the account can directly process OXXO charges.
*/
oxxo_payments?: Capabilities.OxxoPayments;
/**
* The status of the P24 payments capability of the account, or whether the account can directly process P24 charges.
*/
p24_payments?: Capabilities.P24Payments;
/**
* The status of the pay_by_bank payments capability of the account, or whether the account can directly process pay_by_bank charges.
*/
pay_by_bank_payments?: Capabilities.PayByBankPayments;
/**
* The status of the Payco capability of the account, or whether the account can directly process Payco payments.
*/
payco_payments?: Capabilities.PaycoPayments;
/**
* The status of the paynow payments capability of the account, or whether the account can directly process paynow charges.
*/
paynow_payments?: Capabilities.PaynowPayments;
/**
* The status of the PayTo capability of the account, or whether the account can directly process PayTo charges.
*/
payto_payments?: Capabilities.PaytoPayments;
/**
* The status of the pix payments capability of the account, or whether the account can directly process pix charges.
*/
pix_payments?: Capabilities.PixPayments;
/**
* The status of the promptpay payments capability of the account, or whether the account can directly process promptpay charges.
*/
promptpay_payments?: Capabilities.PromptpayPayments;
/**
* The status of the RevolutPay capability of the account, or whether the account can directly process RevolutPay payments.
*/
revolut_pay_payments?: Capabilities.RevolutPayPayments;
/**
* The status of the SamsungPay capability of the account, or whether the account can directly process SamsungPay payments.
*/
samsung_pay_payments?: Capabilities.SamsungPayPayments;
/**
* The status of the Satispay capability of the account, or whether the account can directly process Satispay payments.
*/
satispay_payments?: Capabilities.SatispayPayments;
/**
* 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_bank_transfer_payments?: Capabilities.SepaBankTransferPayments;
/**
* The status of the SEPA Direct Debits payments capability of the account, or whether the account can directly process SEPA Direct Debits charges.
*/
sepa_debit_payments?: Capabilities.SepaDebitPayments;
/**
* The status of the Sofort payments capability of the account, or whether the account can directly process Sofort charges.
*/
sofort_payments?: Capabilities.SofortPayments;
/**
* The status of the Swish capability of the account, or whether the account can directly process Swish payments.
*/
swish_payments?: Capabilities.SwishPayments;
/**
* The status of the tax reporting 1099-K (US) capability of the account.
*/
tax_reporting_us_1099_k?: Capabilities.TaxReportingUs1099K;
/**
* The status of the tax reporting 1099-MISC (US) capability of the account.
*/
tax_reporting_us_1099_misc?: Capabilities.TaxReportingUs1099Misc;
/**
* The status of the transfers capability of the account, or whether your platform can transfer funds to the account.
*/
transfers?: Capabilities.Transfers;
/**
* The status of the banking capability, or whether the account can have bank accounts.
*/
treasury?: Capabilities.Treasury;
/**
* The status of the TWINT capability of the account, or whether the account can directly process TWINT charges.
*/
twint_payments?: Capabilities.TwintPayments;
/**
* The status of the upi payments capability of the account, or whether the account can directly process upi charges.
*/
upi_payments?: Capabilities.UpiPayments;
/**
* 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_account_ach_payments?: Capabilities.UsBankAccountAchPayments;
/**
* 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.
*/
us_bank_transfer_payments?: Capabilities.UsBankTransferPayments;
/**
* The status of the Zip capability of the account, or whether the account can directly process Zip charges.
*/
zip_payments?: Capabilities.ZipPayments;
}
interface Company {
address?: Address;
/**
* The Kana variation of the company's primary address (Japan only).
*/
address_kana?: Company.AddressKana | null;
/**
* The Kanji variation of the company's primary address (Japan only).
*/
address_kanji?: Company.AddressKanji | null;
/**
* 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).
*/
directors_provided?: boolean;
/**
* This hash is used to attest that the director information provided to Stripe is both current and correct.
*/
directorship_declaration?: Company.DirectorshipDeclaration | null;
/**
* 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.
*/
executives_provided?: boolean;
/**
* The export license ID number of the company, also referred as Import Export Code (India only).
*/
export_license_id?: string;
/**
* The purpose code to use for export transactions (India only).
*/
export_purpose_code?: string;
/**
* The company's legal name. Also available for accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
*/
name?: string | null;
/**
* The Kana variation of the company's legal name (Japan only). Also available for accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
*/
name_kana?: string | null;
/**
* The Kanji variation of the company's legal name (Japan only). Also available for accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
*/
name_kanji?: string | null;
/**
* 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).
*/
owners_provided?: boolean;
/**
* This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct.
*/
ownership_declaration?: Company.OwnershipDeclaration | null;
/**
* 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.
*/
ownership_exemption_reason?: Company.OwnershipExemptionReason;
/**
* The company's phone number (used for verification).
*/
phone?: string | null;
registration_date?: Company.RegistrationDate;
/**
* This hash is used to attest that the representative is authorized to act as the representative of their legal entity.
*/
representative_declaration?: Company.RepresentativeDeclaration | null;
/**
* The category identifying the legal structure of the company or legal entity. Also available for accounts where [controller.requirement_collection](https://docs.stripe.com/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.
*/
structure?: Company.Structure;
/**
* Whether the company's business ID number was provided.
*/
tax_id_provided?: boolean;
/**
* The jurisdiction in which the `tax_id` is registered (Germany-based companies only).
*/
tax_id_registrar?: string;
/**
* Whether the company's business VAT number was provided.
*/
vat_id_provided?: boolean;
/**
* Information on the verification state of the company.
*/
verification?: Company.Verification | null;
}
interface Controller {
fees?: Controller.Fees;
/**
* `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.
*/
is_controller?: boolean;
losses?: Controller.Losses;
/**
* A value indicating responsibility for collecting requirements on this account. Only returned when the Connect application retrieving the resource controls the account.
*/
requirement_collection?: Controller.RequirementCollection;
stripe_dashboard?: Controller.StripeDashboard;
/**
* The controller type. Can be `application`, if a Connect application controls the account, or `account`, if the account controls itself.
*/
type: Controller.Type;
}
interface FutureRequirements {
/**
* 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.
*/
alternatives: Array<FutureRequirements.Alternative> | null;
/**
* 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.
*/
current_deadline: number | null;
/**
* 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.
*/
currently_due: Array<string> | null;
/**
* This is typed as an enum for consistency with `requirements.disabled_reason`.
*/
disabled_reason: FutureRequirements.DisabledReason | null;
/**
* Details about validation and verification failures for `due` requirements that must be resolved.
*/
errors: Array<FutureRequirements.Error> | null;
/**
* Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well.
*/
eventually_due: Array<string> | null;
/**
* 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`.
*/
past_due: Array<string> | null;
/**
* 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.
*/
pending_verification: Array<string> | null;
}
interface Groups {
/**
* 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.
*/
payments_pricing: string | null;
}
interface Requirements {
/**
* 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.
*/
alternatives: Array<Requirements.Alternative> | null;
/**
* 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.
*/
current_deadline: number | null;
/**
* 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 is disabled.
*/
currently_due: Array<string> | null;
/**
* If the account is disabled, this enum describes why. [Learn more about handling verification issues](https://docs.stripe.com/connect/handling-api-verification).
*/
disabled_reason: Requirements.DisabledReason | null;
/**
* Details about validation and verification failures for `due` requirements that must be resolved.
*/
errors: Array<Requirements.Error> | null;
/**
* 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.
*/
eventually_due: Array<string> | null;
/**
* Fields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the account.
*/
past_due: Array<string> | null;
/**
* 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.
*/
pending_verification: Array<string> | null;
}
interface Settings {
bacs_debit_payments?: Settings.BacsDebitPayments;
branding: Settings.Branding;
card_issuing?: Settings.CardIssuing;
card_payments: Settings.CardPayments;
dashboard: Settings.Dashboard;
invoices?: Settings.Invoices;
payments: Settings.Payments;
payouts?: Settings.Payouts;
sepa_debit_payments?: Settings.SepaDebitPayments;
treasury?: Settings.Treasury;
}
interface TosAcceptance {
/**
* The Unix timestamp marking when the account representative accepted their service agreement
*/
date?: number | null;
/**
* The IP address from which the account representative accepted their service agreement
*/
ip?: string | null;
/**
* The user's service agreement type
*/
service_agreement?: string;
/**
* The user agent of the browser from which the account representative accepted their service agreement
*/
user_agent?: string | null;
}
type Type = 'custom' | 'express' | 'none' | 'standard';
namespace BusinessProfile {
interface AnnualRevenue {
/**
* A non-negative integer representing the amount in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
*/
amount: number | null;
/**
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
*/
currency: string | null;
/**
* The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023.
*/
fiscal_year_end: string | null;
}
type MinorityOwnedBusinessDesignation = 'lgbtqi_owned_business' | 'minority_owned_business' | 'none_of_these_apply' | 'prefer_not_to_answer' | 'women_owned_business';
interface MonthlyEstimatedRevenue {
/**
* A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
*/
amount: number;
/**
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
*/
currency: string;
}
}
namespace Capabilities {
type AcssDebitPayments = 'active' | 'inactive' | 'pending';
type AffirmPayments = 'active' | 'inactive' | 'pending';
type AfterpayClearpayPayments = 'active' | 'inactive' | 'pending';
type AlmaPayments = 'active' | 'inactive' | 'pending';
type AmazonPayPayments = 'active' | 'inactive' | 'pending';
type AuBecsDebitPayments = 'active' | 'inactive' | 'pending';
type BacsDebitPayments = 'active' | 'inactive' | 'pending';
type BancontactPayments = 'active' | 'inactive' | 'pending';
type BankTransferPayments = 'active' | 'inactive' | 'pending';
type BilliePayments = 'active' | 'inactive' | 'pending';
type BlikPayments = 'active' | 'inactive' | 'pending';
type BoletoPayments = 'active' | 'inactive' | 'pending';
type CardIssuing = 'active' | 'inactive' | 'pending';
type CardPayments = 'active' | 'inactive' | 'pending';
type CartesBancairesPayments = 'active' | 'inactive' | 'pending';
type CashappPayments = 'active' | 'inactive' | 'pending';
type CryptoPayments = 'active' | 'inactive' | 'pending';
type EpsPayments = 'active' | 'inactive' | 'pending';
type FpxPayments = 'active' | 'inactive' | 'pending';
type GbBankTransferPayments = 'active' | 'inactive' | 'pending';
type GiropayPayments = 'active' | 'inactive' | 'pending';
type GrabpayPayments = 'active' | 'inactive' | 'pending';
type IdealPayments = 'active' | 'inactive' | 'pending';
type IndiaInternationalPayments = 'active' | 'inactive' | 'pending';
type JcbPayments = 'active' | 'inactive' | 'pending';
type JpBankTransferPayments = 'active' | 'inactive' | 'pending';
type KakaoPayPayments = 'active' | 'inactive' | 'pending';
type KlarnaPayments = 'active' | 'inactive' | 'pending';
type KonbiniPayments = 'active' | 'inactive' | 'pending';
type KrCardPayments = 'active' | 'inactive' | 'pending';
type LegacyPayments = 'active' | 'inactive' | 'pending';
type LinkPayments = 'active' | 'inactive' | 'pending';
type MbWayPayments = 'active' | 'inactive' | 'pending';
type MobilepayPayments = 'active' | 'inactive' | 'pending';
type MultibancoPayments = 'active' | 'inactive' | 'pending';
type MxBankTransferPayments = 'active' | 'inactive' | 'pending';
type NaverPayPayments = 'active' | 'inactive' | 'pending';
type NzBankAccountBecsDebitPayments = 'active' | 'inactive' | 'pending';
type OxxoPayments = 'active' | 'inactive' | 'pending';
type P24Payments = 'active' | 'inactive' | 'pending';
type PayByBankPayments = 'active' | 'inactive' | 'pending';
type PaycoPayments = 'active' | 'inactive' | 'pending';
type PaynowPayments = 'active' | 'inactive' | 'pending';
type PaytoPayments = 'active' | 'inactive' | 'pending';
type PixPayments = 'active' | 'inactive' | 'pending';
type PromptpayPayments = 'active' | 'inactive' | 'pending';
type RevolutPayPayments = 'active' | 'inactive' | 'pending';
type SamsungPayPayments = 'active' | 'inactive' | 'pending';
type SatispayPayments = 'active' | 'inactive' | 'pending';
type SepaBankTransferPayments = 'active' | 'inactive' | 'pending';
type SepaDebitPayments = 'active' | 'inactive' | 'pending';
type SofortPayments = 'active' | 'inactive' | 'pending';
type SwishPayments = 'active' | 'inactive' | 'pending';
type TaxReportingUs1099K = 'active' | 'inactive' | 'pending';
type TaxReportingUs1099Misc = 'active' | 'inactive' | 'pending';
type Transfers = 'active' | 'inactive' | 'pending';
type Treasury = 'active' | 'inactive' | 'pending';
type TwintPayments = 'active' | 'inactive' | 'pending';
type UpiPayments = 'active' | 'inactive' | 'pending';
type UsBankAccountAchPayments = 'active' | 'inactive' | 'pending';
type UsBankTransferPayments = 'active' | 'inactive' | 'pending';
type ZipPayments = 'active' | 'inactive' | 'pending';
}
namespace Company {
interface AddressKana {
/**
* City/Ward.
*/
city: string | null;
/**
* Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
*/
country: string | null;
/**
* Block/Building number.
*/
line1: string | null;
/**
* Building details.
*/
line2: string | null;
/**
* ZIP or postal code.
*/
postal_code: string | null;
/**
* Prefecture.
*/
state: string | null;
/**
* Town/cho-me.
*/
town: string | null;
}
interface AddressKanji {
/**
* City/Ward.
*/
city: string | null;
/**
* Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
*/
country: string | null;
/**
* Block/Building number.
*/
line1: string | null;
/**
* Building details.
*/
line2: string | null;
/**
* ZIP or postal code.
*/
postal_code: string | null;
/**
* Prefecture.
*/
state: string | null;
/**
* Town/cho-me.
*/
town: string | null;
}
interface DirectorshipDeclaration {
/**
* The Unix timestamp marking when the directorship declaration attestation was made.
*/
date: number | null;
/**
* The IP address from which the directorship declaration attestation was made.
*/
ip: string | null;
/**
* The user-agent string from the browser where the directorship declaration attestation was made.
*/
user_agent: string | null;
}
interface OwnershipDeclaration {
/**
* The Unix timestamp marking when the beneficial owner attestation was made.
*/
date: number | null;
/**
* The IP address from which the beneficial owner attestation was made.
*/
ip: string | null;
/**
* The user-agent string from the browser where the beneficial owner attestation was made.
*/
user_agent: string | null;
}
type OwnershipExemptionReason = 'qualified_entity_exceeds_ownership_threshold' | 'qualifies_as_financial_institution';
interface RegistrationDate {
/**
* The day of registration, between 1 and 31.
*/
day: number | null;
/**
* The month of registration, between 1 and 12.
*/
month: number | null;
/**
* The four-digit year of registration.
*/
year: number | null;
}
interface RepresentativeDeclaration {
/**
* The Unix time