exoapi_stripe v0.1.4

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

description: This is an object representing your Stripe balance. You can retrieve it to see the balance currently on your Stripe account.

You can also retrieve the balance history, which contains a list of transactions that contributed to the balance (charges, payouts, and so forth).

The available and pending amounts for each currency are broken down further by payment source types.

Related guide: Understanding Connect Account Balances.

::available :: ExOAPI.Stripe.Schemas.BalanceAmount

::connect_reserved :: ExOAPI.Stripe.Schemas.BalanceAmount

::instant_available :: ExOAPI.Stripe.Schemas.BalanceAmount

:issuing :: ExOAPI.Stripe.Schemas.BalanceDetail

:livemode :: :boolean

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

:object :: :string

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

::pending :: ExOAPI.Stripe.Schemas.BalanceAmount

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.Balance{
  available: [ExOAPI.Stripe.Schemas.BalanceAmount.t()],
  connect_reserved: [ExOAPI.Stripe.Schemas.BalanceAmount.t()],
  instant_available: [ExOAPI.Stripe.Schemas.BalanceAmount.t()],
  issuing: ExOAPI.Stripe.Schemas.BalanceDetail.t() | nil,
  livemode: boolean() | nil,
  object: :balance | nil,
  pending: [ExOAPI.Stripe.Schemas.BalanceAmount.t()]
}

Link to this section Functions

Link to this function

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

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