Class: Stripe::InvoiceItem

Inherits:
APIResource show all
Extended by:
APIOperations::Create, APIOperations::List
Includes:
APIOperations::Delete, APIOperations::Save
Defined in:
lib/stripe/resources/invoice_item.rb

Overview

Invoice Items represent the component lines of an [invoice](stripe.com/docs/api/invoices). An invoice item is added to an invoice by creating or updating it with an ‘invoice` field, at which point it will be included as [an invoice line item](stripe.com/docs/api/invoices/line_item) within [invoice.lines](stripe.com/docs/api/invoices/object#invoice_object-lines).

Invoice Items can be created before you are ready to actually send the invoice. This can be particularly useful when combined with a [subscription](stripe.com/docs/api/subscriptions). Sometimes you want to add a charge or credit to a customer, but actually charge or credit the customer’s card only at the end of a regular billing cycle. This is useful for combining several charges (to minimize per-transaction fees), or for having Stripe tabulate your usage-based billing totals.

Related guides: [Integrate with the Invoicing API](stripe.com/docs/invoicing/integration), [Subscription Invoices](stripe.com/docs/billing/invoices/subscription#adding-upcoming-invoice-items).

Defined Under Namespace

Classes: CreateParams, DeleteParams, ListParams, Parent, Period, Pricing, UpdateParams

Constant Summary collapse

OBJECT_NAME = 
"invoiceitem"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Instance Method Summary collapse

Methods included from APIOperations::Create

create

Methods included from APIOperations::List

list

Methods included from APIOperations::Save

included, #save

Methods included from APIOperations::Delete

included

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Instance Attribute Details

#amount ⇒ Object (readonly)

Amount (in the ‘currency` specified) of the invoice item. This should always be equal to `unit_amount * quantity`.



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

def amount
  @amount
end

#currency ⇒ Object (readonly)

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 (readonly)

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



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

def customer
  @customer
end

#date ⇒ Object (readonly)

Time at which the object was created. Measured in seconds since the Unix epoch.



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

def date
  @date
end

#deleted ⇒ Object (readonly)

Always true for a deleted object



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

def deleted
  @deleted
end

#description ⇒ Object (readonly)

An arbitrary string attached to the object. Often useful for displaying to users.



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

def description
  @description
end

#discountable ⇒ Object (readonly)

If true, discounts will apply to this invoice item. Always false for prorations.



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

def discountable
  @discountable
end

#discounts ⇒ Object (readonly)

The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use ‘expand[]=discounts` to expand each discount.



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

def discounts
  @discounts
end

#id ⇒ Object (readonly)

Unique identifier for the object.



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

def id
  @id
end

#invoice ⇒ Object (readonly)

The ID of the invoice this invoice item belongs to.



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

def invoice
  @invoice
end

#livemode ⇒ Object (readonly)

Has the value ‘true` if the object exists in live mode or the value `false` if the object exists in test mode.



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

def livemode
  @livemode
end

#metadata ⇒ Object (readonly)

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.



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

def metadata
  @metadata
end

#object ⇒ Object (readonly)

String representing the object’s type. Objects of the same type share the same value.



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

def object
  @object
end

#parent ⇒ Object (readonly)

The parent that generated this invoice item.



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

def parent
  @parent
end

#period ⇒ Object (readonly)

Attribute for field period



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

def period
  @period
end

#pricing ⇒ Object (readonly)

The pricing information of the invoice item.



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

def pricing
  @pricing
end

#proration ⇒ Object (readonly)

Whether the invoice item was created automatically as a proration adjustment when the customer switched plans.



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

def proration
  @proration
end

#quantity ⇒ Object (readonly)

Quantity of units for the invoice item. If the invoice item is a proration, the quantity of the subscription that the proration was computed for.



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

def quantity
  @quantity
end

#tax_rates ⇒ Object (readonly)

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.



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

def tax_rates
  @tax_rates
end

#test_clock ⇒ Object (readonly)

ID of the test clock this invoice item belongs to.



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

def test_clock
  @test_clock
end

Class Method Details

.create(params = {}, opts = {}) ⇒ Object

Creates an item to be added to a draft invoice (up to 250 items per invoice). If no invoice is specified, the item will be on the next invoice created for the customer specified.



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

def self.create(params = {}, opts = {})
  request_stripe_object(method: :post, path: "/v1/invoiceitems", params: params, opts: opts)
end

.delete(invoiceitem, params = {}, opts = {}) ⇒ Object

Deletes an invoice item, removing it from an invoice. Deleting invoice items is only possible when they’re not attached to invoices, or if it’s attached to a draft invoice.



432
433
434
435
436
437
438
439
 
# File 'lib/stripe/resources/invoice_item.rb', line 432

def self.delete(invoiceitem, params = {}, opts = {})
  request_stripe_object(
    method: :delete,
    path: format("/v1/invoiceitems/%<invoiceitem>s", { invoiceitem: CGI.escape(invoiceitem) }),
    params: params,
    opts: opts
  )
end

.list(params = {}, opts = {}) ⇒ Object

Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recently created invoice items appearing first.



452
453
454
 
# File 'lib/stripe/resources/invoice_item.rb', line 452

def self.list(params = {}, opts = {})
  request_stripe_object(method: :get, path: "/v1/invoiceitems", params: params, opts: opts)
end

.object_name ⇒ Object 



23
24
25
 
# File 'lib/stripe/resources/invoice_item.rb', line 23

def self.object_name
  "invoiceitem"
end

.update(invoiceitem, params = {}, opts = {}) ⇒ Object

Updates the amount or description of an invoice item on an upcoming invoice. Updating an invoice item is only possible before the invoice it’s attached to is closed.



457
458
459
460
461
462
463
464
 
# File 'lib/stripe/resources/invoice_item.rb', line 457

def self.update(invoiceitem, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/invoiceitems/%<invoiceitem>s", { invoiceitem: CGI.escape(invoiceitem) }),
    params: params,
    opts: opts
  )
end

Instance Method Details

#delete(params = {}, opts = {}) ⇒ Object

Deletes an invoice item, removing it from an invoice. Deleting invoice items is only possible when they’re not attached to invoices, or if it’s attached to a draft invoice.



442
443
444
445
446
447
448
449
 
# File 'lib/stripe/resources/invoice_item.rb', line 442

def delete(params = {}, opts = {})
  request_stripe_object(
    method: :delete,
    path: format("/v1/invoiceitems/%<invoiceitem>s", { invoiceitem: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end