Struct stripe::Account

pub struct Account {

    pub id: AccountId,
    pub business_profile: Option<BusinessProfile>,
    pub business_type: Option<AccountBusinessType>,
    pub capabilities: Option<AccountCapabilities>,
    pub charges_enabled: Option<bool>,
    pub company: Option<Company>,
    pub controller: Option<AccountUnificationAccountController>,
    pub country: Option<String>,
    pub created: Option<Timestamp>,
    pub default_currency: Option<Currency>,
    pub deleted: bool,
    pub details_submitted: Option<bool>,
    pub email: Option<String>,
    pub external_accounts: Option<List<ExternalAccount>>,
    pub future_requirements: Option<AccountFutureRequirements>,
    pub individual: Option<Person>,
    pub metadata: Option<Metadata>,
    pub payouts_enabled: Option<bool>,
    pub requirements: Option<AccountRequirements>,
    pub settings: Option<AccountSettings>,
    pub tos_acceptance: Option<TosAcceptance>,
    pub type_: Option<AccountType>,
}

The resource representing a Stripe “Account”.

For more details see https://stripe.com/docs/api/accounts/object

Fields

id: AccountId

Unique identifier for the object.

business_profile: Option<BusinessProfile>

Business information about the account.

business_type: Option<AccountBusinessType>

The business type.

Once you create an Account Link or Account Session, this property is only returned for Custom accounts.

capabilities: Option<AccountCapabilities>

charges_enabled: Option<bool>

Whether the account can create live charges.

company: Option<Company>

controller: Option<AccountUnificationAccountController>

country: Option<String>

The account’s country.

created: Option<Timestamp>

Time at which the account was connected.

Measured in seconds since the Unix epoch.

default_currency: Option<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.

deleted: bool

details_submitted: Option<bool>

Whether account details have been submitted.

Standard accounts cannot receive payouts before this is true.

email: Option<String>

An email address associated with the account.

It’s not used for authentication and Stripe doesn’t market to this field without explicit approval from the platform.

external_accounts: Option<List<ExternalAccount>>

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.

future_requirements: Option<AccountFutureRequirements>

individual: Option<Person>

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

payouts_enabled: Option<bool>

Whether Stripe can send payouts to this account.

requirements: Option<AccountRequirements>

settings: Option<AccountSettings>

Options for customizing how the account functions within Stripe.

tos_acceptance: Option<TosAcceptance>

type_: Option<AccountType>

The Stripe account type.

Can be standard, express, or custom.

Implementations

impl Account

pub fn list( client: &Client, params: &ListAccounts<'_> ) -> Response<List<Account>>

Returns a list of accounts connected to your platform via Connect.

If you’re not a platform, the list is empty.

pub fn create(client: &Client, params: CreateAccount<'_>) -> Response<Account>

With Connect, you can create Stripe accounts for your users. To do this, you’ll first need to register your platform.

If you’ve already collected information for your connected accounts, you can prefill that information when creating the account.

Connect Onboarding won’t ask for the prefilled information during account onboarding. You can prefill any information on the account.

pub fn retrieve( client: &Client, id: &AccountId, expand: &[&str] ) -> Response<Account>

Retrieves the details of an account.

pub fn update( client: &Client, id: &AccountId, params: UpdateAccount<'_> ) -> Response<Account>

Updates a connected account by setting the values of the parameters passed.

Any parameters not provided are left unchanged. For Custom accounts, you can update any information on the account. For other accounts, you can update all information until that account has started to go through Connect Onboarding. Once you create an Account Link or Account Session, some properties can only be changed or updated for Custom accounts. To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.

pub fn delete(client: &Client, id: &AccountId) -> Response<Deleted<AccountId>>

With Connect, you can delete accounts you manage.

Accounts created using test-mode keys can be deleted at any time.

Standard accounts created using live-mode keys cannot be deleted. Custom or Express accounts created using live-mode keys can only be deleted once all balances are zero. If you want to delete your own account, use the account information tab in your account settings instead.

Trait Implementations

impl Clone for Account

fn clone(&self) -> Account

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Account

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Account

fn default() -> Account

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Account

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Object for Account

type Id = AccountId

The canonical id type for this object.

fn id(&self) -> Self::Id

The id of the object.

fn object(&self) -> &'static str

The object’s type, typically represented in wire format as the object property.

impl Serialize for Account

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.