class

Stripe::TaxTransaction

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

A Tax Transaction records the tax collected from or refunded to your customer. Related guide: Calculate tax in your custom payment flow

Constants

ERROR_MESSAGE_FOR__TYPE = "invalid value for \"_type\", must be one of [reversal, transaction]."
ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [tax.transaction]."
MAX_LENGTH_FOR_CURRENCY = 5000
MAX_LENGTH_FOR_CUSTOMER = 5000
MAX_LENGTH_FOR_ID = 5000
MAX_LENGTH_FOR_REFERENCE = 5000
VALID_VALUES_FOR__TYPE = String.static_array("reversal", "transaction")
VALID_VALUES_FOR_OBJECT = String.static_array("tax.transaction")

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, created : Int64 | Nil = nil, currency : String | Nil = nil, customer : String | Nil = nil, customer_details : Stripe::TaxProductResourceCustomerDetails | Nil = nil, id : String | Nil = nil, livemode : Bool | Nil = nil, metadata : Hash(String, String) | Nil = nil, object : String | Nil = nil, posted_at : Int64 | Nil = nil, reference : String | Nil = nil, reversal : Stripe::TaxTransactionReversal | Nil = nil, ship_from_details : Stripe::TaxCalculationShipFromDetails | Nil = nil, shipping_cost : Stripe::TaxTransactionShippingCost | Nil = nil, tax_date : Int64 | Nil = nil, _type : String | Nil = nil, line_items : Stripe::TaxProductResourceTaxTransactionLineItemList | Nil = nil)

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

Source

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

If reversal, this transaction reverses an earlier transaction.

Source
_type=(new_value : String | Nil)

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

Source
created

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

Source
created=(new_value : Int64 | Nil)

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

Source
currency

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

Source
currency=(new_value : String | Nil)

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

Source
customer

The ID of an existing Customer used for the resource.

Source
customer=(new_value : String | Nil)

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

Source
customer_details
Source
customer_details=(new_value : Stripe::TaxProductResourceCustomerDetails | Nil)

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

Source
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 transaction.

Source
id=(new_value : String | Nil)

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

Source
line_items
Source
line_items=(new_value : Stripe::TaxProductResourceTaxTransactionLineItemList | Nil)

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

Source
line_items_present=(line_items_present : Bool)
Source
line_items_present?
Source
list_invalid_properties

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

Source
livemode

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

Source
livemode=(new_value : Bool | Nil)

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

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

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

Source
object

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

Source
object=(new_value : String | Nil)

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

Source
posted_at

The Unix timestamp representing when the tax liability is assumed or reduced.

Source
posted_at=(new_value : Int64 | Nil)

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

Source
reference

A custom unique identifier, such as 'myOrder_123'.

Source
reference=(new_value : String | Nil)

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

Source
reversal
Source
reversal=(new_value : Stripe::TaxTransactionReversal | Nil)

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

Source
ship_from_details
Source
ship_from_details=(new_value : Stripe::TaxCalculationShipFromDetails | Nil)

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

Source
shipping_cost
Source
shipping_cost=(new_value : Stripe::TaxTransactionShippingCost | Nil)

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

Source
tax_date

Timestamp of date at which the tax rules and rates in effect applies for the calculation.

Source
tax_date=(new_value : Int64 | Nil)

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

Source
valid?

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

Source