class

Stripe::CustomerBalanceTransaction

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

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

Constants

ERROR_MESSAGE_FOR__TYPE = "invalid value for \"_type\", must be one of [adjustment, applied_to_invoice, credit_note, initial, invoice_overpaid, invoice_too_large, invoice_too_small, migration, unapplied_from_invoice, unspent_receiver_credit]."

ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [customer_balance_transaction]."

MAX_LENGTH_FOR_DESCRIPTION = 5000

MAX_LENGTH_FOR_ID = 5000

VALID_VALUES_FOR__TYPE = String.static_array("adjustment", "applied_to_invoice", "credit_note", "initial", "invoice_overpaid", "invoice_too_large", "invoice_too_small", "migration", "unapplied_from_invoice", "unspent_receiver_credit")

VALID_VALUES_FOR_OBJECT = String.static_array("customer_balance_transaction")

Constructors

new(pull : JSON::PullParser)

new(*, __pull_for_json_serializable pull : JSON::PullParser)

new(*, amount : Int64 | Nil = nil, created : Int64 | Nil = nil, credit_note : Stripe::CustomerBalanceTransactionCreditNote | Nil = nil, currency : String | Nil = nil, customer : Stripe::CustomerBalanceTransactionCustomer | Nil = nil, description : String | Nil = nil, ending_balance : Int64 | Nil = nil, id : String | Nil = nil, invoice : Stripe::CustomerBalanceTransactionInvoice | Nil = nil, livemode : Bool | Nil = nil, metadata : Hash(String, String) | Nil = nil, object : String | Nil = nil, _type : String | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

_type

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.

_type=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] _type Object to be assigned

amount

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.

amount=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] amount Object to be assigned

created

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

created=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] created Object to be assigned

credit_note

credit_note=(new_value : Stripe::CustomerBalanceTransactionCreditNote | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] credit_note Object to be assigned

currency

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

currency=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] currency Object to be assigned

customer

customer=(new_value : Stripe::CustomerBalanceTransactionCustomer | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] customer Object to be assigned

description

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

description=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] description Object to be assigned

ending_balance

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.

ending_balance=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] ending_balance Object to be assigned

hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

id

Unique identifier for the object.

id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] id Object to be assigned

invoice

invoice=(new_value : Stripe::CustomerBalanceTransactionInvoice | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] invoice Object to be assigned

list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

livemode

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

livemode=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] livemode Object to be assigned

metadata

metadata=(new_value : Hash(String, String) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] metadata Object to be assigned

object

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

object=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] object Object to be assigned

valid?

Check to see if the all the properties in the model are valid @return true if the model is valid