Class: Stripe::Checkout::Session::UpdateParams::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.



3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
 
# File 'lib/stripe/resources/checkout/session.rb', line 3518

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.



3504
3505
3506
 
# File 'lib/stripe/resources/checkout/session.rb', line 3504

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.



3506
3507
3508
 
# File 'lib/stripe/resources/checkout/session.rb', line 3506

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



3508
3509
3510
 
# File 'lib/stripe/resources/checkout/session.rb', line 3508

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



3510
3511
3512
 
# File 'lib/stripe/resources/checkout/session.rb', line 3510

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



3512
3513
3514
 
# File 'lib/stripe/resources/checkout/session.rb', line 3512

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



3514
3515
3516
 
# File 'lib/stripe/resources/checkout/session.rb', line 3514

def tax_code
  @tax_code
end

#type ⇒ Object

The type of calculation to use on the shipping rate.



3516
3517
3518
 
# File 'lib/stripe/resources/checkout/session.rb', line 3516

def type
  @type
end