Struct CustomerBalanceTransaction

pub struct CustomerBalanceTransaction {

    pub amount: i64,
    pub created: i64,
    pub credit_note: Option<Value>,
    pub currency: String,
    pub customer: Value,
    pub description: Option<String>,
    pub ending_balance: i64,
    pub id: String,
    pub invoice: Option<Value>,
    pub livemode: bool,
    pub metadata: Option<Value>,
    pub object: String,
    pub type_: String,
}

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

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.

created: i64

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

credit_note: Option<Value>

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

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

Unique identifier for the object.

invoice: Option<Value>

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<Value>

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_overpaid, invoice_too_large, invoice_too_small, unspent_receiver_credit, or unapplied_from_invoice. 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

Formats the value using the given formatter.

impl Default for CustomerBalanceTransaction

fn default() -> CustomerBalanceTransaction

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CustomerBalanceTransaction

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CustomerBalanceTransaction

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

Formats the value using the given formatter.

impl Serialize for CustomerBalanceTransaction

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.