Mayson Monorepo Documentation
    Preparing search index...

    Interface 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

    interface CustomerBalanceTransaction {
        id: string;
        object: "customer_balance_transaction";
        amount: number;
        checkout_session: string | Stripe.Checkout.Session;
        created: number;
        credit_note: string | Stripe.CreditNote;
        currency: string;
        customer: string | Stripe.Customer;
        customer_account: string;
        description: string;
        ending_balance: number;
        invoice: string | Stripe.Invoice;
        livemode: boolean;
        metadata: Metadata;
        type: Stripe.CustomerBalanceTransaction.Type;
    }
    Index

    Properties

    id: string

    Unique identifier for the object.

    object: "customer_balance_transaction"

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

    amount: number

    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: string | Stripe.Checkout.Session

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

    created: number

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

    credit_note: string | Stripe.CreditNote

    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: string | Stripe.Customer

    The ID of the customer the transaction belongs to.

    customer_account: string

    The ID of an Account representing a customer that the transaction belongs to.

    description: string

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

    ending_balance: number

    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.

    invoice: string | Stripe.Invoice

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

    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.

    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.