Mayson Monorepo Documentation
    Preparing search index...

    Interface CustomerCreateBalanceTransactionParams

    interface CustomerCreateBalanceTransactionParams {
        amount: number;
        currency: string;
        description?: string;
        expand?: string[];
        metadata?: Emptyable<MetadataParam>;
    }
    Index

    Properties

    amount: number

    The integer amount in cents (or local equivalent) to apply to the customer's credit balance.

    currency: string

    Three-letter ISO currency code, in lowercase. Must be a supported currency. Specifies the invoice_credit_balance that this transaction will apply to. If the customer's currency is not set, it will be updated to this value.

    description?: string

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

    expand?: string[]

    Specifies which fields in the response should be expanded.

    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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.