Class: Stripe::V2::Core::Account

Inherits:
APIResource show all
Defined in:
lib/stripe/resources/v2/core/account.rb

Overview

A V2 Account is a representation of a company or individual that a Stripe user does business with. Accounts contain the contact details, Legal Entity information, and configuration required to enable the Account for use across Stripe products.

Defined Under Namespace

Classes: Configuration, Defaults, FutureRequirements, Identity, Requirements

Constant Summary collapse

OBJECT_NAME = 
"v2.core.account"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, #_get_inner_class_type, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Instance Attribute Details

#applied_configurations ⇒ Object (readonly)

Filter only accounts that have all of the configurations specified. If omitted, returns all accounts regardless of which configurations they have.



5252
5253
5254
 
# File 'lib/stripe/resources/v2/core/account.rb', line 5252

def applied_configurations
  @applied_configurations
end

#closed ⇒ Object (readonly)

A value indicating if the Account has been closed.



5254
5255
5256
 
# File 'lib/stripe/resources/v2/core/account.rb', line 5254

def closed
  @closed
end

#configuration ⇒ Object (readonly)

An Account Configuration which allows the Account to take on a key persona across Stripe products.



5256
5257
5258
 
# File 'lib/stripe/resources/v2/core/account.rb', line 5256

def configuration
  @configuration
end

#contact_email ⇒ Object (readonly)

The default contact email address for the Account. Required when configuring the account as a merchant or recipient.



5258
5259
5260
 
# File 'lib/stripe/resources/v2/core/account.rb', line 5258

def contact_email
  @contact_email
end

#created ⇒ Object (readonly)

Time at which the object was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.



5260
5261
5262
 
# File 'lib/stripe/resources/v2/core/account.rb', line 5260

def created
  @created
end

#dashboard ⇒ Object (readonly)

A value indicating the Stripe dashboard this Account has access to. This will depend on which configurations are enabled for this account.



5262
5263
5264
 
# File 'lib/stripe/resources/v2/core/account.rb', line 5262

def dashboard
  @dashboard
end

#defaults ⇒ Object (readonly)

Default values to be used on Account Configurations.



5264
5265
5266
 
# File 'lib/stripe/resources/v2/core/account.rb', line 5264

def defaults
  @defaults
end

#display_name ⇒ Object (readonly)

A descriptive name for the Account. This name will be surfaced in the Stripe Dashboard and on any invoices sent to the Account.



5266
5267
5268
 
# File 'lib/stripe/resources/v2/core/account.rb', line 5266

def display_name
  @display_name
end

#future_requirements ⇒ Object (readonly)

Information about the future requirements for the Account that will eventually come into effect, including what information needs to be collected, and by when.



5268
5269
5270
 
# File 'lib/stripe/resources/v2/core/account.rb', line 5268

def future_requirements
  @future_requirements
end

#id ⇒ Object (readonly)

Unique identifier for the Account.



5270
5271
5272
 
# File 'lib/stripe/resources/v2/core/account.rb', line 5270

def id
  @id
end

#identity ⇒ Object (readonly)

Information about the company, individual, and business represented by the Account.



5272
5273
5274
 
# File 'lib/stripe/resources/v2/core/account.rb', line 5272

def identity
  @identity
end

#livemode ⇒ Object (readonly)

Has the value ‘true` if the object exists in live mode or the value `false` if the object exists in test mode.



5280
5281
5282
 
# File 'lib/stripe/resources/v2/core/account.rb', line 5280

def livemode
  @livemode
end

#metadata ⇒ Object (readonly)

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.



5274
5275
5276
 
# File 'lib/stripe/resources/v2/core/account.rb', line 5274

def metadata
  @metadata
end

#object ⇒ Object (readonly)

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



5276
5277
5278
 
# File 'lib/stripe/resources/v2/core/account.rb', line 5276

def object
  @object
end

#requirements ⇒ Object (readonly)

Information about the active requirements for the Account, including what information needs to be collected, and by when.



5278
5279
5280
 
# File 'lib/stripe/resources/v2/core/account.rb', line 5278

def requirements
  @requirements
end

Class Method Details

.field_remappings ⇒ Object 



5292
5293
5294
 
# File 'lib/stripe/resources/v2/core/account.rb', line 5292

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



5282
5283
5284
5285
5286
5287
5288
5289
5290
 
# File 'lib/stripe/resources/v2/core/account.rb', line 5282

def self.inner_class_types
  @inner_class_types = {
    configuration: Configuration,
    defaults: Defaults,
    future_requirements: FutureRequirements,
    identity: Identity,
    requirements: Requirements,
  }
end

.object_name ⇒ Object 



10
11
12
 
# File 'lib/stripe/resources/v2/core/account.rb', line 10

def self.object_name
  "v2.core.account"
end