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](docs.stripe.com/api/invoices). When you create an invoice item with an ‘invoice` field, it is attached to the specified invoice and included as [an invoice line item](docs.stripe.com/api/invoices/line_item) within [invoice.lines](docs.stripe.com/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](docs.stripe.com/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](docs.stripe.com/invoicing/integration), [Subscription Invoices](docs.stripe.com/billing/invoices/subscription#adding-upcoming-invoice-items).

Defined Under Namespace

Classes: Parent, Period, Pricing, ProrationDetails

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

#==, #[], #[]=, #_get_inner_class_type, 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`.



250
251
252
 
# File 'lib/stripe/resources/invoice_item.rb', line 250

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



252
253
254
 
# File 'lib/stripe/resources/invoice_item.rb', line 252

def currency
  @currency
end

#customer ⇒ Object (readonly)

The ID of the customer to bill for this invoice item.



254
255
256
 
# File 'lib/stripe/resources/invoice_item.rb', line 254

def customer
  @customer
end

#customer_account ⇒ Object (readonly)

The ID of the account to bill for this invoice item.



256
257
258
 
# File 'lib/stripe/resources/invoice_item.rb', line 256

def 
  @customer_account
end

#date ⇒ Object (readonly)

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



258
259
260
 
# File 'lib/stripe/resources/invoice_item.rb', line 258

def date
  @date
end

#deleted ⇒ Object (readonly)

Always true for a deleted object



260
261
262
 
# File 'lib/stripe/resources/invoice_item.rb', line 260

def deleted
  @deleted
end

#description ⇒ Object (readonly)

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



262
263
264
 
# File 'lib/stripe/resources/invoice_item.rb', line 262

def description
  @description
end

#discountable ⇒ Object (readonly)

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



264
265
266
 
# File 'lib/stripe/resources/invoice_item.rb', line 264

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.



266
267
268
 
# File 'lib/stripe/resources/invoice_item.rb', line 266

def discounts
  @discounts
end

#frozen_fields ⇒ Object (readonly)

Array of field names that can’t be modified. Attempting to update a frozen field returns an error.



268
269
270
 
# File 'lib/stripe/resources/invoice_item.rb', line 268

def frozen_fields
  @frozen_fields
end

#id ⇒ Object (readonly)

Unique identifier for the object.



270
271
272
 
# File 'lib/stripe/resources/invoice_item.rb', line 270

def id
  @id
end

#invoice ⇒ Object (readonly)

The ID of the invoice this invoice item belongs to.



272
273
274
 
# File 'lib/stripe/resources/invoice_item.rb', line 272

def invoice
  @invoice
end

#livemode ⇒ Object (readonly)

If the object exists in live mode, the value is ‘true`. If the object exists in test mode, the value is `false`.



274
275
276
 
# File 'lib/stripe/resources/invoice_item.rb', line 274

def livemode
  @livemode
end

#margins ⇒ Object (readonly)

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



276
277
278
 
# File 'lib/stripe/resources/invoice_item.rb', line 276

def margins
  @margins
end

#metadata ⇒ Object (readonly)

Set of [key-value pairs](docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.



278
279
280
 
# File 'lib/stripe/resources/invoice_item.rb', line 278

def metadata
  @metadata
end

#net_amount ⇒ Object (readonly)

The amount after discounts, but before credits and taxes. This field is ‘null` for `discountable=true` items.



280
281
282
 
# File 'lib/stripe/resources/invoice_item.rb', line 280

def net_amount
  @net_amount
end

#object ⇒ Object (readonly)

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



282
283
284
 
# File 'lib/stripe/resources/invoice_item.rb', line 282

def object
  @object
end

#parent ⇒ Object (readonly)

The parent that generated this invoice item.



284
285
286
 
# File 'lib/stripe/resources/invoice_item.rb', line 284

def parent
  @parent
end

#period ⇒ Object (readonly)

Attribute for field period



286
287
288
 
# File 'lib/stripe/resources/invoice_item.rb', line 286

def period
  @period
end

#pricing ⇒ Object (readonly)

The pricing information of the invoice item.



288
289
290
 
# File 'lib/stripe/resources/invoice_item.rb', line 288

def pricing
  @pricing
end

#proration ⇒ Object (readonly)

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



290
291
292
 
# File 'lib/stripe/resources/invoice_item.rb', line 290

def proration
  @proration
end

#proration_details ⇒ Object (readonly)

Attribute for field proration_details



292
293
294
 
# File 'lib/stripe/resources/invoice_item.rb', line 292

def proration_details
  @proration_details
end

#quantity ⇒ Object (readonly)

Quantity of units for the invoice item in integer format, with any decimal precision truncated. For the item’s full-precision decimal quantity, use ‘quantity_decimal`. This field will be deprecated in favor of `quantity_decimal` in a future version. If the invoice item is a proration, the quantity of the subscription that the proration was computed for.



294
295
296
 
# File 'lib/stripe/resources/invoice_item.rb', line 294

def quantity
  @quantity
end

#quantity_decimal ⇒ Object (readonly)

Non-negative decimal with at most 12 decimal places. The quantity of units for the invoice item.



296
297
298
 
# File 'lib/stripe/resources/invoice_item.rb', line 296

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



298
299
300
 
# File 'lib/stripe/resources/invoice_item.rb', line 298

def tax_rates
  @tax_rates
end

#test_clock ⇒ Object (readonly)

ID of the test clock this invoice item belongs to.



300
301
302
 
# File 'lib/stripe/resources/invoice_item.rb', line 300

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.



303
304
305
 
# File 'lib/stripe/resources/invoice_item.rb', line 303

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.



308
309
310
311
312
313
314
315
 
# File 'lib/stripe/resources/invoice_item.rb', line 308

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

.field_encodings ⇒ Object 



355
356
357
358
359
360
 
# File 'lib/stripe/resources/invoice_item.rb', line 355

def self.field_encodings
  @field_encodings = {
    pricing: { kind: :object, fields: { unit_amount_decimal: :decimal_string } },
    quantity_decimal: :decimal_string,
  }
end

.field_remappings ⇒ Object 



351
352
353
 
# File 'lib/stripe/resources/invoice_item.rb', line 351

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



342
343
344
345
346
347
348
349
 
# File 'lib/stripe/resources/invoice_item.rb', line 342

def self.inner_class_types
  @inner_class_types = {
    parent: Parent,
    period: Period,
    pricing: Pricing,
    proration_details: ProrationDetails,
  }
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.



328
329
330
 
# File 'lib/stripe/resources/invoice_item.rb', line 328

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

.object_name ⇒ Object 



20
21
22
 
# File 'lib/stripe/resources/invoice_item.rb', line 20

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.



333
334
335
336
337
338
339
340
 
# File 'lib/stripe/resources/invoice_item.rb', line 333

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.



318
319
320
321
322
323
324
325
 
# File 'lib/stripe/resources/invoice_item.rb', line 318

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