exoapi_stripe v0.1.4

View Source ExOAPI.Stripe.Schemas.Account (exoapi_stripe v0.1.4)

description: 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.

:business_profile :: ExOAPI.Stripe.Schemas.AccountBusinessProfile

Business information about the account.

:business_type :: :string

The business type.

:capabilities :: ExOAPI.Stripe.Schemas.AccountCapabilities

:charges_enabled :: :boolean

Whether the account can create live charges.

:company :: ExOAPI.Stripe.Schemas.LegalEntityCompany

:controller :: ExOAPI.Stripe.Schemas.AccountUnificationAccountController

:country :: :string

The account's country.

:created :: :integer

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

:default_currency :: :string

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 :: :boolean

Whether account details have been submitted. Standard accounts cannot receive payouts before this is true.

:email :: :string

An email address associated with the account. You can treat this as metadata: it is not used for authentication or messaging account holders.

::data :: ExOAPI.Stripe.Schemas.Card | ExOAPI.Stripe.Schemas.BankAccount

:has_more :: :boolean

True if this list has another page of items after this one that can be fetched.

:object :: :string

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

:url :: :string

The URL where this list can be accessed.

:future_requirements :: ExOAPI.Stripe.Schemas.AccountFutureRequirements

:id :: :string

Unique identifier for the object.

:individual :: ExOAPI.Stripe.Schemas.Person

:metadata :: :map

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

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

:payouts_enabled :: :boolean

Whether Stripe can send payouts to this account.

:requirements :: ExOAPI.Stripe.Schemas.AccountRequirements

:settings :: ExOAPI.Stripe.Schemas.AccountSettings

Options for customizing how the account functions within Stripe.

:tos_acceptance :: ExOAPI.Stripe.Schemas.AccountTosAcceptance

:type :: :string

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

Link to this section Summary

Types

params()
t()

Functions

changeset(struct \\ %__MODULE__{}, params)

Link to this section Types

Link to this type

params()

View Source 
@type params() :: map()
Link to this type

t()

View Source 
@type t() :: %ExOAPI.Stripe.Schemas.Account{
  business_profile: ExOAPI.EctoTypes.AnyOf.t() | nil,
  business_type:
    (:non_profit | :individual | :government_entity | :company) | nil,
  capabilities: ExOAPI.Stripe.Schemas.AccountCapabilities.t() | nil,
  charges_enabled: boolean() | nil,
  company: ExOAPI.Stripe.Schemas.LegalEntityCompany.t() | nil,
  controller:
    ExOAPI.Stripe.Schemas.AccountUnificationAccountController.t() | nil,
  country: String.t() | nil,
  created: integer() | nil,
  default_currency: String.t() | nil,
  details_submitted: boolean() | nil,
  email: String.t() | nil,
  external_accounts: map() | nil,
  future_requirements:
    ExOAPI.Stripe.Schemas.AccountFutureRequirements.t() | nil,
  id: String.t() | nil,
  individual: ExOAPI.Stripe.Schemas.Person.t() | nil,
  metadata: map() | nil,
  object: :account | nil,
  payouts_enabled: boolean() | nil,
  requirements: ExOAPI.Stripe.Schemas.AccountRequirements.t() | nil,
  settings: ExOAPI.EctoTypes.AnyOf.t() | nil,
  tos_acceptance: ExOAPI.Stripe.Schemas.AccountTosAcceptance.t() | nil,
  type: (:standard | :express | :custom) | nil
}

Link to this section Functions

Link to this function

changeset(struct \\ %__MODULE__{}, params)

View Source 
@spec changeset(t(), params()) :: Ecto.Changeset.t()