class

Stripe::TaxRateDataParam

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

Constants

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 = 50
MAX_LENGTH_FOR_JURISDICTION = 200
MAX_LENGTH_FOR_STATE = 2
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_for_json_serializable pull : JSON::PullParser)
Source
new(*, display_name : String | Nil = nil, inclusive : Bool | Nil = nil, percentage : Float64 | Nil = nil, country : String | Nil = nil, description : String | Nil = nil, jurisdiction : String | 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

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
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 rate, which will be shown to users.

Source
display_name=(new_value : String | Nil)

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

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
list_invalid_properties

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

Source
percentage

The statutory tax rate percent. This field accepts decimal values between 0 and 100 inclusive with at most 4 decimal places. To accommodate fixed-amount taxes, set the percentage to zero. Stripe will not display zero percentages on the invoice unless the amount of the tax is also zero.

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