Stripe.CustomerBalanceTransaction (stripity_stripe v2.17.3) View Source

t() :: %{
  id: Stripe.id(),
  object: String.t(),
  amount: integer(),
  created: Stripe.timestamp(),
  credit_note: String.t() | Stripe.CreditNote.t() | nil,
  currency: String.t(),
  customer: Stripe.id() | Stripe.Customer.t(),
  description: String.t() | nil,
  ending_balance: integer(),
  invoice: Stripe.id() | Stripe.Invoice.t() | nil,
  livemode: boolean(),
  metadata: Stripe.Types.metadata(),
  type: String.t()
}

Link to this section Functions

create(customer, params, opts \\ [])

Specs

create(Stripe.id() | Stripe.Customer.t(), params, Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}
when params:
       %{
         :amount => number(),
         :currency => String.t(),
         optional(:description) => String.t(),
         optional(:metadata) => Stripe.Types.metadata()
       }
       | %{}

Create a customer balance transaction.

list(customer, params \\ %{}, opts \\ [])

Specs

list(Stripe.id() | Stripe.Customer.t(), params, Stripe.options()) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.Error.t()}
when params:
       %{
         optional(:ending_before) => t() | Stripe.id(),
         optional(:limit) => 1..100,
         optional(:starting_after) => t() | Stripe.id()
       }
       | %{}

List all Customer Balance Transactions.

retrieve(customer, balance_transaction, opts \\ [])

Specs

retrieve(Stripe.id() | Stripe.Customer.t(), Stripe.id() | t(), Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}

Retrieve a Customer Balance Transaction.

update(customer, balance_transaction, params, opts \\ [])

Specs

update(
  Stripe.id() | Stripe.Customer.t(),
  Stripe.id() | t(),
  params,
  Stripe.options()
) ::
  {:ok, t()} | {:error, Stripe.Error.t()}
when params: %{
       optional(:description) => String.t(),
       optional(:metadata) => Stripe.Types.metadata()
     }

Update a Customer Balance Transaction.