Class: Stripe::OrderService::UpdateParams::LineItem

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/services/order_service.rb

Defined Under Namespace

Classes: Discount, PriceData, ProductData

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(description: nil, discounts: nil, id: nil, price: nil, price_data: nil, product: nil, product_data: nil, quantity: nil, tax_rates: nil) ⇒ LineItem

Returns a new instance of LineItem.



1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
 
# File 'lib/stripe/services/order_service.rb', line 1321

def initialize(
  description: nil,
  discounts: nil,
  id: nil,
  price: nil,
  price_data: nil,
  product: nil,
  product_data: nil,
  quantity: nil,
  tax_rates: nil
)
  @description = description
  @discounts = discounts
  @id = id
  @price = price
  @price_data = price_data
  @product = product
  @product_data = product_data
  @quantity = quantity
  @tax_rates = tax_rates
end

Instance Attribute Details

#description ⇒ Object

The description for the line item. Will default to the name of the associated product.



1291
1292
1293
 
# File 'lib/stripe/services/order_service.rb', line 1291

def description
  @description
end

#discounts ⇒ Object

The discounts applied to this line item.



1293
1294
1295
 
# File 'lib/stripe/services/order_service.rb', line 1293

def discounts
  @discounts
end

#id ⇒ Object

The ID of an existing line item on the order.



1295
1296
1297
 
# File 'lib/stripe/services/order_service.rb', line 1295

def id
  @id
end

#price ⇒ Object

The ID of a [Price](stripe.com/docs/api/prices) to add to the Order.

The ‘price` parameter is an alternative to using the `product` parameter. If each of your products are sold at a single price, you can set `Product.default_price` and then pass the `product` parameter when creating a line item. If your products are sold at several possible prices, use the `price` parameter to explicitly specify which one to use.



1299
1300
1301
 
# File 'lib/stripe/services/order_service.rb', line 1299

def price
  @price
end

#price_data ⇒ Object

Data used to generate a new Price object inline.

The ‘price_data` parameter is an alternative to using the `product` or `price` parameters. If you create products upfront and configure a `Product.default_price`, pass the `product` parameter when creating a line item. If you prefer not to define products upfront, or if you charge variable prices, pass the `price_data` parameter to describe the price for this line item.

Each time you pass ‘price_data` we create a Price for the product. This Price is hidden in both the Dashboard and API lists and cannot be reused.



1305
1306
1307
 
# File 'lib/stripe/services/order_service.rb', line 1305

def price_data
  @price_data
end

#product ⇒ Object

The ID of a [Product](stripe.com/docs/api/products) to add to the Order.

The product must have a ‘default_price` specified. Otherwise, specify the price by passing the `price` or `price_data` parameter.



1309
1310
1311
 
# File 'lib/stripe/services/order_service.rb', line 1309

def product
  @product
end

#product_data ⇒ Object

Defines a Product inline and adds it to the Order.

‘product_data` is an alternative to the `product` parameter. If you created a Product upfront, use the `product` parameter to refer to the existing Product. But if you prefer not to create Products upfront, pass the `product_data` parameter to define a Product inline as part of configuring the Order.

‘product_data` automatically creates a Product, just as if you had manually created the Product. If a Product with the same ID already exists, then `product_data` re-uses it to avoid duplicates.



1315
1316
1317
 
# File 'lib/stripe/services/order_service.rb', line 1315

def product_data
  @product_data
end

#quantity ⇒ Object

The quantity of the line item.



1317
1318
1319
 
# File 'lib/stripe/services/order_service.rb', line 1317

def quantity
  @quantity
end

#tax_rates ⇒ Object

The tax rates applied to this line item.



1319
1320
1321
 
# File 'lib/stripe/services/order_service.rb', line 1319

def tax_rates
  @tax_rates
end