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, Parent, Period, PretaxCreditAmount, Pricing, Tax, 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).



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

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



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

def currency
  @currency
end

#description ⇒ Object (readonly)

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



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

def description
  @description
end

#discount_amounts ⇒ Object (readonly)

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



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

def discount_amounts
  @discount_amounts
end

#discountable ⇒ Object (readonly)

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



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

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.



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

def discounts
  @discounts
end

#id ⇒ Object (readonly)

Unique identifier for the object.



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

def id
  @id
end

#invoice ⇒ Object (readonly)

The ID of the invoice that contains this line item.



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

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.



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

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



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

def metadata
  @metadata
end

#object ⇒ Object (readonly)

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



350
351
352
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 350

def object
  @object
end

#parent ⇒ Object (readonly)

The parent that generated this invoice



352
353
354
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 352

def parent
  @parent
end

#period ⇒ Object (readonly)

Attribute for field period



354
355
356
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 354

def period
  @period
end

#pretax_credit_amounts ⇒ Object (readonly)

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



356
357
358
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 356

def pretax_credit_amounts
  @pretax_credit_amounts
end

#pricing ⇒ Object (readonly)

The pricing information of the line item.



358
359
360
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 358

def pricing
  @pricing
end

#quantity ⇒ Object (readonly)

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



360
361
362
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 360

def quantity
  @quantity
end

#subscription ⇒ Object (readonly)

Attribute for field subscription



362
363
364
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 362

def subscription
  @subscription
end

#taxes ⇒ Object (readonly)

The tax information of the line item.



364
365
366
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 364

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



370
371
372
373
374
375
376
377
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 370

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