View Source Stripe.Balance (stripity_stripe v3.3.1)

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

The top-level available and pending comprise your "payments balance."

Summary

Types

t()

The balance type.

Functions

retrieve(params \\ %{}, opts \\ [])

Retrieves the current account balance, based on the authentication that was used to make the request. For a sample request, see Accounting for negative balances.

Types

t()

@type t() :: %Stripe.Balance{
  available: term(),
  connect_reserved: term(),
  instant_available: term(),
  issuing: term(),
  livemode: boolean(),
  object: binary(),
  pending: term(),
  refund_and_dispute_prefunding: term()
}

The balance type.

available Available funds that you can transfer or pay out automatically by Stripe or explicitly through the Transfers API or Payouts API. You can find the available balance for each currency and payment type in the source_types property.
connect_reserved Funds held due to negative balances on connected accounts where account.controller.requirement_collection is application, which includes Custom accounts. You can find the connect reserve balance for each currency and payment type in the source_types property.
instant_available Funds that you can pay out using Instant Payouts.
issuing
livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
object String representing the object's type. Objects of the same type share the same value.
pending Funds that aren't available in the balance yet. You can find the pending balance for each currency and each payment type in the source_types property.
refund_and_dispute_prefunding

Functions

retrieve(params \\ %{}, opts \\ [])

@spec retrieve(params :: %{optional(:expand) => [binary()]}, opts :: Keyword.t()) ::
  {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Retrieves the current account balance, based on the authentication that was used to make the request. For a sample request, see Accounting for negative balances.

#### Details * Method: `get` * Path: `/v1/balance`