Class: Stripe::Checkout::Session::CreateParams::LineItem

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/resources/checkout/session.rb

Defined Under Namespace

Classes: AdjustableQuantity, PriceData

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(adjustable_quantity: nil, dynamic_tax_rates: nil, metadata: nil, price: nil, price_data: nil, quantity: nil, tax_rates: nil) ⇒ LineItem

Returns a new instance of LineItem.



1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
 
# File 'lib/stripe/resources/checkout/session.rb', line 1835

def initialize(
  adjustable_quantity: nil,
  dynamic_tax_rates: nil,
  metadata: nil,
  price: nil,
  price_data: nil,
  quantity: nil,
  tax_rates: nil
)
  @adjustable_quantity = adjustable_quantity
  @dynamic_tax_rates = dynamic_tax_rates
  @metadata = metadata
  @price = price
  @price_data = price_data
  @quantity = quantity
  @tax_rates = tax_rates
end

Instance Attribute Details

#adjustable_quantity ⇒ Object

When set, provides configuration for this item’s quantity to be adjusted by the customer during Checkout.



1815
1816
1817
 
# File 'lib/stripe/resources/checkout/session.rb', line 1815

def adjustable_quantity
  @adjustable_quantity
end

#dynamic_tax_rates ⇒ Object

The [tax rates](stripe.com/docs/api/tax_rates) that will be applied to this line item depending on the customer’s billing/shipping address. We currently support the following countries: US, GB, AU, and all countries in the EU.



1818
1819
1820
 
# File 'lib/stripe/resources/checkout/session.rb', line 1818

def dynamic_tax_rates
  @dynamic_tax_rates
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`.



1821
1822
1823
 
# File 'lib/stripe/resources/checkout/session.rb', line 1821

def metadata
  @metadata
end

#price ⇒ Object

The ID of the [Price](stripe.com/docs/api/prices) or [Plan](stripe.com/docs/api/plans) object. One of ‘price` or `price_data` is required.



1824
1825
1826
 
# File 'lib/stripe/resources/checkout/session.rb', line 1824

def price
  @price
end

#price_data ⇒ Object

Data used to generate a new [Price](stripe.com/docs/api/prices) object inline. One of ‘price` or `price_data` is required.



1827
1828
1829
 
# File 'lib/stripe/resources/checkout/session.rb', line 1827

def price_data
  @price_data
end

#quantity ⇒ Object

The quantity of the line item being purchased. Quantity should not be defined when ‘recurring.usage_type=metered`.



1830
1831
1832
 
# File 'lib/stripe/resources/checkout/session.rb', line 1830

def quantity
  @quantity
end

#tax_rates ⇒ Object

The [tax rates](stripe.com/docs/api/tax_rates) which apply to this line item.



1833
1834
1835
 
# File 'lib/stripe/resources/checkout/session.rb', line 1833

def tax_rates
  @tax_rates
end