BiasDocs

Line items

Line items are the individual products and charges on an invoice or checkout session. They’re set with line_items when you create or update either one.

The LineItem object

Name
object
Type
"line_item",
Description
The object's type.
Name
id
Type
string,
Description
Unique identifier for the object.
Name
live
Type
boolean,
Description
true if the object is live, or false if it's in a sandbox.
Name
created_at
Type
integer,
Description
When the object was created, in milliseconds since the Unix epoch.
Name
description
Type
string or null,
Description
The line item's description.
Name
discounts
Type
array of AppliedDiscounts or null,
Description
Expandable. Discounts on this line item only.
Name
name
Type
string or null,
Description
The name of a line item without a product.
Name
period
Type
object or null,
Description
The period a subscription line item bills for.
Properties
Name
price
Type
string or Price or null,
Description
Expandable. The price of a catalog line item.
Name
product
Type
string or Product or null,
Description
Expandable. The product this line item bills, if any.
Name
quantity
Type
number,
Description
The quantity of the line item.
Name
subscription_item
Type
string or null,
Description
The subscription item this line item bills, if any.
Name
subtotal
Type
integer,
Description
The amount after discounts, before tax, in cents.
Name
tax_amounts
Type
array of object,
Description
The tax charged on this line item, per tax, including the invoice's default taxes.
Properties
Name
taxes
Type
array of objects,
Description
The taxes applied to this line item.
Properties
Name
total
Type
integer,
Description
The amount after discounts and tax, in cents.
Name
type
Type
enum,
Description
How the line item is priced.
Properties
Name
unit_amount
Type
integer or null,
Description
The unit amount in cents when the line item was created.
Name
updated_at
Type
integer,
Description
When the object was last updated, in milliseconds since the Unix epoch.

The LineItem object

{
  "object": "line_item",
  "id": "li_rbw8iroSXBkFMZ8bisSxK",
  "live": false,
  "created_at": 1750000000000,
  "updated_at": 1750000000000,
  "type": "catalog",
  "quantity": 2,
  "name": null,
  "description": null,
  "unit_amount": 1000,
  "price": "price_dz1NVvl5CSogERkeA9Ng67",
  "product": "prod_KDCnId9DMZSOA9MSaut4Q",
  "discounts": [],
  "taxes": [],
  "tax_amounts": [],
  "subtotal": 2000,
  "total": 2000,
  "period": null,
  "subscription_item": null
}