class

Stripe::TaxRegistration

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

A Tax Registration lets us know that your business is registered to collect tax on payments within a region, enabling you to automatically collect tax. Stripe doesn't register on your behalf with the relevant authorities when you create a Tax Registration object. For more information on how to register to collect tax, see our guide. Related guide: Using the Registrations API

Constants

ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [tax.registration]."
ERROR_MESSAGE_FOR_STATUS = "invalid value for \"status\", must be one of [active, expired, scheduled]."
MAX_LENGTH_FOR_COUNTRY = 5000
MAX_LENGTH_FOR_ID = 5000
VALID_VALUES_FOR_OBJECT = String.static_array("tax.registration")
VALID_VALUES_FOR_STATUS = String.static_array("active", "expired", "scheduled")

Constructors

new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, active_from : Int64 | Nil = nil, country : String | Nil = nil, country_options : Stripe::TaxProductRegistrationsResourceCountryOptions | Nil = nil, created : Int64 | Nil = nil, expires_at : Int64 | Nil = nil, id : String | Nil = nil, livemode : Bool | Nil = nil, object : String | Nil = nil, status : 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_from

Time at which the registration becomes active. Measured in seconds since the Unix epoch.

Source
active_from=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] active_from 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
country_options
Source
country_options=(new_value : Stripe::TaxProductRegistrationsResourceCountryOptions | Nil)

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

If set, the registration stops being active at this time. If not set, the registration will be active indefinitely. Measured in seconds since the Unix epoch.

Source
expires_at=(new_value : Int64 | Nil)

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

The status of the registration. This field is present for convenience and can be deduced from active_from and expires_at.

Source
status=(new_value : String | Nil)

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