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

#==, #[], #[]=, #_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)

The amount, in cents (or local equivalent).



599
600
601
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 599

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



601
602
603
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 601

def currency
  @currency
end

#description ⇒ Object (readonly)

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



603
604
605
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 603

def description
  @description
end

#discount_amounts ⇒ Object (readonly)

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



605
606
607
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 605

def discount_amounts
  @discount_amounts
end

#discountable ⇒ Object (readonly)

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



607
608
609
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 607

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.



609
610
611
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 609

def discounts
  @discounts
end

#id ⇒ Object (readonly)

Unique identifier for the object.



611
612
613
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 611

def id
  @id
end

#invoice ⇒ Object (readonly)

The ID of the invoice that contains this line item.



613
614
615
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 613

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.



615
616
617
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 615

def livemode
  @livemode
end

#margin_amounts ⇒ Object (readonly)

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



617
618
619
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 617

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.



619
620
621
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 619

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.



621
622
623
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 621

def metadata
  @metadata
end

#object ⇒ Object (readonly)

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



623
624
625
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 623

def object
  @object
end

#parent ⇒ Object (readonly)

The parent that generated this line item.



625
626
627
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 625

def parent
  @parent
end

#period ⇒ Object (readonly)

Attribute for field period



627
628
629
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 627

def period
  @period
end

#pretax_credit_amounts ⇒ Object (readonly)

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



629
630
631
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 629

def pretax_credit_amounts
  @pretax_credit_amounts
end

#pricing ⇒ Object (readonly)

The pricing information of the line item.



631
632
633
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 631

def pricing
  @pricing
end

#quantity ⇒ Object (readonly)

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



633
634
635
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 633

def quantity
  @quantity
end

#subscription ⇒ Object (readonly)

Attribute for field subscription



635
636
637
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 635

def subscription
  @subscription
end

#tax_calculation_reference ⇒ Object (readonly)

The tax calculation identifiers of the line item.



637
638
639
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 637

def tax_calculation_reference
  @tax_calculation_reference
end

#taxes ⇒ Object (readonly)

The tax information of the line item.



639
640
641
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 639

def taxes
  @taxes
end

Class Method Details

.field_remappings ⇒ Object 



667
668
669
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 667

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



654
655
656
657
658
659
660
661
662
663
664
665
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 654

def self.inner_class_types
  @inner_class_types = {
    discount_amounts: DiscountAmount,
    margin_amounts: MarginAmount,
    parent: Parent,
    period: Period,
    pretax_credit_amounts: PretaxCreditAmount,
    pricing: Pricing,
    tax_calculation_reference: TaxCalculationReference,
    taxes: Tax,
  }
end

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



645
646
647
648
649
650
651
652
 
# File 'lib/stripe/resources/invoice_line_item.rb', line 645

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