Class: Stripe::InvoiceLineItem

Inherits:
APIResource show all
Includes:
APIOperations::Save
Defined in:
lib/stripe/resources/invoice_line_item.rb

Overview

Invoice Line Items represent the individual lines within an [invoice](stripe.com/docs/api/invoices) and only exist within the context of an invoice.

Each line item is backed by either an [invoice item](stripe.com/docs/api/invoiceitems) or a [subscription item](stripe.com/docs/api/subscription_items).

Defined Under Namespace

Classes: DiscountAmount, MarginAmount, Period, PretaxCreditAmount, ProrationDetails, TaxAmount, UpdateParams

Constant Summary collapse

OBJECT_NAME = 
"line_item"

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

Methods included from APIOperations::Save

included, #save

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)

The amount, in cents (or local equivalent).



293
294
295
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 293

def amount
  @amount
end

#amount_excluding_tax ⇒ Object (readonly)

The integer amount in cents (or local equivalent) representing the amount for this line item, excluding all tax and discounts.



295
296
297
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 295

def amount_excluding_tax
  @amount_excluding_tax
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).



297
298
299
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 297

def currency
  @currency
end

#description ⇒ Object (readonly)

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



299
300
301
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 299

def description
  @description
end

#discount_amounts ⇒ Object (readonly)

The amount of discount calculated per discount for this line item.



301
302
303
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 301

def discount_amounts
  @discount_amounts
end

#discountable ⇒ Object (readonly)

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



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

def discountable
  @discountable
end

#discounts ⇒ Object (readonly)

The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use ‘expand[]=discounts` to expand each discount.



305
306
307
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 305

def discounts
  @discounts
end

#id ⇒ Object (readonly)

Unique identifier for the object.



307
308
309
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 307

def id
  @id
end

#invoice ⇒ Object (readonly)

The ID of the invoice that contains this line item.



309
310
311
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 309

def invoice
  @invoice
end

#invoice_item ⇒ Object (readonly)

The ID of the [invoice item](stripe.com/docs/api/invoiceitems) associated with this line item if any.



311
312
313
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 311

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



313
314
315
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 313

def livemode
  @livemode
end

#margin_amounts ⇒ Object (readonly)

The amount of margin calculated per margin for this line item.



315
316
317
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 315

def margin_amounts
  @margin_amounts
end

#margins ⇒ Object (readonly)

The margins applied to the line item. When set, the ‘default_margins` on the invoice do not apply to the line item. Use `expand[]=margins` to expand each margin.



317
318
319
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 317

def margins
  @margins
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. Note that for line items with ‘type=subscription`, `metadata` reflects the current metadata from the subscription associated with the line item, unless the invoice line was directly updated with different metadata after creation.



319
320
321
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 319

def metadata
  @metadata
end

#object ⇒ Object (readonly)

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



321
322
323
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 321

def object
  @object
end

#period ⇒ Object (readonly)

Attribute for field period



323
324
325
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 323

def period
  @period
end

#plan ⇒ Object (readonly)

The plan of the subscription, if the line item is a subscription or a proration.



325
326
327
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 325

def plan
  @plan
end

#pretax_credit_amounts ⇒ Object (readonly)

Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this line item.



327
328
329
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 327

def pretax_credit_amounts
  @pretax_credit_amounts
end

#price ⇒ Object (readonly)

The price of the line item.



329
330
331
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 329

def price
  @price
end

#proration ⇒ Object (readonly)

Whether this is a proration.



331
332
333
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 331

def proration
  @proration
end

#proration_details ⇒ Object (readonly)

Additional details for proration line items



333
334
335
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 333

def proration_details
  @proration_details
end

#quantity ⇒ Object (readonly)

The quantity of the subscription, if the line item is a subscription or a proration.



335
336
337
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 335

def quantity
  @quantity
end

#subscription ⇒ Object (readonly)

The subscription that the invoice item pertains to, if any.



337
338
339
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 337

def subscription
  @subscription
end

#subscription_item ⇒ Object (readonly)

The subscription item that generated this line item. Left empty if the line item is not an explicit result of a subscription.



339
340
341
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 339

def subscription_item
  @subscription_item
end

#tax_amounts ⇒ Object (readonly)

The amount of tax calculated per tax rate for this line item



341
342
343
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 341

def tax_amounts
  @tax_amounts
end

#tax_rates ⇒ Object (readonly)

The tax rates which apply to the line item.



343
344
345
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 343

def tax_rates
  @tax_rates
end

#type ⇒ Object (readonly)

A string identifying the type of the source of this line item, either an ‘invoiceitem` or a `subscription`.



345
346
347
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 345

def type
  @type
end

#unit_amount_excluding_tax ⇒ Object (readonly)

The amount in cents (or local equivalent) representing the unit amount for this line item, excluding all tax and discounts.



347
348
349
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 347

def unit_amount_excluding_tax
  @unit_amount_excluding_tax
end

Class Method Details

.object_name ⇒ Object 



12
13
14
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 12

def self.object_name
  "line_item"
end

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

Updates an invoice’s line item. Some fields, such as tax_amounts, only live on the invoice line item, so they can only be updated through this endpoint. Other fields, such as amount, live on both the invoice item and the invoice line item, so updates on this endpoint will propagate to the invoice item as well. Updating an invoice’s line item is only possible before the invoice is finalized.



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

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