Class: Stripe::Invoice::CreateParams::ShippingCost::ShippingRateData

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/resources/invoice.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.



1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
 
# File 'lib/stripe/resources/invoice.rb', line 1466

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.



1452
1453
1454
 
# File 'lib/stripe/resources/invoice.rb', line 1452

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.



1454
1455
1456
 
# File 'lib/stripe/resources/invoice.rb', line 1454

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



1456
1457
1458
 
# File 'lib/stripe/resources/invoice.rb', line 1456

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



1458
1459
1460
 
# File 'lib/stripe/resources/invoice.rb', line 1458

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



1460
1461
1462
 
# File 'lib/stripe/resources/invoice.rb', line 1460

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



1462
1463
1464
 
# File 'lib/stripe/resources/invoice.rb', line 1462

def tax_code
  @tax_code
end

#type ⇒ Object

The type of calculation to use on the shipping rate.



1464
1465
1466
 
# File 'lib/stripe/resources/invoice.rb', line 1464

def type
  @type
end