Struct UpdateAccount 

pub struct UpdateAccount { /* private fields */ }

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are. left unchanged.

For accounts where controller.requirement_collection. is application, which includes Custom accounts, you can update any information on the account.

For accounts where controller.requirement_collection. is stripe, which includes Standard and Express accounts, you can update all information until you create. an Account Link or Account Session to start Connect onboarding,. after which some properties can no longer be updated.

To update your own account, use the Dashboard. Refer to our. Connect documentation to learn more about updating accounts.

Implementations

impl UpdateAccount

pub fn new(account: impl Into<AccountId>) -> Self

Construct a new UpdateAccount.

pub fn account_token(self, account_token: impl Into<String>) -> Self

An account token, used to securely provide details to the account.

pub fn business_profile( self, business_profile: impl Into<UpdateAccountBusinessProfile>, ) -> Self

Business information about the account.

pub fn business_type( self, business_type: impl Into<AccountBusinessType>, ) -> Self

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.

pub fn capabilities(self, capabilities: impl Into<CapabilitiesParam>) -> Self

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.

pub fn company(self, company: impl Into<UpdateAccountCompany>) -> Self

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.

pub fn default_currency(self, default_currency: impl Into<Currency>) -> Self

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.

pub fn documents(self, documents: impl Into<UpdateAccountDocuments>) -> Self

Documents that may be submitted to satisfy various informational requests.

pub fn email(self, email: impl Into<String>) -> Self

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.

pub fn expand(self, expand: impl Into<Vec<String>>) -> Self

Specifies which fields in the response should be expanded.

pub fn external_account(self, external_account: impl Into<String>) -> Self

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.

pub fn groups(self, groups: impl Into<AccountGroupsSpecs>) -> Self

A hash of account group type to tokens. These are account groups this account should be added to.

pub fn individual(self, individual: impl Into<UpdateAccountIndividual>) -> Self

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.

pub fn metadata(self, metadata: impl Into<HashMap<String, String>>) -> Self

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.

pub fn settings(self, settings: impl Into<UpdateAccountSettings>) -> Self

Options for customizing how the account functions within Stripe.

pub fn tos_acceptance( self, tos_acceptance: impl Into<TosAcceptanceSpecs>, ) -> Self

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.

impl UpdateAccount

pub async fn send<C: StripeClient>( &self, client: &C, ) -> Result<<Self as StripeRequest>::Output, C::Err>

Send the request and return the deserialized response.

pub fn send_blocking<C: StripeBlockingClient>( &self, client: &C, ) -> Result<<Self as StripeRequest>::Output, C::Err>

Send the request and return the deserialized response, blocking until completion.

Trait Implementations

impl Clone for UpdateAccount

fn clone(&self) -> UpdateAccount

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateAccount

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

Formats the value using the given formatter.

impl Serialize for UpdateAccount

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StripeRequest for UpdateAccount

type Output = Account

The data returned from the eventual API call.

fn build(&self) -> RequestBuilder

Convert the struct into library-agnostic data that can be used by compatible clients to make API calls.

fn customize(&self) -> CustomizableStripeRequest<Self::Output>

Convert to a builder allowing per-request customization.