class

Stripe::Account

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

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.

Constants

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)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
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

Source

Instance methods

==(other : self)

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

_type

The Stripe account type. Can be standard, express, custom, or none.

Source
_type=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] _type Object to be assigned

Source
business_profile
Source
business_profile=(new_value : Stripe::AccountBusinessProfile1 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] business_profile Object to be assigned

Source
business_profile_present=(business_profile_present : Bool)
Source
business_profile_present?
Source
business_type

The business type. After you create an Account Link or Account Session, this property is only returned for accounts where controller.requirement_collection is application, which includes Custom accounts.

Source
business_type=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] business_type Object to be assigned

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

Custom attribute writer method checking allowed values (enum). @param [Object] capabilities Object to be assigned

Source
charges_enabled

Whether the account can create live charges.

Source
charges_enabled=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] charges_enabled Object to be assigned

Source
company
Source
company=(new_value : Stripe::LegalEntityCompany | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] company Object to be assigned

Source
controller
Source
controller=(new_value : Stripe::AccountUnificationAccountController | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] controller Object to be assigned

Source
country

The account's country.

Source
country=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] country Object to be assigned

Source
created

Time at which the account was connected. Measured in seconds since the Unix epoch.

Source
created=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] created Object to be assigned

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

Source
default_currency=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] default_currency Object to be assigned

Source
details_submitted

Whether account details have been submitted. Accounts with Stripe Dashboard access, which includes Standard accounts, cannot receive payouts before this is true. Accounts where this is false should be directed to an onboarding flow to finish submitting account details.

Source
details_submitted=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] details_submitted Object to be assigned

Source
email

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.

Source
email=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] email Object to be assigned

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

Custom attribute writer method checking allowed values (enum). @param [Object] external_accounts Object to be assigned

Source
future_requirements
Source
future_requirements=(new_value : Stripe::AccountFutureRequirements | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] future_requirements Object to be assigned

Source
hash(hasher)

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

id

Unique identifier for the object.

Source
id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] id Object to be assigned

Source
individual
Source
individual=(new_value : Stripe::Person | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] individual Object to be assigned

Source
list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

Source
metadata
Source
metadata=(new_value : Hash(String, String) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] metadata Object to be assigned

Source
object

String representing the object's type. Objects of the same type share the same value.

Source
object=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] object Object to be assigned

Source
payouts_enabled

Whether Stripe can send payouts to this account.

Source
payouts_enabled=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] payouts_enabled Object to be assigned

Source
requirements
Source
requirements=(new_value : Stripe::AccountRequirements | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] requirements Object to be assigned

Source
settings
Source
settings=(new_value : Stripe::AccountSettings1 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] settings Object to be assigned

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

Custom attribute writer method checking allowed values (enum). @param [Object] tos_acceptance Object to be assigned

Source
valid?

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

Source