Class: Stripe::InvoiceService::CreatePreviewParams::InvoiceItem

Inherits:
RequestParams
  • Object
show all
Defined in:
lib/stripe/services/invoice_service.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.



2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
 
# File 'lib/stripe/services/invoice_service.rb', line 2371

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.



2339
2340
2341
 
# File 'lib/stripe/services/invoice_service.rb', line 2339

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.



2341
2342
2343
 
# File 'lib/stripe/services/invoice_service.rb', line 2341

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.



2343
2344
2345
 
# File 'lib/stripe/services/invoice_service.rb', line 2343

def description
  @description
end

#discountable ⇒ Object

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



2345
2346
2347
 
# File 'lib/stripe/services/invoice_service.rb', line 2345

def discountable
  @discountable
end

#discounts ⇒ Object

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



2347
2348
2349
 
# File 'lib/stripe/services/invoice_service.rb', line 2347

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.



2349
2350
2351
 
# File 'lib/stripe/services/invoice_service.rb', line 2349

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



2351
2352
2353
 
# File 'lib/stripe/services/invoice_service.rb', line 2351

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.



2353
2354
2355
 
# File 'lib/stripe/services/invoice_service.rb', line 2353

def period
  @period
end

#price ⇒ Object

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



2355
2356
2357
 
# File 'lib/stripe/services/invoice_service.rb', line 2355

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.



2357
2358
2359
 
# File 'lib/stripe/services/invoice_service.rb', line 2357

def price_data
  @price_data
end

#quantity ⇒ Object

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



2359
2360
2361
 
# File 'lib/stripe/services/invoice_service.rb', line 2359

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.



2361
2362
2363
 
# File 'lib/stripe/services/invoice_service.rb', line 2361

def tax_behavior
  @tax_behavior
end

#tax_code ⇒ Object

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



2363
2364
2365
 
# File 'lib/stripe/services/invoice_service.rb', line 2363

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.



2365
2366
2367
 
# File 'lib/stripe/services/invoice_service.rb', line 2365

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.



2367
2368
2369
 
# File 'lib/stripe/services/invoice_service.rb', line 2367

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.



2369
2370
2371
 
# File 'lib/stripe/services/invoice_service.rb', line 2369

def unit_amount_decimal
  @unit_amount_decimal
end