Class: Stripe::Invoice::CreatePreviewParams::InvoiceItem

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/resources/invoice.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, description: nil, discountable: nil, discounts: nil, invoiceitem: nil, metadata: nil, period: nil, price: nil, price_data: nil, quantity: nil, tax_behavior: nil, tax_code: nil, tax_rates: nil, unit_amount: nil, unit_amount_decimal: nil) ⇒ InvoiceItem

Returns a new instance of InvoiceItem.



6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
 
# File 'lib/stripe/resources/invoice.rb', line 6514

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



6482
6483
6484
 
# File 'lib/stripe/resources/invoice.rb', line 6482

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). Only applicable to new invoice items.



6484
6485
6486
 
# File 'lib/stripe/resources/invoice.rb', line 6484

def currency
  @currency
end

#description ⇒ Object

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



6486
6487
6488
 
# File 'lib/stripe/resources/invoice.rb', line 6486

def description
  @description
end

#discountable ⇒ Object

Explicitly controls whether discounts apply to this invoice item. Defaults to true, except for negative invoice items.



6488
6489
6490
 
# File 'lib/stripe/resources/invoice.rb', line 6488

def discountable
  @discountable
end

#discounts ⇒ Object

The coupons to redeem into discounts for the invoice item in the preview.



6490
6491
6492
 
# File 'lib/stripe/resources/invoice.rb', line 6490

def discounts
  @discounts
end

#invoiceitem ⇒ Object

The ID of the invoice item to update in preview. If not specified, a new invoice item will be added to the preview of the upcoming invoice.



6492
6493
6494
 
# File 'lib/stripe/resources/invoice.rb', line 6492

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



6494
6495
6496
 
# File 'lib/stripe/resources/invoice.rb', line 6494

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.



6496
6497
6498
 
# File 'lib/stripe/resources/invoice.rb', line 6496

def period
  @period
end

#price ⇒ Object

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



6498
6499
6500
 
# File 'lib/stripe/resources/invoice.rb', line 6498

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.



6500
6501
6502
 
# File 'lib/stripe/resources/invoice.rb', line 6500

def price_data
  @price_data
end

#quantity ⇒ Object

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



6502
6503
6504
 
# File 'lib/stripe/resources/invoice.rb', line 6502

def quantity
  @quantity
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.



6504
6505
6506
 
# File 'lib/stripe/resources/invoice.rb', line 6504

def tax_behavior
  @tax_behavior
end

#tax_code ⇒ Object

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



6506
6507
6508
 
# File 'lib/stripe/resources/invoice.rb', line 6506

def tax_code
  @tax_code
end

#tax_rates ⇒ Object

The tax rates that apply to the item. When set, any ‘default_tax_rates` do not apply to this item.



6508
6509
6510
 
# File 'lib/stripe/resources/invoice.rb', line 6508

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. If you want to apply a credit to the customer’s account, pass a negative unit_amount.



6510
6511
6512
 
# File 'lib/stripe/resources/invoice.rb', line 6510

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.



6512
6513
6514
 
# File 'lib/stripe/resources/invoice.rb', line 6512

def unit_amount_decimal
  @unit_amount_decimal
end