Stripe.Resources.Billing.CreditBalance (tiger_stripe v0.3.0)

CreditBalance

Summary

Types

available_balance()

available_balance_monetary()

ledger_balance()

ledger_balance_monetary()

t()

Functions

expandable_fields()

object_name()

Types

available_balance()

@type available_balance() :: %{
  optional(:monetary) => available_balance_monetary() | nil,
  optional(:type) => String.t() | nil,
  optional(String.t()) => term()
}

monetary - The monetary amount. Nullable.
type - The type of this amount. We currently only support monetary billing credits. Possible values: monetary.

available_balance_monetary()

@type available_balance_monetary() :: %{
  optional(:currency) => String.t() | nil,
  optional(:value) => integer() | nil,
  optional(String.t()) => term()
}

currency - Three-letter ISO currency code, in lowercase. Must be a supported currency. Max length: 5000.
value - A positive integer representing the amount.

ledger_balance()

@type ledger_balance() :: %{
  optional(:monetary) => ledger_balance_monetary() | nil,
  optional(:type) => String.t() | nil,
  optional(String.t()) => term()
}

monetary - The monetary amount. Nullable.
type - The type of this amount. We currently only support monetary billing credits. Possible values: monetary.

ledger_balance_monetary()

@type ledger_balance_monetary() :: %{
  optional(:currency) => String.t() | nil,
  optional(:value) => integer() | nil,
  optional(String.t()) => term()
}

currency - Three-letter ISO currency code, in lowercase. Must be a supported currency. Max length: 5000.
value - A positive integer representing the amount.

t()

@type t() :: %Stripe.Resources.Billing.CreditBalance{
  available_balance: available_balance(),
  ledger_balance: ledger_balance()
}

available_balance - Expandable.
ledger_balance - Expandable.