Invoice Line Items

An invoice line item refers to any service or product added to an invoice, along with any quantities or unit amounts that pertain to them. An invoice can have many line items.

Attribute

Description

id string

Unique identifier for the invoice line item.

name
string

Name of the line item, typically a product or SKU name.

description
string

An optional free-form description of the line item.

direction
string

Either debit or credit. debit indicates that a client owes the business money and increases the invoice's total_amount due. credit has the opposite intention and effect.

amount
int32

The total amount for this line item, specified in the invoice currency's smallest unit.

quantity
int32

The number of units of a product or service that this line item is for. Must be a whole number. Defaults to 1 if not provided.

unit_amount
int32

The cost per unit of the product or service that this line item is for specified in the invoice currency's smallest unit.

unit_amount_decimal
string

The cost per unit of the product or service that this line item is for, specified in the invoice currency's smallest unit. Accepts decimal strings with up to 12 decimals.

metadata
object

Additional data represented as key-value pairs. Both the key and value must be strings. See Metadata .

{
  "id": "2d3ed5fb-8bca-4d12-bfb8-3d314cb9887d",
  "object": "invoice_line_item",
  "live_mode": true,
  "amount": 72000,
  "description": "1 year subscription to this service",
  "direction": "debit",
  "name": "Service Monthly Subscription",
  "quantity": 12,
  "unit_amount": 6000,
  "created_at": "2023-01-23T20:56:19Z",
  "updated_at": "2023-01-23T20:56:19Z"
}