Class: Stripe::OrderCreateParams::LineItem

Inherits:
RequestParams show all
Defined in:
lib/stripe/params/order_create_params.rb

Defined Under Namespace

Classes: Discount, PriceData, ProductData

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

attr_accessor, coerce_params, coerce_value, new, #to_h

Constructor Details

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

Returns a new instance of LineItem.



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/stripe/params/order_create_params.rb', line 214

def initialize(
  description: nil,
  discounts: nil,
  price: nil,
  price_data: nil,
  product: nil,
  product_data: nil,
  quantity: nil,
  tax_rates: nil
)
  @description = description
  @discounts = discounts
  @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.



186
187
188
 
# File 'lib/stripe/params/order_create_params.rb', line 186

def description
  @description
end

#discounts ⇒ Object

The discounts applied to this line item.



188
189
190
 
# File 'lib/stripe/params/order_create_params.rb', line 188

def discounts
  @discounts
end

#price ⇒ Object

The ID of a [Price](docs.stripe.com/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.



192
193
194
 
# File 'lib/stripe/params/order_create_params.rb', line 192

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 a Product 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.



198
199
200
 
# File 'lib/stripe/params/order_create_params.rb', line 198

def price_data
  @price_data
end

#product ⇒ Object

The ID of a [Product](docs.stripe.com/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.



202
203
204
 
# File 'lib/stripe/params/order_create_params.rb', line 202

def product
  @product
end

#product_data ⇒ Object

Defines a [Product](docs.stripe.com/api/products) 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.



208
209
210
 
# File 'lib/stripe/params/order_create_params.rb', line 208

def product_data
  @product_data
end

#quantity ⇒ Object

The quantity of the line item.



210
211
212
 
# File 'lib/stripe/params/order_create_params.rb', line 210

def quantity
  @quantity
end

#tax_rates ⇒ Object

The tax rates applied to this line item.



212
213
214
 
# File 'lib/stripe/params/order_create_params.rb', line 212

def tax_rates
  @tax_rates
end

Class Method Details

.field_encodings ⇒ Object 



234
235
236
237
238
 
# File 'lib/stripe/params/order_create_params.rb', line 234

def self.field_encodings
  @field_encodings = {
    price_data: { kind: :object, fields: { unit_amount_decimal: :decimal_string } },
  }
end