Struct stripe::Account

pub struct Account {
    pub id: AccountId,
    pub business_profile: Option<BusinessProfile>,
    pub business_type: Option<BusinessType>,
    pub capabilities: Option<AccountCapabilities>,
    pub charges_enabled: bool,
    pub company: Option<Company>,
    pub country: Option<String>,
    pub created: Option<Timestamp>,
    pub default_currency: Option<Currency>,
    pub deleted: bool,
    pub details_submitted: bool,
    pub email: Option<String>,
    pub external_accounts: List<ExternalAccount>,
    pub individual: Option<Person>,
    pub metadata: Metadata,
    pub payouts_enabled: 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>

Optional information related to the business.

business_type: Option<BusinessType>

The business type.

Can be individual or company.

capabilities: Option<AccountCapabilities>

charges_enabled: bool

Whether the account can create live charges.

company: Option<Company>

country: Option<String>

The account's country.

created: Option<Timestamp>

Time at which the object was created.

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: bool

Whether account details have been submitted.

Standard accounts cannot receive payouts before this is true.

email: Option<String>

The primary user's email address.

external_accounts: List<ExternalAccount>

External accounts (bank accounts and debit cards) currently attached to this account.

individual: Option<Person>

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

Whether Stripe can send payouts to this account.

requirements: Option<AccountRequirements>

settings: Option<AccountSettings>

Account 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.

Methods

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.

For Standard accounts, parameters other than country, email, and type are used to prefill the account application that we ask the account holder to complete.

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 Express or Custom account by setting the values of the parameters passed.

Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are supported by both account types. 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 may delete Custom accounts you manage.

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

Custom accounts created using live-mode keys may only be deleted once all balances are zero. If you are looking to close your own account, use the data tab in your account settings instead.

Trait Implementations

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

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.