View Source Stripe.Billing.CreditBalanceTransaction (stripity_stripe v3.3.1)

A credit balance transaction is a resource representing a transaction (either a credit or a debit) against an existing credit grant.

Summary

Types

t()

The billing.credit_balance_transaction type.

Functions

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

Retrieve a list of credit balance transactions.

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

Retrieves a credit balance transaction.

Types

t()

@type t() :: %Stripe.Billing.CreditBalanceTransaction{
  created: integer(),
  credit: term() | nil,
  credit_grant: binary() | Stripe.Billing.CreditGrant.t(),
  debit: term() | nil,
  effective_at: integer(),
  id: binary(),
  livemode: boolean(),
  object: binary(),
  test_clock: (binary() | Stripe.TestHelpers.TestClock.t()) | nil,
  type: binary() | nil
}

The billing.credit_balance_transaction type.

created Time at which the object was created. Measured in seconds since the Unix epoch.
credit Credit details for this credit balance transaction. Only present if type is credit.
credit_grant The credit grant associated with this credit balance transaction.
debit Debit details for this credit balance transaction. Only present if type is debit.
effective_at The effective time of this credit balance transaction.
id Unique identifier for the object.
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.
test_clock ID of the test clock this credit balance transaction belongs to.
type The type of credit balance transaction (credit or debit).

Functions

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

@spec list(
  params :: %{
    optional(:credit_grant) => binary(),
    optional(:customer) => binary(),
    optional(:ending_before) => binary(),
    optional(:expand) => [binary()],
    optional(:limit) => integer(),
    optional(:starting_after) => binary()
  },
  opts :: Keyword.t()
) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Retrieve a list of credit balance transactions.

Details

Method: get
Path: /v1/billing/credit_balance_transactions

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

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

Retrieves a credit balance transaction.

Details

Method: get
Path: /v1/billing/credit_balance_transactions/{id}