Schema2020-08-27object

item

A line item.

Source: openapi/spec3.json
Commit: d70de345383d
Active snapshot: da69df7e6e11

LineItem

object

A line item.

amount_subtotal integer

required

Total before any discounts or taxes are applied.

amount_total integer

required

Total after discounts and taxes.

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

required

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

maxLength:5000

discounts array

optional

The discounts applied to the line item.

id string

required

Unique identifier for the object.

maxLength:5000

object string

required

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

Allowed: "item"

price

optionalnullable

The price used to generate the line item.

quantity integer

optionalnullable

The quantity of products being purchased.

taxes array

optional

The taxes applied to the line item.

Root JSON Schema

{"description":"A line item.","properties":{"amount_subtotal":{"description":"Total before any discounts or taxes are applied.","type":"integer"},"amount_total":{"description":"Total after discounts and taxes.","type":"integer"},"currency":{"description":"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).","type":"string"},"description":{"description":"An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name.","maxLength":5000,"type":"string"},"discounts":{"description":"The discounts applied to the line item.","items":{"$ref":"#/components/schemas/line_items_discount_amount"},"type":"array"},"id":{"description":"Unique identifier for the object.","maxLength":5000,"type":"string"},"object":{"description":"String representing the object's type. Objects of the same type share the same value.","enum":["item"],"type":"string"},"price":{"anyOf":[{"$ref":"#/components/schemas/price"}],"description":"The price used to generate the line item.","nullable":true},"quantity":{"description":"The quantity of products being purchased.","nullable":true,"type":"integer"},"taxes":{"description":"The taxes applied to the line item.","items":{"$ref":"#/components/schemas/line_items_tax_amount"},"type":"array"}},"required":["amount_subtotal","amount_total","currency","description","id","object"],"title":"LineItem","type":"object","x-expandableFields":["discounts","price","taxes"],"x-resourceId":"item"}