Line Items

https://api.payload.co/line_items

Nested Objects

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

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

Example

{
  "id": "item_1LhJIl9IEVvoiMyOd9xu1WKSI",
  "object": "line_item",
  "amount": 441.22,
  "attrs": {},
  "created_at": "2022-02-02 21:11:49",
  "description": "string",
  "entry_type": "charge",
  "incurred_date": "2022-02-02",
  "invoice_id": "inv_28e36ZSy0NbeMrgTXckhGA95g",
  "modified_at": "2022-02-02 21:11:49",
  "qty": 379,
  "total": 393,
  "transaction_id": "txn_13xG5LhLxOwnpJcfuJlk8aJis",
  "type": "string"
}
Attributes Description
id
string readonly
Object ID
object
string readonly
Value: line_item
amount
number required
Amount of line item
attrs
json
Custom object attributes
created_at
datetime readonly
Timestamp object was created
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
modified_at
datetime readonly
Timestamp object was last updated
qty
int
Quantity of item
total
int readonly
Total amount of line item
transaction_id
id
ID of the associated Transaction
type
string
Arbitrary type classification