class Stripe::CustomerBalanceTransaction

• Stripe::CustomerBalanceTransaction
• Reference
• Object

Overview

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

Included Modules

• JSON::Serializable
• JSON::Serializable::Unmapped
• OpenApi::Json
• OpenApi::Validatable

Defined in:

stripe/models/customer_balance_transaction.cr

Constant Summary

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(*, 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 Method Summary

• #==(other : self)

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

• #_type : String | Nil
• #_type=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #amount : Int64 | Nil
• #amount=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #created : Int64 | Nil
• #created=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #currency : String | Nil
• #currency=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #description : String | Nil
• #description=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #ending_balance : Int64 | Nil
• #ending_balance=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #hash(hasher)

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

• #id : String | Nil
• #id=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #list_invalid_properties : Array(String)

  Show invalid properties with the reasons.

• #livemode : Bool | Nil
• #livemode=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #object : String | Nil
• #object=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #valid? : Bool

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

Constructor Detail

Instance Method Detail