class

Stripe::ShippingRate

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

Shipping rates describe the price of shipping presented to your customers and applied to a purchase. For more information, see Charge for shipping.

Constants

ERROR_MESSAGE_FOR__TYPE = "invalid value for \"_type\", must be one of [fixed_amount]."
ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [shipping_rate]."
ERROR_MESSAGE_FOR_TAX_BEHAVIOR = "invalid value for \"tax_behavior\", must be one of [exclusive, inclusive, unspecified]."
MAX_LENGTH_FOR_DISPLAY_NAME = 5000
MAX_LENGTH_FOR_ID = 5000
VALID_VALUES_FOR__TYPE = String.static_array("fixed_amount")
VALID_VALUES_FOR_OBJECT = String.static_array("shipping_rate")
VALID_VALUES_FOR_TAX_BEHAVIOR = String.static_array("exclusive", "inclusive", "unspecified")

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, active : Bool | Nil = nil, created : Int64 | Nil = nil, delivery_estimate : Stripe::ShippingRateDeliveryEstimate1 | Nil = nil, display_name : String | Nil = nil, id : String | Nil = nil, livemode : Bool | Nil = nil, metadata : Hash(String, String) | Nil = nil, object : String | Nil = nil, tax_behavior : String | Nil = nil, tax_code : Stripe::ShippingRateTaxCode | Nil = nil, _type : String | Nil = nil, fixed_amount : Stripe::ShippingRateFixedAmount | 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

_type

The type of calculation to use on the shipping rate.

Source
_type=(new_value : String | Nil)

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

Source
active

Whether the shipping rate can be used for new purchases. Defaults to true.

Source
active=(new_value : Bool | Nil)

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

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

Source
display_name

The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.

Source
display_name=(new_value : String | Nil)

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

Source
fixed_amount
Source
fixed_amount=(new_value : Stripe::ShippingRateFixedAmount | Nil)

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

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
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
tax_behavior

Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.

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
Source
tax_code=(new_value : Stripe::ShippingRateTaxCode | 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