Line Items

https://api.payload.com/line_items

Nested Objects

https://api.payload.com/line_items/{id}/invoice

https://api.payload.com/line_items/{id}/transaction

Example

{
  "id": "item_1wOqeH7ccXXVoLnPJ6uh5ZT4C",
  "object": "line_item",
  "amount": 8.63,
  "amount_type": "percentage",
  "attrs": {},
  "created_at": "2024-08-21 13:35:03",
  "description": "string",
  "entry_type": "charge",
  "incurred_date": "2024-08-21",
  "invoice_id": "inv_15dZjgUMbEWMIfw4ECxPKlEck",
  "line_number": 609,
  "modified_at": "2024-08-21 13:35:03",
  "qty": 468.95,
  "total": 509.0,
  "transaction_id": "txn_t9LEG1A8syOjBYR7TjYMc7TV",
  "type": "string"
}

Attributes	Description
`id` string readonly	Object ID
`object` string readonly	Value: line_item
`amount` number required	Amount of line item
`amount_type` string	Values: percentage number
`attrs` json	Custom object attributes
`created_at` datetime readonly	None
`description` string	Description of invoice item
`entry_type` string required	Values: charge payment
`incurred_date` date	Date the item was incurred
`invoice_id` id required	ID of the associated Invoice object
`line_number` int	Determines the order the line item shows on the invoice
`modified_at` datetime readonly	None
`qty` number	Quantity of item
`total` number readonly	Total amount of line item
`transaction_id` id	ID of the associated Transaction
`type` string	Arbitrary type classification