class Stripe::ShippingRate

Overview

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

Included Modules

Defined in:

stripe/models/shipping_rate.cr

Constant Summary

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

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


[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 _type : String | Nil #

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

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


[View source]
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 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 delivery_estimate : Stripe::ShippingRateDeliveryEstimate1 | Nil #

[View source]
def delivery_estimate=(new_value : Stripe::ShippingRateDeliveryEstimate1 | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] delivery_estimate 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 fixed_amount : Stripe::ShippingRateFixedAmount | Nil #

[View source]
def fixed_amount=(new_value : Stripe::ShippingRateFixedAmount | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] fixed_amount 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 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 tax_behavior : String | Nil #

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

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


[View source]
def tax_code : Stripe::ShippingRateTaxCode | Nil #

[View source]
def tax_code=(new_value : Stripe::ShippingRateTaxCode | Nil) #

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