class Stripe::TaxRate

Overview

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

Included Modules

Defined in:

stripe/models/tax_rate.cr

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

Instance Method Summary

Instance methods inherited from module OpenApi::Json

after_initialize after_initialize, clone clone, eql?(o : self) eql?, to_hash : Hash(String, JSON::Any) to_hash, to_json_any : JSON::Any to_json_any

Class methods inherited from module OpenApi::Json

build_from_hash(hash : Hash) build_from_hash, build_from_json_any(json_any : JSON::Any) build_from_json_any

Instance methods inherited from module OpenApi::Validatable

list_invalid_properties : Array(String) list_invalid_properties, list_invalid_properties_for(key : String) : Array(String) list_invalid_properties_for, valid? : Bool valid?, validate : Nil validate

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.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


[View source]

Instance Method Detail

def ==(other : self) #

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


def active : Bool | Nil #

[View source]
def active=(new_value : Bool | Nil) #

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


[View source]
def country : String | Nil #

[View source]
def country=(new_value : String | Nil) #

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


[View source]
def created : Int64 | Nil #

[View source]
def created=(new_value : Int64 | Nil) #

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


[View source]
def description : String | Nil #

[View source]
def description=(new_value : String | Nil) #

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


[View source]
def display_name : String | Nil #

[View source]
def display_name=(new_value : String | Nil) #

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


[View source]
def effective_percentage : Float64 | Nil #

[View source]
def effective_percentage=(new_value : Float64 | Nil) #

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


[View source]
def hash(hasher) #

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


def id : String | Nil #

[View source]
def id=(new_value : String | Nil) #

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


[View source]
def inclusive : Bool | Nil #

[View source]
def inclusive=(new_value : Bool | Nil) #

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


[View source]
def jurisdiction : String | Nil #

[View source]
def jurisdiction=(new_value : String | Nil) #

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


[View source]
def jurisdiction_level : String | Nil #

[View source]
def jurisdiction_level=(new_value : String | Nil) #

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


[View source]
def list_invalid_properties : Array(String) #

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


[View source]
def livemode : Bool | Nil #

[View source]
def livemode=(new_value : Bool | Nil) #

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


[View source]
def metadata : Hash(String, String) | Nil #

[View source]
def metadata=(new_value : Hash(String, String) | Nil) #

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


[View source]
def object : String | Nil #

[View source]
def object=(new_value : String | Nil) #

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


[View source]
def percentage : Float64 | Nil #

[View source]
def percentage=(new_value : Float64 | Nil) #

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


[View source]
def state : String | Nil #

[View source]
def state=(new_value : String | Nil) #

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


[View source]
def tax_type : String | Nil #

[View source]
def tax_type=(new_value : String | Nil) #

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


[View source]
def valid? : Bool #

Check to see if the all the properties in the model are valid @return true if the model is valid


[View source]