Class: Stripe::InvoiceItem::CreateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/resources/invoice_item.rb

Defined Under Namespace

Classes: Discount, Period, PriceData

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, margins: nil, metadata: nil, period: nil, price: nil, price_data: nil, quantity: nil, subscription: nil, tax_behavior: nil, tax_code: nil, tax_rates: nil, unit_amount: nil, unit_amount_decimal: nil) ⇒ CreateParams

Returns a new instance of CreateParams.



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'lib/stripe/resources/invoice_item.rb', line 444

def initialize(
  amount: nil,
  currency: nil,
  customer: nil,
  description: nil,
  discountable: nil,
  discounts: nil,
  expand: nil,
  invoice: nil,
  margins: nil,
  metadata: nil,
  period: nil,
  price: nil,
  price_data: nil,
  quantity: nil,
  subscription: nil,
  tax_behavior: nil,
  tax_code: nil,
  tax_rates: nil,
  unit_amount: nil,
  unit_amount_decimal: nil
)
  @amount = amount
  @currency = currency
  @customer = customer
  @description = description
  @discountable = discountable
  @discounts = discounts
  @expand = expand
  @invoice = invoice
  @margins = margins
  @metadata = metadata
  @period = period
  @price = price
  @price_data = price_data
  @quantity = quantity
  @subscription = subscription
  @tax_behavior = tax_behavior
  @tax_code = tax_code
  @tax_rates = tax_rates
  @unit_amount = unit_amount
  @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.



385
386
387
 
# File 'lib/stripe/resources/invoice_item.rb', line 385

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



388
389
390
 
# File 'lib/stripe/resources/invoice_item.rb', line 388

def currency
  @currency
end

#customer ⇒ Object

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



391
392
393
 
# File 'lib/stripe/resources/invoice_item.rb', line 391

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.



394
395
396
 
# File 'lib/stripe/resources/invoice_item.rb', line 394

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.



397
398
399
 
# File 'lib/stripe/resources/invoice_item.rb', line 397

def discountable
  @discountable
end

#discounts ⇒ Object

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



400
401
402
 
# File 'lib/stripe/resources/invoice_item.rb', line 400

def discounts
  @discounts
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



403
404
405
 
# File 'lib/stripe/resources/invoice_item.rb', line 403

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.



406
407
408
 
# File 'lib/stripe/resources/invoice_item.rb', line 406

def invoice
  @invoice
end

#margins ⇒ Object

The ids of the margins to apply to the invoice item. When set, the ‘default_margins` on the invoice do not apply to this invoice item.



409
410
411
 
# File 'lib/stripe/resources/invoice_item.rb', line 409

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



412
413
414
 
# File 'lib/stripe/resources/invoice_item.rb', line 412

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.



415
416
417
 
# File 'lib/stripe/resources/invoice_item.rb', line 415

def period
  @period
end

#price ⇒ Object

The ID of the price object. One of ‘price` or `price_data` is required.



418
419
420
 
# File 'lib/stripe/resources/invoice_item.rb', line 418

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.



421
422
423
 
# File 'lib/stripe/resources/invoice_item.rb', line 421

def price_data
  @price_data
end

#quantity ⇒ Object

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



424
425
426
 
# File 'lib/stripe/resources/invoice_item.rb', line 424

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.



427
428
429
 
# File 'lib/stripe/resources/invoice_item.rb', line 427

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.



430
431
432
 
# File 'lib/stripe/resources/invoice_item.rb', line 430

def tax_behavior
  @tax_behavior
end

#tax_code ⇒ Object

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



433
434
435
 
# File 'lib/stripe/resources/invoice_item.rb', line 433

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.



436
437
438
 
# File 'lib/stripe/resources/invoice_item.rb', line 436

def tax_rates
  @tax_rates
end

#unit_amount ⇒ Object

The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This ‘unit_amount` will be multiplied by the quantity to get the full amount. Passing in a negative `unit_amount` will reduce the `amount_due` on the invoice.



439
440
441
 
# File 'lib/stripe/resources/invoice_item.rb', line 439

def unit_amount
  @unit_amount
end

#unit_amount_decimal ⇒ Object

Same as ‘unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.



442
443
444
 
# File 'lib/stripe/resources/invoice_item.rb', line 442

def unit_amount_decimal
  @unit_amount_decimal
end