class Stripe::TaxCalculation

• Stripe::TaxCalculation
• Reference
• Object

Overview

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

Included Modules

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

Defined in:

Constant Summary

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)
• .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

Instance Method Summary

• #==(other : self)

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

• #amount_total : Int64 | Nil
• #amount_total=(new_value : Int64 | 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 : String | Nil
• #customer=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #customer_details : Stripe::TaxProductResourceCustomerDetails | Nil
• #customer_details=(new_value : Stripe::TaxProductResourceCustomerDetails | Nil)

  Custom attribute writer method checking allowed values (enum).

• #expires_at : Int64 | Nil
• #expires_at=(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).

• #line_items : Stripe::TaxProductResourceTaxCalculationLineItemList | Nil
• #line_items=(new_value : Stripe::TaxProductResourceTaxCalculationLineItemList | Nil)

  Custom attribute writer method checking allowed values (enum).

• #line_items_present=(line_items_present : Bool)
• #line_items_present? : Bool
• #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).

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

  Custom attribute writer method checking allowed values (enum).

• #ship_from_details : Stripe::TaxCalculationShipFromDetails | Nil
• #ship_from_details=(new_value : Stripe::TaxCalculationShipFromDetails | Nil)

  Custom attribute writer method checking allowed values (enum).

• #shipping_cost : Stripe::TaxCalculationShippingCost | Nil
• #shipping_cost=(new_value : Stripe::TaxCalculationShippingCost | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #tax_breakdown : Array(Stripe::TaxProductResourceTaxBreakdown) | Nil
• #tax_breakdown=(new_value : Array(Stripe::TaxProductResourceTaxBreakdown) | Nil)

  Custom attribute writer method checking allowed values (enum).

• #tax_date : Int64 | Nil
• #tax_date=(new_value : Int64 | 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