Class: Stripe::ShippingRate::CreateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/resources/shipping_rate.rb

Defined Under Namespace

Classes: DeliveryEstimate, FixedAmount

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(delivery_estimate: nil, display_name: nil, expand: nil, fixed_amount: nil, metadata: nil, tax_behavior: nil, tax_code: nil, type: nil) ⇒ CreateParams

Returns a new instance of CreateParams.



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/stripe/resources/shipping_rate.rb', line 182

def initialize(
  delivery_estimate: nil,
  display_name: nil,
  expand: nil,
  fixed_amount: nil,
  metadata: nil,
  tax_behavior: nil,
  tax_code: nil,
  type: nil
)
  @delivery_estimate = delivery_estimate
  @display_name = display_name
  @expand = expand
  @fixed_amount = fixed_amount
  @metadata = metadata
  @tax_behavior = tax_behavior
  @tax_code = tax_code
  @type = type
end

Instance Attribute Details

#delivery_estimate ⇒ Object

The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.



166
167
168
 
# File 'lib/stripe/resources/shipping_rate.rb', line 166

def delivery_estimate
  @delivery_estimate
end

#display_name ⇒ Object

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



168
169
170
 
# File 'lib/stripe/resources/shipping_rate.rb', line 168

def display_name
  @display_name
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



170
171
172
 
# File 'lib/stripe/resources/shipping_rate.rb', line 170

def expand
  @expand
end

#fixed_amount ⇒ Object

Describes a fixed amount to charge for shipping. Must be present if type is ‘fixed_amount`.



172
173
174
 
# File 'lib/stripe/resources/shipping_rate.rb', line 172

def fixed_amount
  @fixed_amount
end

#metadata ⇒ Object

Set of [key-value pairs](stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to ‘metadata`.



174
175
176
 
# File 'lib/stripe/resources/shipping_rate.rb', line 174

def metadata
  @metadata
end

#tax_behavior ⇒ Object

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



176
177
178
 
# File 'lib/stripe/resources/shipping_rate.rb', line 176

def tax_behavior
  @tax_behavior
end

#tax_code ⇒ Object

A [tax code](stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is ‘txcd_92010001`.



178
179
180
 
# File 'lib/stripe/resources/shipping_rate.rb', line 178

def tax_code
  @tax_code
end

#type ⇒ Object

The type of calculation to use on the shipping rate.



180
181
182
 
# File 'lib/stripe/resources/shipping_rate.rb', line 180

def type
  @type
end