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

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

Overview

An Account v2 object represents a company, individual, or other entity that interacts with a platform on Stripe. It contains both identifying information and properties that control its behavior and functionality. An Account can have one or more configurations that enable sets of related features, such as allowing it to act as a merchant or customer. The Accounts v2 API supports both the Global Payouts preview feature and the Connect-Billing integration preview feature. However, a particular Account can only access one of them. The Connect-Billing integration preview feature allows an Account v2 to pay subscription fees to a platform. An Account v1 required a separate Customer object to pay subscription fees.

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)

The configurations that have been applied to this account.



5245
5246
5247
 
# File 'lib/stripe/resources/v2/core/account.rb', line 5245

def applied_configurations
  @applied_configurations
end

#closed ⇒ Object (readonly)

Indicates whether the account has been closed.



5247
5248
5249
 
# File 'lib/stripe/resources/v2/core/account.rb', line 5247

def closed
  @closed
end

#configuration ⇒ Object (readonly)

An Account represents a company, individual, or other entity that a user interacts with. Accounts store identity information and one or more configurations that enable product-specific capabilities. You can assign configurations at creation or add them later.



5249
5250
5251
 
# File 'lib/stripe/resources/v2/core/account.rb', line 5249

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.



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

def contact_email
  @contact_email
end

#contact_phone ⇒ Object (readonly)

The default contact phone for the Account.



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

def contact_phone
  @contact_phone
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.



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

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.



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

def dashboard
  @dashboard
end

#defaults ⇒ Object (readonly)

Default values for settings shared across Account configurations.



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

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.



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

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.



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

def future_requirements
  @future_requirements
end

#id ⇒ Object (readonly)

Unique identifier for the Account.



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

def id
  @id
end

#identity ⇒ Object (readonly)

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



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

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.



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

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.



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

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.



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

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.



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

def requirements
  @requirements
end

Class Method Details

.field_remappings ⇒ Object 



5287
5288
5289
 
# File 'lib/stripe/resources/v2/core/account.rb', line 5287

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



5277
5278
5279
5280
5281
5282
5283
5284
5285
 
# File 'lib/stripe/resources/v2/core/account.rb', line 5277

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

.object_name ⇒ Object 



12
13
14
 
# File 'lib/stripe/resources/v2/core/account.rb', line 12

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