class

Stripe::TaxCalculation

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

A Tax Calculation allows you to calculate the tax to collect from your customer. Related guide: Calculate tax in your custom payment flow

Constants

ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [tax.calculation]."
MAX_LENGTH_FOR_CURRENCY = 5000
MAX_LENGTH_FOR_CUSTOMER = 5000
MAX_LENGTH_FOR_ID = 5000
VALID_VALUES_FOR_OBJECT = String.static_array("tax.calculation")

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, amount_total : Int64 | Nil = nil, currency : String | Nil = nil, customer : String | Nil = nil, customer_details : Stripe::TaxProductResourceCustomerDetails | Nil = nil, expires_at : Int64 | Nil = nil, id : String | Nil = nil, livemode : Bool | Nil = nil, object : String | Nil = nil, ship_from_details : Stripe::TaxCalculationShipFromDetails | Nil = nil, shipping_cost : Stripe::TaxCalculationShippingCost | Nil = nil, tax_amount_exclusive : Int64 | Nil = nil, tax_amount_inclusive : Int64 | Nil = nil, tax_breakdown : Array(Stripe::TaxProductResourceTaxBreakdown) | Nil = nil, tax_date : Int64 | Nil = nil, line_items : Stripe::TaxProductResourceTaxCalculationLineItemList | 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

amount_total

Total amount after taxes in the smallest currency unit.

Source
amount_total=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] amount_total 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
expires_at

Timestamp of date at which the tax calculation will expire.

Source
expires_at=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] expires_at 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 calculation.

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::TaxProductResourceTaxCalculationLineItemList | 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
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
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::TaxCalculationShippingCost | Nil)

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

Source
tax_amount_exclusive

The amount of tax to be collected on top of the line item prices.

Source
tax_amount_exclusive=(new_value : Int64 | Nil)

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

Source
tax_amount_inclusive

The amount of tax already included in the line item prices.

Source
tax_amount_inclusive=(new_value : Int64 | Nil)

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

Source
tax_breakdown

Breakdown of individual tax amounts that add up to the total.

Source
tax_breakdown=(new_value : Array(Stripe::TaxProductResourceTaxBreakdown) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] tax_breakdown 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