Class: Stripe::Checkout::SessionUpdateParams

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

Defined Under Namespace

Classes: CollectedInformation, LineItem, ShippingOption

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

attr_accessor, coerce_params, coerce_value, discriminator, discriminator_fields, new, #to_h

Constructor Details

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

Returns a new instance of SessionUpdateParams.



336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/stripe/params/checkout/session_update_params.rb', line 336

def initialize(
  collected_information: nil,
  expand: nil,
  line_items: nil,
  metadata: nil,
  shipping_options: nil
)
  @collected_information = collected_information
  @expand = expand
  @line_items = line_items
  @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_page or elements sessions.



314
315
316
 
# File 'lib/stripe/params/checkout/session_update_params.rb', line 314

def collected_information
  @collected_information
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



316
317
318
 
# File 'lib/stripe/params/checkout/session_update_params.rb', line 316

def expand
  @expand
end

#line_items ⇒ Object

A list of items the customer is purchasing.

When updating line items, you must retransmit the entire array of line items.

To retain an existing line item, specify its id.

To update an existing line item, specify its id along with the new values of the fields to update.

To add a new line item, specify one of price or price_data and quantity.

To remove an existing line item, omit the line item's ID from the retransmitted array.

To reorder a line item, specify it at the desired position in the retransmitted array.



330
331
332
 
# File 'lib/stripe/params/checkout/session_update_params.rb', line 330

def line_items
  @line_items
end

#metadata ⇒ Object

Set of key-value pairs 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.



332
333
334
 
# File 'lib/stripe/params/checkout/session_update_params.rb', line 332

def metadata
  @metadata
end

#shipping_options ⇒ Object

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



334
335
336
 
# File 'lib/stripe/params/checkout/session_update_params.rb', line 334

def shipping_options
  @shipping_options
end

Class Method Details

.field_encodings ⇒ Object 



350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/stripe/params/checkout/session_update_params.rb', line 350

def self.field_encodings
  @field_encodings = {
    line_items: {
      kind: :array,
      element: {
        kind: :object,
        fields: { price_data: { kind: :object, fields: { unit_amount_decimal: :decimal_string } } },
      },
    },
  }
end