class Stripe::Account

• Stripe::Account
• Reference
• Object

Overview

This is an object representing a Stripe account. You can retrieve it to see properties on the account like its current requirements or if the account is enabled to make live charges or receive payouts. For accounts where controller.requirement_collection is application, which includes Custom accounts, the properties below are always returned. For accounts where controller.requirement_collection is stripe, which includes Standard and Express accounts, some properties are only returned until you create an Account Link or Account Session to start Connect Onboarding. Learn about the differences between accounts.

Included Modules

• JSON::Serializable
• JSON::Serializable::Unmapped
• OpenApi::Json
• OpenApi::Validatable

Defined in:

Constant Summary

ERROR_MESSAGE_FOR__TYPE = "invalid value for \"_type\", must be one of [custom, express, none, standard]."

ERROR_MESSAGE_FOR_BUSINESS_TYPE = "invalid value for \"business_type\", must be one of [company, government_entity, individual, non_profit]."

ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [account]."

MAX_LENGTH_FOR_COUNTRY = 5000

MAX_LENGTH_FOR_DEFAULT_CURRENCY = 5000

MAX_LENGTH_FOR_EMAIL = 5000

MAX_LENGTH_FOR_ID = 5000

VALID_VALUES_FOR__TYPE = String.static_array("custom", "express", "none", "standard")

VALID_VALUES_FOR_BUSINESS_TYPE = String.static_array("company", "government_entity", "individual", "non_profit")

VALID_VALUES_FOR_OBJECT = String.static_array("account")

Constructors

• .new(pull : JSON::PullParser)
• .new(*, id : String | Nil = nil, object : String | Nil = nil, business_profile : Stripe::AccountBusinessProfile1 | Nil = nil, business_type : String | Nil = nil, capabilities : Stripe::AccountCapabilities | Nil = nil, charges_enabled : Bool | Nil = nil, company : Stripe::LegalEntityCompany | Nil = nil, controller : Stripe::AccountUnificationAccountController | Nil = nil, country : String | Nil = nil, created : Int64 | Nil = nil, default_currency : String | Nil = nil, details_submitted : Bool | Nil = nil, email : String | Nil = nil, external_accounts : Stripe::ExternalAccountList | Nil = nil, future_requirements : Stripe::AccountFutureRequirements | Nil = nil, individual : Stripe::Person | Nil = nil, metadata : Hash(String, String) | Nil = nil, payouts_enabled : Bool | Nil = nil, requirements : Stripe::AccountRequirements | Nil = nil, settings : Stripe::AccountSettings1 | Nil = nil, tos_acceptance : Stripe::AccountTosAcceptance | Nil = nil, _type : String | Nil = nil)

  Initializes the object @param [Hash] attributes Model attributes in the form of hash

Instance Method Summary

• #==(other : self)

  Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes.

• #_type : String | Nil
• #_type=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #business_profile : Stripe::AccountBusinessProfile1 | Nil
• #business_profile=(new_value : Stripe::AccountBusinessProfile1 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #business_profile_present=(business_profile_present : Bool)
• #business_profile_present? : Bool
• #business_type : String | Nil
• #business_type=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #business_type_present=(business_type_present : Bool)
• #business_type_present? : Bool
• #capabilities : Stripe::AccountCapabilities | Nil
• #capabilities=(new_value : Stripe::AccountCapabilities | Nil)

  Custom attribute writer method checking allowed values (enum).

• #charges_enabled : Bool | Nil
• #charges_enabled=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #company : Stripe::LegalEntityCompany | Nil
• #company=(new_value : Stripe::LegalEntityCompany | Nil)

  Custom attribute writer method checking allowed values (enum).

• #controller : Stripe::AccountUnificationAccountController | Nil
• #controller=(new_value : Stripe::AccountUnificationAccountController | Nil)

  Custom attribute writer method checking allowed values (enum).

• #country : String | Nil
• #country=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #created : Int64 | Nil
• #created=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #default_currency : String | Nil
• #default_currency=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #details_submitted : Bool | Nil
• #details_submitted=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #email : String | Nil
• #email=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #email_present=(email_present : Bool)
• #email_present? : Bool
• #external_accounts : Stripe::ExternalAccountList | Nil
• #external_accounts=(new_value : Stripe::ExternalAccountList | Nil)

  Custom attribute writer method checking allowed values (enum).

• #future_requirements : Stripe::AccountFutureRequirements | Nil
• #future_requirements=(new_value : Stripe::AccountFutureRequirements | Nil)

  Custom attribute writer method checking allowed values (enum).

• #hash(hasher)

  Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes.

• #id : String | Nil
• #id=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #individual : Stripe::Person | Nil
• #individual=(new_value : Stripe::Person | Nil)

  Custom attribute writer method checking allowed values (enum).

• #list_invalid_properties : Array(String)

  Show invalid properties with the reasons.

• #metadata : Hash(String, String) | Nil
• #metadata=(new_value : Hash(String, String) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #object : String | Nil
• #object=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #payouts_enabled : Bool | Nil
• #payouts_enabled=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #requirements : Stripe::AccountRequirements | Nil
• #requirements=(new_value : Stripe::AccountRequirements | Nil)

  Custom attribute writer method checking allowed values (enum).

• #settings : Stripe::AccountSettings1 | Nil
• #settings=(new_value : Stripe::AccountSettings1 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #settings_present=(settings_present : Bool)
• #settings_present? : Bool
• #tos_acceptance : Stripe::AccountTosAcceptance | Nil
• #tos_acceptance=(new_value : Stripe::AccountTosAcceptance | Nil)

  Custom attribute writer method checking allowed values (enum).

• #valid? : Bool

  Check to see if the all the properties in the model are valid @return true if the model is valid

Constructor Detail

Instance Method Detail