Striped v0.1.0

View Source Stripe.Account (Striped v0.1.0)

This is an object representing a Stripe account. You can retrieve it to see properties on the account like its current e-mail address or if the account is enabled yet to make live charges.

Some properties, marked below, are available only to platforms that want to create and manage Express or Custom accounts.

Link to this section Summary

Types

t()

The account type.

Functions

capabilities(client, account, params \\ %{})

Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.

create(client, params \\ %{})

With Connect, you can create Stripe accounts for your users.To do this, you’ll first need to register your platform.

delete(client, account)

With Connect, you can delete accounts you manage.

list(client, params \\ %{})

Returns a list of accounts connected to your platform via Connect. If you’re not a platform, the list is empty.

persons(client, account, params \\ %{})

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.

reject(client, account, params \\ %{})

With Connect, you may flag accounts as suspicious.

retrieve(client, params \\ %{})

Retrieves the details of an account.

update(client, account, params \\ %{})

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are not supported for Standard accounts.

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %Stripe.Account{
  business_profile: term() | nil,
  business_type: binary() | nil,
  capabilities: term(),
  charges_enabled: boolean(),
  company: term(),
  controller: term(),
  country: binary(),
  created: integer(),
  default_currency: binary(),
  details_submitted: boolean(),
  email: binary() | nil,
  external_accounts: term(),
  future_requirements: term(),
  id: binary(),
  individual: Stripe.Person.t(),
  metadata: term(),
  object: binary(),
  payouts_enabled: boolean(),
  requirements: term(),
  settings: term() | nil,
  tos_acceptance: term(),
  type: binary()
}

The account type.

  • business_profile Business information about the account.
  • business_type The business type.
  • capabilities
  • charges_enabled Whether the account can create live charges.
  • company
  • controller
  • country The account's country.
  • created Time at which the account was connected. Measured in seconds since the Unix epoch.
  • 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.
  • details_submitted Whether account details have been submitted. Standard accounts cannot receive payouts before this is true.
  • email An email address associated with the account. You can treat this as metadata: it is not used for authentication or messaging account holders.
  • external_accounts External accounts (bank accounts and debit cards) currently attached to this account
  • future_requirements
  • id Unique identifier for the object.
  • individual
  • metadata 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.
  • object String representing the object's type. Objects of the same type share the same value.
  • payouts_enabled Whether Stripe can send payouts to this account.
  • requirements
  • settings Options for customizing how the account functions within Stripe.
  • tos_acceptance
  • type The Stripe account type. Can be standard, express, or custom.

Link to this section Functions

Link to this function

capabilities(client, account, params \\ %{})

View Source 
@spec capabilities(client :: term(), account :: binary(), params :: map()) ::
  {:ok, Stripe.List.t(Stripe.Capability.t())}
  | {:error, Stripe.ApiErrors.t()}
  | {:error, term()}

Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.

Details

  • Method: get
  • Path: /v1/accounts/{account}/capabilities

Query parameters

  • :expand array of: string
Link to this function

create(client, params \\ %{})

View Source 
@spec create(client :: term(), params :: map()) ::
  {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

With Connect, you can create Stripe accounts for your users.To do this, you’ll first need to register your platform.

#### Details * Method: `post` * Path: `/v1/accounts`

Link to this function

delete(client, account)

View Source 
@spec delete(client :: term(), account :: binary()) ::
  {:ok, Stripe.DeletedAccount.t()}
  | {:error, Stripe.ApiErrors.t()}
  | {:error, term()}

With Connect, you can delete accounts you manage.

Accounts created using test-mode keys can be deleted at any time. Standard accounts created using live-mode keys cannot be deleted. Custom or Express accounts created using live-mode keys can only be deleted once all balances are zero.

If you want to delete your own account, use the account information tab in your account settings instead.

Details

  • Method: delete
  • Path: /v1/accounts/{account}
Link to this function

list(client, params \\ %{})

View Source 
@spec list(client :: term(), params :: map()) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Returns a list of accounts connected to your platform via Connect. If you’re not a platform, the list is empty.

Details

  • Method: get
  • Path: /v1/accounts

Query parameters

  • :created any of:
    • object with (optional) properties:
      • gt: integer
      • gte: integer
      • lt: integer
      • lte: integer
    • integer
  • :ending_before string
  • :expand array of: string
  • :limit integer
  • :starting_after string
Link to this function

persons(client, account, params \\ %{})

View Source 
@spec persons(client :: term(), account :: binary(), params :: map()) ::
  {:ok, Stripe.List.t(Stripe.Person.t())}
  | {:error, Stripe.ApiErrors.t()}
  | {:error, term()}

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.

Details

  • Method: get
  • Path: /v1/accounts/{account}/persons

Query parameters

  • :ending_before string
  • :expand array of: string
  • :limit integer
  • :relationship object with (optional) properties:
    • director: boolean
    • executive: boolean
    • owner: boolean
    • representative: boolean
  • :starting_after string
Link to this function

reject(client, account, params \\ %{})

View Source 
@spec reject(client :: term(), account :: binary(), params :: map()) ::
  {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

With Connect, you may flag accounts as suspicious.

Test-mode Custom and Express accounts can be rejected at any time. Accounts created using live-mode keys may only be rejected once all balances are zero.

Details

  • Method: post
  • Path: /v1/accounts/{account}/reject
Link to this function

retrieve(client, params \\ %{})

View Source 
@spec retrieve(client :: term(), params :: map()) ::
  {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Retrieves the details of an account.

Details

  • Method: get
  • Path: /v1/account

Query parameters

  • :expand array of: string
Link to this function

update(client, account, params \\ %{})

View Source 
@spec update(client :: term(), account :: binary(), params :: map()) ::
  {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged. Most parameters can be changed only for Custom accounts. (These are marked Custom Only below.) Parameters marked Custom and Express are not supported for Standard accounts.

To update your own account, use the Dashboard. Refer to our Connect documentation to learn more about updating accounts.

Details

  • Method: post
  • Path: /v1/accounts/{account}