Class: Stripe::InvoiceItemService::CreateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/services/invoice_item_service.rb

Defined Under Namespace

Classes: Discount, Period, PriceData, Pricing

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(amount: nil, currency: nil, customer: nil, description: nil, discountable: nil, discounts: nil, expand: nil, invoice: nil, metadata: nil, period: nil, price_data: nil, pricing: nil, quantity: nil, subscription: nil, tax_behavior: nil, tax_code: nil, tax_rates: nil, unit_amount_decimal: nil) ⇒ CreateParams

Returns a new instance of CreateParams.



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/stripe/services/invoice_item_service.rb', line 299

def initialize(
  amount: nil,
  currency: nil,
  customer: nil,
  description: nil,
  discountable: nil,
  discounts: nil,
  expand: nil,
  invoice: nil,
  metadata: nil,
  period: nil,
  price_data: nil,
  pricing: nil,
  quantity: nil,
  subscription: nil,
  tax_behavior: nil,
  tax_code: nil,
  tax_rates: nil,
  unit_amount_decimal: nil
)
  @amount = amount
  @currency = currency
  @customer = customer
  @description = description
  @discountable = discountable
  @discounts = discounts
  @expand = expand
  @invoice = invoice
  @metadata = metadata
  @period = period
  @price_data = price_data
  @pricing = pricing
  @quantity = quantity
  @subscription = subscription
  @tax_behavior = tax_behavior
  @tax_code = tax_code
  @tax_rates = tax_rates
  @unit_amount_decimal = unit_amount_decimal
end

Instance Attribute Details

#amount ⇒ Object

The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. Passing in a negative ‘amount` will reduce the `amount_due` on the invoice.



263
264
265
 
# File 'lib/stripe/services/invoice_item_service.rb', line 263

def amount
  @amount
end

#currency ⇒ Object

Three-letter [ISO currency code](www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](stripe.com/docs/currencies).



265
266
267
 
# File 'lib/stripe/services/invoice_item_service.rb', line 265

def currency
  @currency
end

#customer ⇒ Object

The ID of the customer who will be billed when this invoice item is billed.



267
268
269
 
# File 'lib/stripe/services/invoice_item_service.rb', line 267

def customer
  @customer
end

#description ⇒ Object

An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.



269
270
271
 
# File 'lib/stripe/services/invoice_item_service.rb', line 269

def description
  @description
end

#discountable ⇒ Object

Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items.



271
272
273
 
# File 'lib/stripe/services/invoice_item_service.rb', line 271

def discountable
  @discountable
end

#discounts ⇒ Object

The coupons and promotion codes to redeem into discounts for the invoice item or invoice line item.



273
274
275
 
# File 'lib/stripe/services/invoice_item_service.rb', line 273

def discounts
  @discounts
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



275
276
277
 
# File 'lib/stripe/services/invoice_item_service.rb', line 275

def expand
  @expand
end

#invoice ⇒ Object

The ID of an existing invoice to add this invoice item to. When left blank, the invoice item will be added to the next upcoming scheduled invoice. This is useful when adding invoice items in response to an invoice.created webhook. You can only add invoice items to draft invoices and there is a maximum of 250 items per invoice.



277
278
279
 
# File 'lib/stripe/services/invoice_item_service.rb', line 277

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



279
280
281
 
# File 'lib/stripe/services/invoice_item_service.rb', line 279

def metadata
  @metadata
end

#period ⇒ Object

The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.



281
282
283
 
# File 'lib/stripe/services/invoice_item_service.rb', line 281

def period
  @period
end

#price_data ⇒ Object

Data used to generate a new [Price](stripe.com/docs/api/prices) object inline.



283
284
285
 
# File 'lib/stripe/services/invoice_item_service.rb', line 283

def price_data
  @price_data
end

#pricing ⇒ Object

The pricing information for the invoice item.



285
286
287
 
# File 'lib/stripe/services/invoice_item_service.rb', line 285

def pricing
  @pricing
end

#quantity ⇒ Object

Non-negative integer. The quantity of units for the invoice item.



287
288
289
 
# File 'lib/stripe/services/invoice_item_service.rb', line 287

def quantity
  @quantity
end

#subscription ⇒ Object

The ID of a subscription to add this invoice item to. When left blank, the invoice item is added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription.



289
290
291
 
# File 'lib/stripe/services/invoice_item_service.rb', line 289

def subscription
  @subscription
end

#tax_behavior ⇒ Object

Only required if a [default tax behavior](stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of ‘inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.



291
292
293
 
# File 'lib/stripe/services/invoice_item_service.rb', line 291

def tax_behavior
  @tax_behavior
end

#tax_code ⇒ Object

A [tax code](stripe.com/docs/tax/tax-categories) ID.



293
294
295
 
# File 'lib/stripe/services/invoice_item_service.rb', line 293

def tax_code
  @tax_code
end

#tax_rates ⇒ Object

The tax rates which apply to the invoice item. When set, the ‘default_tax_rates` on the invoice do not apply to this invoice item.



295
296
297
 
# File 'lib/stripe/services/invoice_item_service.rb', line 295

def tax_rates
  @tax_rates
end

#unit_amount_decimal ⇒ Object

The decimal unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This ‘unit_amount_decimal` will be multiplied by the quantity to get the full amount. Passing in a negative `unit_amount_decimal` will reduce the `amount_due` on the invoice. Accepts at most 12 decimal places.



297
298
299
 
# File 'lib/stripe/services/invoice_item_service.rb', line 297

def unit_amount_decimal
  @unit_amount_decimal
end