Class: Stripe::Account

Inherits:
APIResource show all
Extended by:
Stripe::APIOperations::Create, Stripe::APIOperations::List, Stripe::APIOperations::NestedResource
Includes:
Stripe::APIOperations::Delete, Stripe::APIOperations::Save
Defined in:
lib/stripe/resources/account.rb

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](docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is ‘application`, which includes Custom accounts, the properties below are always returned.

For accounts where [controller.requirement_collection](docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is ‘stripe`, which includes Standard and Express accounts, some properties are only returned until you create an [Account Link](docs.stripe.com/api/account_links) or [Account Session](docs.stripe.com/api/account_sessions) to start Connect Onboarding. Learn about the [differences between accounts](docs.stripe.com/connect/accounts).

Defined Under Namespace

Classes: BusinessProfile, Capabilities, Company, Controller, CreateParams, DeleteParams, FutureRequirements, Groups, ListParams, PersonsParams, RejectParams, Requirements, RiskControls, Settings, TosAcceptance, UpdateParams

Constant Summary collapse

OBJECT_NAME = 
"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

Instance Method Summary collapse

Methods included from Stripe::APIOperations::Create

create

Methods included from Stripe::APIOperations::List

list

Methods included from Stripe::APIOperations::NestedResource

nested_resource_class_methods

Methods included from Stripe::APIOperations::Save

included, #save

Methods included from Stripe::APIOperations::Delete

included

Methods inherited from APIResource

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

Methods included from Stripe::APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, #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

#business_profile ⇒ Object (readonly)

Business information about the account.



5439
5440
5441
 
# File 'lib/stripe/resources/account.rb', line 5439

def business_profile
  @business_profile
end

#business_type ⇒ Object (readonly)

The business type.



5441
5442
5443
 
# File 'lib/stripe/resources/account.rb', line 5441

def business_type
  @business_type
end

#capabilities ⇒ Object (readonly)

Attribute for field capabilities



5443
5444
5445
 
# File 'lib/stripe/resources/account.rb', line 5443

def capabilities
  @capabilities
end

#charges_enabled ⇒ Object (readonly)

Whether the account can process charges.



5445
5446
5447
 
# File 'lib/stripe/resources/account.rb', line 5445

def charges_enabled
  @charges_enabled
end

#company ⇒ Object (readonly)

Attribute for field company



5447
5448
5449
 
# File 'lib/stripe/resources/account.rb', line 5447

def company
  @company
end

#controller ⇒ Object (readonly)

Attribute for field controller



5449
5450
5451
 
# File 'lib/stripe/resources/account.rb', line 5449

def controller
  @controller
end

#country ⇒ Object (readonly)

The account’s country.



5451
5452
5453
 
# File 'lib/stripe/resources/account.rb', line 5451

def country
  @country
end

#created ⇒ Object (readonly)

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



5453
5454
5455
 
# File 'lib/stripe/resources/account.rb', line 5453

def created
  @created
end

#default_currency ⇒ Object (readonly)

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](stripe.com/docs/payouts).



5455
5456
5457
 
# File 'lib/stripe/resources/account.rb', line 5455

def default_currency
  @default_currency
end

#deleted ⇒ Object (readonly)

Always true for a deleted object



5491
5492
5493
 
# File 'lib/stripe/resources/account.rb', line 5491

def deleted
  @deleted
end

#details_submitted ⇒ Object (readonly)

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](/connect/onboarding) to finish submitting account details.



5457
5458
5459
 
# File 'lib/stripe/resources/account.rb', line 5457

def details_submitted
  @details_submitted
end

#email ⇒ Object (readonly)

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.



5459
5460
5461
 
# File 'lib/stripe/resources/account.rb', line 5459

def email
  @email
end

#external_accounts ⇒ Object (readonly)

External accounts (bank accounts and debit cards) currently attached to this account. External accounts are only returned for requests where ‘controller` is true.



5461
5462
5463
 
# File 'lib/stripe/resources/account.rb', line 5461

def external_accounts
  @external_accounts
end

#future_requirements ⇒ Object (readonly)

Attribute for field future_requirements



5463
5464
5465
 
# File 'lib/stripe/resources/account.rb', line 5463

def future_requirements
  @future_requirements
end

#groups ⇒ Object (readonly)

The groups associated with the account.



5465
5466
5467
 
# File 'lib/stripe/resources/account.rb', line 5465

def groups
  @groups
end

#id ⇒ Object (readonly)

Unique identifier for the object.



5467
5468
5469
 
# File 'lib/stripe/resources/account.rb', line 5467

def id
  @id
end

#individual ⇒ Object (readonly)

This is an object representing a person associated with a Stripe account.

A platform can only access a subset of data in a person for an account where [account.controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is ‘stripe`, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding.

See the [Standard onboarding](/connect/standard-accounts) or [Express onboarding](/connect/express-accounts) documentation for information about prefilling information and account onboarding steps. Learn more about [handling identity verification with the API](/connect/handling-api-verification#person-information).



5473
5474
5475
 
# File 'lib/stripe/resources/account.rb', line 5473

def individual
  @individual
end

#metadata ⇒ Object (readonly)

Set of [key-value pairs](stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.



5475
5476
5477
 
# File 'lib/stripe/resources/account.rb', line 5475

def metadata
  @metadata
end

#object ⇒ Object (readonly)

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



5477
5478
5479
 
# File 'lib/stripe/resources/account.rb', line 5477

def object
  @object
end

#payouts_enabled ⇒ Object (readonly)

Whether the funds in this account can be paid out.



5479
5480
5481
 
# File 'lib/stripe/resources/account.rb', line 5479

def payouts_enabled
  @payouts_enabled
end

#requirements ⇒ Object (readonly)

Attribute for field requirements



5481
5482
5483
 
# File 'lib/stripe/resources/account.rb', line 5481

def requirements
  @requirements
end

#risk_controls ⇒ Object (readonly)

Attribute for field risk_controls



5483
5484
5485
 
# File 'lib/stripe/resources/account.rb', line 5483

def risk_controls
  @risk_controls
end

#settings ⇒ Object (readonly)

Options for customizing how the account functions within Stripe.



5485
5486
5487
 
# File 'lib/stripe/resources/account.rb', line 5485

def settings
  @settings
end

#tos_acceptance ⇒ Object (readonly)

Attribute for field tos_acceptance



5487
5488
5489
 
# File 'lib/stripe/resources/account.rb', line 5487

def tos_acceptance
  @tos_acceptance
end

#type ⇒ Object (readonly)

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



5489
5490
5491
 
# File 'lib/stripe/resources/account.rb', line 5489

def type
  @type
end

Class Method Details

.create(params = {}, opts = {}) ⇒ Object

With [Connect](docs.stripe.com/docs/connect), you can create Stripe accounts for your users. To do this, you’ll first need to [register your platform](dashboard.stripe.com/account/applications/settings).

If you’ve already collected information for your connected accounts, you [can prefill that information](docs.stripe.com/docs/connect/best-practices#onboarding) when creating the account. Connect Onboarding won’t ask for the prefilled information during account onboarding. You can prefill any information on the account.



5499
5500
5501
 
# File 'lib/stripe/resources/account.rb', line 5499

def self.create(params = {}, opts = {})
  request_stripe_object(method: :post, path: "/v1/accounts", params: params, opts: opts)
end

.delete(account, params = {}, opts = {}) ⇒ Object

With [Connect](docs.stripe.com/connect), you can delete accounts you manage.

Test-mode accounts can be deleted at any time.

Live-mode accounts where Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. Live-mode accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be deleted when all [balances](docs.stripe.com/api/balance/balance_object) are zero.

If you want to delete your own account, use the [account information tab in your account settings](dashboard.stripe.com/settings/account) instead.



5510
5511
5512
5513
5514
5515
5516
5517
 
# File 'lib/stripe/resources/account.rb', line 5510

def self.delete(, params = {}, opts = {})
  request_stripe_object(
    method: :delete,
    path: format("/v1/accounts/%<account>s", { account: CGI.escape() }),
    params: params,
    opts: opts
  )
end

.list(params = {}, opts = {}) ⇒ Object

Returns a list of accounts connected to your platform via [Connect](docs.stripe.com/docs/connect). If you’re not a platform, the list is empty.



5536
5537
5538
 
# File 'lib/stripe/resources/account.rb', line 5536

def self.list(params = {}, opts = {})
  request_stripe_object(method: :get, path: "/v1/accounts", params: params, opts: opts)
end

.object_name ⇒ Object 



25
26
27
 
# File 'lib/stripe/resources/account.rb', line 25

def self.object_name
  "account"
end

.persons(account, params = {}, opts = {}) ⇒ Object

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.



5551
5552
5553
5554
5555
5556
5557
5558
 
# File 'lib/stripe/resources/account.rb', line 5551

def self.persons(, params = {}, opts = {})
  request_stripe_object(
    method: :get,
    path: format("/v1/accounts/%<account>s/persons", { account: CGI.escape() }),
    params: params,
    opts: opts
  )
end

.protected_fields ⇒ Object 



5675
5676
5677
 
# File 'lib/stripe/resources/account.rb', line 5675

def self.protected_fields
  [:legal_entity]
end

.reject(account, params = {}, opts = {}) ⇒ Object

With [Connect](docs.stripe.com/connect), you can reject accounts that you have flagged as suspicious.

Only accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be rejected. Test-mode accounts can be rejected at any time. Live-mode accounts can only be rejected after all balances are zero.



5575
5576
5577
5578
5579
5580
5581
5582
 
# File 'lib/stripe/resources/account.rb', line 5575

def self.reject(, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/accounts/%<account>s/reject", { account: CGI.escape() }),
    params: params,
    opts: opts
  )
end

.retrieve(id = nil, opts = {}) ⇒ Object 



5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
 
# File 'lib/stripe/resources/account.rb', line 5617

def self.retrieve(id = nil, opts = {})
  Util.check_string_argument!(id) if id

  # Account used to be a singleton, where this method's signature was
  # `(opts={})`. For the sake of not breaking folks who pass in an OAuth
  # key in opts, let's lurkily string match for it.
  if opts == {} && id.is_a?(String) && id.start_with?("sk_")
    # `super` properly assumes a String opts is the apiKey and normalizes
    # as expected.
    opts = id
    id = nil
  end
  super
end

.update(account, params = {}, opts = {}) ⇒ Object

Updates a [connected account](docs.stripe.com/connect/accounts) by setting the values of the parameters passed. Any parameters not provided are left unchanged.

For accounts where [controller.requirement_collection](docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is application, which includes Custom accounts, you can update any information on the account.

For accounts where [controller.requirement_collection](docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is stripe, which includes Standard and Express accounts, you can update all information until you create an [Account Link or <a href=“/api/account_sessions”>Account Session](docs.stripe.com/api/account_links) to start Connect onboarding, after which some properties can no longer be updated.

To update your own account, use the [Dashboard](dashboard.stripe.com/settings/account). Refer to our [Connect](docs.stripe.com/docs/connect/updating-accounts) documentation to learn more about updating accounts.



5597
5598
5599
5600
5601
5602
5603
5604
 
# File 'lib/stripe/resources/account.rb', line 5597

def self.update(, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/accounts/%<account>s", { account: CGI.escape() }),
    params: params,
    opts: opts
  )
end

Instance Method Details

#deauthorize(client_id = nil, opts = {}) ⇒ Object 



5690
5691
5692
5693
5694
5695
5696
5697
 
# File 'lib/stripe/resources/account.rb', line 5690

def deauthorize(client_id = nil, opts = {})
  params = {
    client_id: client_id,
    stripe_user_id: id,
  }
  opts = @opts.merge(Util.normalize_opts(opts))
  OAuth.deauthorize(params, opts)
end

#delete(params = {}, opts = {}) ⇒ Object

With [Connect](docs.stripe.com/connect), you can delete accounts you manage.

Test-mode accounts can be deleted at any time.

Live-mode accounts where Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. Live-mode accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be deleted when all [balances](docs.stripe.com/api/balance/balance_object) are zero.

If you want to delete your own account, use the [account information tab in your account settings](dashboard.stripe.com/settings/account) instead.



5526
5527
5528
5529
5530
5531
5532
5533
 
# File 'lib/stripe/resources/account.rb', line 5526

def delete(params = {}, opts = {})
  request_stripe_object(
    method: :delete,
    path: format("/v1/accounts/%<account>s", { account: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end

#legal_entity ⇒ Object 



5679
5680
5681
 
# File 'lib/stripe/resources/account.rb', line 5679

def legal_entity
  self["legal_entity"]
end

#legal_entity=(_legal_entity) ⇒ Object

Raises:

  • (NoMethodError) 


5683
5684
5685
5686
5687
5688
 
# File 'lib/stripe/resources/account.rb', line 5683

def legal_entity=(_legal_entity)
  raise NoMethodError,
        "Overriding legal_entity can cause serious issues. Instead, set " \
        "the individual fields of legal_entity like " \
        "`account.legal_entity.first_name = 'Blah'`"
end

#persons(params = {}, opts = {}) ⇒ Object

Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.



5541
5542
5543
5544
5545
5546
5547
5548
 
# File 'lib/stripe/resources/account.rb', line 5541

def persons(params = {}, opts = {})
  request_stripe_object(
    method: :get,
    path: format("/v1/accounts/%<account>s/persons", { account: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end

#reject(params = {}, opts = {}) ⇒ Object

With [Connect](docs.stripe.com/connect), you can reject accounts that you have flagged as suspicious.

Only accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be rejected. Test-mode accounts can be rejected at any time. Live-mode accounts can only be rejected after all balances are zero.



5563
5564
5565
5566
5567
5568
5569
5570
 
# File 'lib/stripe/resources/account.rb', line 5563

def reject(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/accounts/%<account>s/reject", { account: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end

#resource_url ⇒ Object 



5608
5609
5610
5611
5612
5613
5614
 
# File 'lib/stripe/resources/account.rb', line 5608

def resource_url
  if self["id"]
    super
  else
    "/v1/account"
  end
end

#serialize_params(options = {}) ⇒ Object

Somewhat unfortunately, we attempt to do a special encoding trick when serializing ‘additional_owners` under an account: when updating a value, we actually send the update parameters up as an integer-indexed hash rather than an array. So instead of this:

field[]=item1&field[]=item2&field[]=item3

We send this:

field[0]=item1&field[1]=item2&field[2]=item3

There are two major problems with this technique:

* Entities are addressed by array index, which is not stable and can
  easily result in unexpected results between two different requests.

* A replacement of the array's contents is ambiguous with setting a
  subset of the array. Because of this, the only way to shorten an
  array is to unset it completely by making sure it goes into the
  server as an empty string, then setting its contents again.

We’re trying to get this overturned on the server side, but for now, patch in a special allowance.



5659
5660
5661
 
# File 'lib/stripe/resources/account.rb', line 5659

def serialize_params(options = {})
  (self, super, options)
end

#serialize_params_account(_obj, update_hash, options = {}) ⇒ Object 



5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
 
# File 'lib/stripe/resources/account.rb', line 5663

def (_obj, update_hash, options = {})
  if (entity = @values[:legal_entity]) && (owners = entity[:additional_owners])
    entity_update = update_hash[:legal_entity] ||= {}
    entity_update[:additional_owners] =
      serialize_additional_owners(entity, owners)
  end
  if (individual = @values[:individual]) && individual.is_a?(Person) && !update_hash.key?(:individual)
    update_hash[:individual] = individual.serialize_params(options)
  end
  update_hash
end