Search documentation of tiger_stripe

# Stripe.Params.AccountUpdateParams (tiger_stripe v0.1.1)

Copy Markdown View Source

Parameters for account update.

## Summary

### Types

t()

## Types

# t()

    @type t() :: %Stripe.Params.AccountUpdateParams{
      account_token: String.t() | nil,
      business_profile: map() | nil,
      business_type: String.t() | nil,
      capabilities: map() | nil,
      company: map() | nil,
      default_currency: String.t() | nil,
      documents: map() | nil,
      email: String.t() | nil,
      expand: [String.t()] | nil,
      external_account: String.t() | nil,
      groups: map() | nil,
      individual: map() | nil,
      metadata: map() | nil,
      settings: map() | nil,
      tos_acceptance: map() | nil
    }

- `account_token` - An account token, used to securely provide details to the account. Max length: 5000.
- `business_profile` - Business information about the account.
- `business_type` - The business type. Once you create an Account Link or Account Session, this property can only be updated for accounts where controller.requirement_collection is `application`, which includes Custom accounts. Possible values: `company`, `government_entity`, `individual`, `non_profit`.
- `capabilities` - Each key of the dictionary represents a capability, and each capability maps to its settings (for example, whether it has been requested or not). Each capability is inactive until you have provided its specific requirements and Stripe has verified them. An account might have some of its requested capabilities be active and some be inactive.

Required when account.controller.stripe_dashboard.type is `none`, which includes Custom accounts.

- `company` - Information about the company or business. This field is available for any `business_type`. Once you create an Account Link or Account Session, this property can only be updated for accounts where controller.requirement_collection is `application`, which includes Custom accounts.
- `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. Format: ISO 4217 currency code.
- `documents` - Documents that may be submitted to satisfy various informational requests.
- `email` - The email address of the account holder. This is only to make the account easier to identify to you. If controller.requirement_collection is `application`, which includes Custom accounts, Stripe doesn't email the account without your consent.
- `expand` - Specifies which fields in the response should be expanded.
- `external_account` - A card or bank account to attach to the account for receiving payouts (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by Stripe.js, or a dictionary, as documented in the `external_account` parameter for bank account creation.

By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the bank account or card creation APIs. After you create an Account Link or Account Session, this property can only be updated for accounts where controller.requirement_collection is `application`, which includes Custom accounts. Max length: 5000.

- `groups` - A hash of account group type to tokens. These are account groups this account should be added to.
- `individual` - Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. Once you create an Account Link or Account Session, this property can only be updated for accounts where controller.requirement_collection is `application`, which includes Custom accounts.
- `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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
- `settings` - Options for customizing how the account functions within Stripe.
- `tos_acceptance` - Details on the account's acceptance of the Stripe Services Agreement. This property can only be updated for accounts where controller.requirement_collection is `application`, which includes Custom accounts. This property defaults to a `full` service agreement when empty.