Class: Stripe::Checkout::SessionCreateParams::ShippingOption

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/params/checkout/session_create_params.rb

Defined Under Namespace

Classes: ShippingRateData

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

attr_accessor, coerce_params, coerce_value, field_encodings, new, #to_h

Constructor Details

#initialize(shipping_rate: nil, shipping_rate_data: nil, tax_rates: nil) ⇒ ShippingOption

Returns a new instance of ShippingOption.



2768
2769
2770
2771
2772
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2768

def initialize(shipping_rate: nil, shipping_rate_data: nil, tax_rates: nil)
  @shipping_rate = shipping_rate
  @shipping_rate_data = shipping_rate_data
  @tax_rates = tax_rates
end

Instance Attribute Details

#shipping_rate ⇒ Object

The ID of the Shipping Rate to use for this shipping option.



2762
2763
2764
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2762

def shipping_rate
  @shipping_rate
end

#shipping_rate_data ⇒ Object

Parameters to be passed to Shipping Rate creation for this shipping option.



2764
2765
2766
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2764

def shipping_rate_data
  @shipping_rate_data
end

#tax_rates ⇒ Object

The tax rates that will be applied to this shipping option. This parameter is only supported for Checkout Sessions with ui_mode set to form or elements.



2766
2767
2768
 
# File 'lib/stripe/params/checkout/session_create_params.rb', line 2766

def tax_rates
  @tax_rates
end