Class: Stripe::ShippingRateCreateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/params/shipping_rate_create_params.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) ⇒ ShippingRateCreateParams

Returns a new instance of ShippingRateCreateParams.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/stripe/params/shipping_rate_create_params.rb', line 83

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.



67
68
69
 
# File 'lib/stripe/params/shipping_rate_create_params.rb', line 67

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.



69
70
71
 
# File 'lib/stripe/params/shipping_rate_create_params.rb', line 69

def display_name
  @display_name
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



71
72
73
 
# File 'lib/stripe/params/shipping_rate_create_params.rb', line 71

def expand
  @expand
end

#fixed_amount ⇒ Object

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



73
74
75
 
# File 'lib/stripe/params/shipping_rate_create_params.rb', line 73

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



75
76
77
 
# File 'lib/stripe/params/shipping_rate_create_params.rb', line 75

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



77
78
79
 
# File 'lib/stripe/params/shipping_rate_create_params.rb', line 77

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



79
80
81
 
# File 'lib/stripe/params/shipping_rate_create_params.rb', line 79

def tax_code
  @tax_code
end

#type ⇒ Object

The type of calculation to use on the shipping rate.



81
82
83
 
# File 'lib/stripe/params/shipping_rate_create_params.rb', line 81

def type
  @type
end