Skip to main content
Schema2020-08-27object

line_item

Source
openapi/spec3.json
Commit
d70de345383d
Active snapshot
da69df7e6e11

InvoiceLineItem

object
amount integer
required

The amount, in %s.

currency string
required

Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).

description string
optionalnullable

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

discount_amounts array
optionalnullable

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

discountable boolean
required

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

discounts array
optionalnullable

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

id string
required

Unique identifier for the object.

invoice_item string
optional

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

livemode boolean
required

Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

metadata object
required

Set of [key-value pairs](https://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` this will reflect the metadata of the subscription that caused the line item to be created.

object string
required

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

price
optionalnullable

The price of the line item.

proration boolean
required

Whether this is a proration.

quantity integer
optionalnullable

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

subscription string
optionalnullable

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

subscription_item string
optional

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

tax_amounts array
optional

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

tax_rates array
optional

The tax rates which apply to the line item.

type string
required

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