class Stripe::TaxRate

• Stripe::TaxRate
• Reference
• Object

Overview

Tax rates can be applied to invoices, subscriptions and Checkout Sessions to collect tax. Related guide: Tax rates

Included Modules

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

Defined in:

Constant Summary

ERROR_MESSAGE_FOR_JURISDICTION_LEVEL = "invalid value for \"jurisdiction_level\", must be one of [city, country, county, district, multiple, state]."

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

ERROR_MESSAGE_FOR_TAX_TYPE = "invalid value for \"tax_type\", must be one of [amusement_tax, communications_tax, gst, hst, igst, jct, lease_tax, pst, qst, rst, sales_tax, vat]."

MAX_LENGTH_FOR_COUNTRY = 5000

MAX_LENGTH_FOR_DESCRIPTION = 5000

MAX_LENGTH_FOR_DISPLAY_NAME = 5000

MAX_LENGTH_FOR_ID = 5000

MAX_LENGTH_FOR_JURISDICTION = 5000

MAX_LENGTH_FOR_STATE = 5000

VALID_VALUES_FOR_JURISDICTION_LEVEL = String.static_array("city", "country", "county", "district", "multiple", "state")

VALID_VALUES_FOR_OBJECT = String.static_array("tax_rate")

VALID_VALUES_FOR_TAX_TYPE = String.static_array("amusement_tax", "communications_tax", "gst", "hst", "igst", "jct", "lease_tax", "pst", "qst", "rst", "sales_tax", "vat")

Constructors

• .new(pull : JSON::PullParser)
• .new(*, active : Bool | Nil = nil, country : String | Nil = nil, created : Int64 | Nil = nil, description : String | Nil = nil, display_name : String | Nil = nil, effective_percentage : Float64 | Nil = nil, id : String | Nil = nil, inclusive : Bool | Nil = nil, jurisdiction : String | Nil = nil, jurisdiction_level : String | Nil = nil, livemode : Bool | Nil = nil, metadata : Hash(String, String) | Nil = nil, object : String | Nil = nil, percentage : Float64 | Nil = nil, state : String | Nil = nil, tax_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.

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

  Custom attribute writer method checking allowed values (enum).

• #country : String | Nil
• #country=(new_value : String | 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).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #effective_percentage : Float64 | Nil
• #effective_percentage=(new_value : Float64 | 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).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #jurisdiction_level : String | Nil
• #jurisdiction_level=(new_value : String | 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).

• #percentage : Float64 | Nil
• #percentage=(new_value : Float64 | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #tax_type : String | Nil
• #tax_type=(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