CustomerBalanceTransaction
Each customer has a Balance value,
which denotes a debit or credit that's automatically applied to their next invoice upon finalization.
You may modify the value directly by using the update customer API,
or by creating a Customer Balance Transaction, which increments or decrements the customer's balance by the specified amount.
Related guide: Customer balance
Summary
Functions
Create a customer balance transaction
List customer balance transactions
Retrieve a customer balance transaction
Update a customer credit balance transaction
Functions
@spec create(Stripe.Client.t(), String.t(), map(), keyword()) :: {:ok, term()} | {:error, Stripe.Error.t()}
Create a customer balance transaction
Creates an immutable transaction that updates the customer’s credit balance.
@spec list(Stripe.Client.t(), String.t(), map(), keyword()) :: {:ok, term()} | {:error, Stripe.Error.t()}
List customer balance transactions
Returns a list of transactions that updated the customer’s balances.
@spec retrieve(Stripe.Client.t(), String.t(), String.t(), map(), keyword()) :: {:ok, term()} | {:error, Stripe.Error.t()}
Retrieve a customer balance transaction
Retrieves a specific customer balance transaction that updated the customer’s balances.
@spec update(Stripe.Client.t(), String.t(), String.t(), map(), keyword()) :: {:ok, term()} | {:error, Stripe.Error.t()}
Update a customer credit balance transaction
Most credit balance transaction fields are immutable, but you may update its description and metadata.