class

Stripe::ShippingCost

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

Constants

ERROR_MESSAGE_FOR_TAX_BEHAVIOR = "invalid value for \"tax_behavior\", must be one of [exclusive, inclusive]."
MAX_LENGTH_FOR_SHIPPING_RATE = 5000
VALID_VALUES_FOR_TAX_BEHAVIOR = String.static_array("exclusive", "inclusive")

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, amount : Int64 | Nil = nil, shipping_rate : String | Nil = nil, shipping_rate_data : Stripe::MethodParams | Nil = nil, tax_behavior : String | Nil = nil, tax_code : 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

amount

A positive integer in the smallest currency unit representing the shipping charge. If tax_behavior=inclusive, then this amount includes taxes. Otherwise, taxes are calculated on top of this amount.

Source
amount=(new_value : Int64 | Nil)

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

list_invalid_properties

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

Source
shipping_rate

If provided, the shipping rate's amount, tax_code and tax_behavior are used. If you provide a shipping rate, then you cannot pass the amount, tax_code, or tax_behavior parameters.

Source
shipping_rate=(new_value : String | Nil)

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

Source
shipping_rate_data
Source
shipping_rate_data=(new_value : Stripe::MethodParams | Nil)

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

Source
tax_behavior

Specifies whether the amount includes taxes. If tax_behavior=inclusive, then the amount includes taxes. Defaults to exclusive.

Source
tax_behavior=(new_value : String | Nil)

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

Source
tax_code

The tax code used to calculate tax on shipping. If not provided, the default shipping tax code from your Tax Settings is used.

Source
tax_code=(new_value : String | Nil)

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