Class: Stripe::Checkout::Session::CreateParams::ShippingOption::ShippingRateData

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/resources/checkout/session.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, fixed_amount: nil, metadata: nil, tax_behavior: nil, tax_code: nil, type: nil) ⇒ ShippingRateData

Returns a new instance of ShippingRateData.



2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
 
# File 'lib/stripe/resources/checkout/session.rb', line 2956

def initialize(
  delivery_estimate: nil,
  display_name: nil,
  fixed_amount: nil,
  metadata: nil,
  tax_behavior: nil,
  tax_code: nil,
  type: nil
)
  @delivery_estimate = delivery_estimate
  @display_name = display_name
  @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.



2942
2943
2944
 
# File 'lib/stripe/resources/checkout/session.rb', line 2942

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.



2944
2945
2946
 
# File 'lib/stripe/resources/checkout/session.rb', line 2944

def display_name
  @display_name
end

#fixed_amount ⇒ Object

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



2946
2947
2948
 
# File 'lib/stripe/resources/checkout/session.rb', line 2946

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



2948
2949
2950
 
# File 'lib/stripe/resources/checkout/session.rb', line 2948

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



2950
2951
2952
 
# File 'lib/stripe/resources/checkout/session.rb', line 2950

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



2952
2953
2954
 
# File 'lib/stripe/resources/checkout/session.rb', line 2952

def tax_code
  @tax_code
end

#type ⇒ Object

The type of calculation to use on the shipping rate.



2954
2955
2956
 
# File 'lib/stripe/resources/checkout/session.rb', line 2954

def type
  @type
end