exoapi_stripe v0.1.4

View Source ExOAPI.Stripe.Schemas.CustomerBalanceTransaction (exoapi_stripe v0.1.4)

description: 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 to learn more.

:amount :: :integer

The amount of the transaction. A negative value is a credit for the customer's balance, and a positive value is a debit to the customer's balance.

:created :: :integer

Time at which the object was created. Measured in seconds since the Unix epoch.

:credit_note :: ExOAPI.Stripe.Schemas.CreditNote | :string

The ID of the credit note (if any) related to the transaction.

:currency :: :string

Three-letter ISO currency code, in lowercase. Must be a supported currency.

:customer :: ExOAPI.Stripe.Schemas.Customer | :string

The ID of the customer the transaction belongs to.

:description :: :string

An arbitrary string attached to the object. Often useful for displaying to users.

:ending_balance :: :integer

The customer's balance after the transaction was applied. A negative value decreases the amount due on the customer's next invoice. A positive value increases the amount due on the customer's next invoice.

:id :: :string

Unique identifier for the object.

:invoice :: ExOAPI.Stripe.Schemas.Invoice | :string

The ID of the invoice (if any) related to the transaction.

:livemode :: :boolean

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

:metadata :: :map

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

:object :: :string

String representing the object's type. Objects of the same type share the same value.

:type :: :string

Transaction type: adjustment, applied_to_invoice, credit_note, initial, invoice_too_large, invoice_too_small, unspent_receiver_credit, or unapplied_from_invoice. See the Customer Balance page to learn more about transaction types.

Link to this section Summary

Types

params()
t()

Functions

changeset(struct \\ %__MODULE__{}, params)

Link to this section Types

Link to this type

params()

View Source 
@type params() :: map()
Link to this type

t()

View Source 
@type t() :: %ExOAPI.Stripe.Schemas.CustomerBalanceTransaction{
  amount: integer() | nil,
  created: integer() | nil,
  credit_note: ExOAPI.EctoTypes.AnyOf.t() | nil,
  currency: String.t() | nil,
  customer: ExOAPI.EctoTypes.AnyOf.t() | nil,
  description: String.t() | nil,
  ending_balance: integer() | nil,
  id: String.t() | nil,
  invoice: ExOAPI.EctoTypes.AnyOf.t() | nil,
  livemode: boolean() | nil,
  metadata: map() | nil,
  object: :customer_balance_transaction | nil,
  type:
    (:unspent_receiver_credit
     | :unapplied_from_invoice
     | :migration
     | :invoice_too_small
     | :invoice_too_large
     | :initial
     | :credit_note
     | :applied_to_invoice
     | :adjustment)
    | nil
}

Link to this section Functions

Link to this function

changeset(struct \\ %__MODULE__{}, params)

View Source 
@spec changeset(t(), params()) :: Ecto.Changeset.t()