class

Stripe::TaxRate

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

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

Constants

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)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
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

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

active

Defaults to true. When set to false, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.

Source
active=(new_value : Bool | Nil)

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

Source
country

Two-letter country code (ISO 3166-1 alpha-2).

Source
country=(new_value : String | Nil)

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

An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.

Source
description=(new_value : String | Nil)

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

Source
display_name

The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.

Source
display_name=(new_value : String | Nil)

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

Source
effective_percentage

Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage reflects the rate actually used to calculate tax based on the product's taxability and whether the user is registered to collect taxes in the corresponding jurisdiction.

Source
effective_percentage=(new_value : Float64 | Nil)

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

Source
id=(new_value : String | Nil)

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

Source
inclusive

This specifies if the tax rate is inclusive or exclusive.

Source
inclusive=(new_value : Bool | Nil)

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

Source
jurisdiction

The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.

Source
jurisdiction=(new_value : String | Nil)

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

Source
jurisdiction_level

The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates.

Source
jurisdiction_level=(new_value : String | Nil)

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

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
percentage

Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions.

Source
percentage=(new_value : Float64 | Nil)

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

Source
state

ISO 3166-2 subdivision code, without country prefix. For example, "NY" for New York, United States.

Source
state=(new_value : String | Nil)

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

Source
tax_type

The high-level tax type, such as vat or sales_tax.

Source
tax_type=(new_value : String | Nil)

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