Struct CustomerBalanceTransaction

pub struct CustomerBalanceTransaction {

    pub amount: i64,
    pub checkout_session: Option<Expandable<CheckoutSession>>,
    pub created: i64,
    pub credit_note: Option<Expandable<CreditNote>>,
    pub currency: Currency,
    pub customer: Expandable<Customer>,
    pub description: Option<String>,
    pub ending_balance: i64,
    pub id: CustomerBalanceTransactionId,
    pub invoice: Option<Expandable<Invoice>>,
    pub livemode: bool,
    pub metadata: Option<HashMap<String, String>>,
    pub type_: CustomerBalanceTransactionType,
}

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

For more details see <https://stripe.com/docs/api/customer_balance_transactions/object>.

Fields

amount: i64

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.

checkout_session: Option<Expandable<CheckoutSession>>

The ID of the checkout session (if any) that created the transaction.

created: i64

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

credit_note: Option<Expandable<CreditNote>>

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

currency: Currency

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

customer: Expandable<Customer>

The ID of the customer the transaction belongs to.

description: Option<String>

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

ending_balance: i64

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: CustomerBalanceTransactionId

Unique identifier for the object.

invoice: Option<Expandable<Invoice>>

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

livemode: bool

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

metadata: Option<HashMap<String, String>>

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.

type_: CustomerBalanceTransactionType

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

Trait Implementations

impl Clone for CustomerBalanceTransaction

fn clone(&self) -> CustomerBalanceTransaction

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CustomerBalanceTransaction

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Deserialize for CustomerBalanceTransaction

fn begin(out: &mut Option<CustomerBalanceTransaction>) -> &mut dyn Visitor

The only correct implementation of this method is:

impl Object for CustomerBalanceTransaction

type Id = CustomerBalanceTransactionId

The canonical id type for this object.

fn id(&self) -> &<CustomerBalanceTransaction as Object>::Id

The id of the object.

fn into_id(self) -> <CustomerBalanceTransaction as Object>::Id

The owned id of the object.

impl ObjectDeser for CustomerBalanceTransaction

type Builder = CustomerBalanceTransactionBuilder