Class: Stripe::ShippingRateUpdateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/params/shipping_rate_update_params.rb

Defined Under Namespace

Classes: FixedAmount

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(active: nil, expand: nil, fixed_amount: nil, metadata: nil, tax_behavior: nil) ⇒ ShippingRateUpdateParams

Returns a new instance of ShippingRateUpdateParams.



36
37
38
39
40
41
42
 
# File 'lib/stripe/params/shipping_rate_update_params.rb', line 36

def initialize(active: nil, expand: nil, fixed_amount: nil, metadata: nil, tax_behavior: nil)
  @active = active
  @expand = expand
  @fixed_amount = fixed_amount
  @metadata = metadata
  @tax_behavior = tax_behavior
end

Instance Attribute Details

#active ⇒ Object

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



26
27
28
 
# File 'lib/stripe/params/shipping_rate_update_params.rb', line 26

def active
  @active
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



28
29
30
 
# File 'lib/stripe/params/shipping_rate_update_params.rb', line 28

def expand
  @expand
end

#fixed_amount ⇒ Object

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



30
31
32
 
# File 'lib/stripe/params/shipping_rate_update_params.rb', line 30

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`.



32
33
34
 
# File 'lib/stripe/params/shipping_rate_update_params.rb', line 32

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`.



34
35
36
 
# File 'lib/stripe/params/shipping_rate_update_params.rb', line 34

def tax_behavior
  @tax_behavior
end