Class: Stripe::Checkout::SessionUpdateParams

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

Defined Under Namespace

Classes: CollectedInformation, ShippingOption

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(collected_information: nil, expand: nil, metadata: nil, shipping_options: nil) ⇒ SessionUpdateParams

Returns a new instance of SessionUpdateParams.



171
172
173
174
175
176
 
# File 'lib/stripe/params/checkout/session_update_params.rb', line 171

def initialize(collected_information: nil, expand: nil, metadata: nil, shipping_options: nil)
  @collected_information = collected_information
  @expand = expand
  @metadata = metadata
  @shipping_options = shipping_options
end

Instance Attribute Details

#collected_information ⇒ Object

Information about the customer collected within the Checkout Session. Can only be set when updating ‘embedded` or `custom` sessions.



163
164
165
 
# File 'lib/stripe/params/checkout/session_update_params.rb', line 163

def collected_information
  @collected_information
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



165
166
167
 
# File 'lib/stripe/params/checkout/session_update_params.rb', line 165

def expand
  @expand
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`.



167
168
169
 
# File 'lib/stripe/params/checkout/session_update_params.rb', line 167

def metadata
  @metadata
end

#shipping_options ⇒ Object

The shipping rate options to apply to this Session. Up to a maximum of 5.



169
170
171
 
# File 'lib/stripe/params/checkout/session_update_params.rb', line 169

def shipping_options
  @shipping_options
end