Class: Stripe::Invoice::AddLinesParams::Line

Inherits:

RequestParams

• Object
• RequestParams
• Stripe::Invoice::AddLinesParams::Line

Defined in:

lib/stripe/resources/invoice.rb

Defined Under Namespace

Classes: Discount, Period, PriceData, Pricing, TaxAmount

Instance Attribute Summary

• #amount ⇒ Object

  The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice.

• #description ⇒ Object

  An arbitrary string which you can attach to the invoice item.

• #discountable ⇒ Object

  Controls whether discounts apply to this line item.

• #discounts ⇒ Object

  The coupons, promotion codes & existing discounts which apply to the line item.

• #invoice_item ⇒ Object

  ID of an unassigned invoice item to assign to this invoice.

• #metadata ⇒ Object

  Set of [key-value pairs](stripe.com/docs/api/metadata) that you can attach to an object.

• #period ⇒ Object

  The period associated with this invoice item.

• #price_data ⇒ Object

  Data used to generate a new [Price](stripe.com/docs/api/prices) object inline.

• #pricing ⇒ Object

  The pricing information for the invoice item.

• #quantity ⇒ Object

  Non-negative integer.

• #tax_amounts ⇒ Object

  A list of up to 10 tax amounts for this line item.

• #tax_rates ⇒ Object

  The tax rates which apply to the line item.

Instance Method Summary

• #initialize(amount: nil, description: nil, discountable: nil, discounts: nil, invoice_item: nil, metadata: nil, period: nil, price_data: nil, pricing: nil, quantity: nil, tax_amounts: nil, tax_rates: nil) ⇒ Line constructor

  A new instance of Line.

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(amount: nil, description: nil, discountable: nil, discounts: nil, invoice_item: nil, metadata: nil, period: nil, price_data: nil, pricing: nil, quantity: nil, tax_amounts: nil, tax_rates: nil) ⇒ Line

Returns a new instance of Line.

# File 'lib/stripe/resources/invoice.rb', line 1878

def initialize(
  amount: nil,
  description: nil,
  discountable: nil,
  discounts: nil,
  invoice_item: nil,
  metadata: nil,
  period: nil,
  price_data: nil,
  pricing: nil,
  quantity: nil,
  tax_amounts: nil,
  tax_rates: nil
)
  @amount = amount
  @description = description
  @discountable = discountable
  @discounts = discounts
  @invoice_item = invoice_item
  @metadata = metadata
  @period = period
  @price_data = price_data
  @pricing = pricing
  @quantity = quantity
  @tax_amounts = tax_amounts
  @tax_rates = tax_rates
end

Instance Attribute Details

#amount ⇒ Object

The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer’s account, pass a negative amount.

# File 'lib/stripe/resources/invoice.rb', line 1854

def amount
  @amount
end

#description ⇒ Object

An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.

# File 'lib/stripe/resources/invoice.rb', line 1856

def description
  @description
end

#discountable ⇒ Object

Controls whether discounts apply to this line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations.

# File 'lib/stripe/resources/invoice.rb', line 1858

def discountable
  @discountable
end

#discounts ⇒ Object

The coupons, promotion codes & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts.

# File 'lib/stripe/resources/invoice.rb', line 1860

def discounts
  @discounts
end

#invoice_item ⇒ Object

ID of an unassigned invoice item to assign to this invoice. If not provided, a new item will be created.

# File 'lib/stripe/resources/invoice.rb', line 1862

def invoice_item
  @invoice_item
end

#metadata ⇒ Object

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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to ‘metadata`.

# File 'lib/stripe/resources/invoice.rb', line 1864

def metadata
  @metadata
end

#period ⇒ Object

The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.

# File 'lib/stripe/resources/invoice.rb', line 1866

def period
  @period
end

#price_data ⇒ Object

Data used to generate a new [Price](stripe.com/docs/api/prices) object inline.

# File 'lib/stripe/resources/invoice.rb', line 1868

def price_data
  @price_data
end

#pricing ⇒ Object

The pricing information for the invoice item.

# File 'lib/stripe/resources/invoice.rb', line 1870

def pricing
  @pricing
end

#quantity ⇒ Object

Non-negative integer. The quantity of units for the line item.

# File 'lib/stripe/resources/invoice.rb', line 1872

def quantity
  @quantity
end

#tax_amounts ⇒ Object

A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](stripe.com/docs/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](stripe.com/docs/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](stripe.com/docs/tax/invoicing). Pass an empty string to remove previously defined tax amounts.

# File 'lib/stripe/resources/invoice.rb', line 1874

def tax_amounts
  @tax_amounts
end

#tax_rates ⇒ Object

The tax rates which apply to the line item. When set, the ‘default_tax_rates` on the invoice do not apply to this line item. Pass an empty string to remove previously-defined tax rates.

# File 'lib/stripe/resources/invoice.rb', line 1876

def tax_rates
  @tax_rates
end