Skip to main content
GET
/
v2
/
invoices
/
lineItems
List Line Items
curl --request GET \
  --url https://api.paygentic.io/v2/invoices/lineItems \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "id": "li_abc123",
      "subscriptionId": "sub_xyz789",
      "priceId": "price_fee_001",
      "invoiceId": null,
      "type": "fee",
      "status": "pending",
      "displayName": "Monthly Platform Fee",
      "description": null,
      "currency": "USD",
      "periodStart": "2024-01-01T00:00:00.000Z",
      "periodEnd": "2024-02-01T00:00:00.000Z",
      "invoiceAt": "2024-01-01T00:00:00.000Z",
      "calculatedAt": null,
      "quantity": "1",
      "unitPrice": "29.99",
      "meteredQuantity": null,
      "paymentTerm": "in_advance",
      "subtotal": "29.99",
      "total": "29.99",
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-01T00:00:00.000Z"
    }
  ],
  "totalCount": 1,
  "summary": {
    "feeSubtotal": "29.99",
    "meteredEstimatedSubtotal": "0.00",
    "currency": "USD"
  }
}

Authorizations

​
Authorization
string
header
required

API key authentication

Query Parameters

​
subscriptionId
string

Filter by subscription ID. At least one of subscriptionId or invoiceId must be provided. Unique identifier for a subscription

Pattern: ^sub_[a-zA-Z0-9]+$
​
status
enum<string>

Filter by line item status. 'pending' returns items not yet on an invoice, 'invoiced' returns items already assigned to an invoice. Omit to return both. Cannot be combined with invoiceId — when filtering by invoice ID all statuses are returned.

Available options:
pending,
invoiced
​
invoiceId
string

Filter by invoice ID. When provided without subscriptionId, returns all line items for that invoice. At least one of subscriptionId or invoiceId must be provided.

Pattern: ^inv_[a-zA-Z0-9]+$
​
limit
integer
default:100

Maximum number of line items to return

Required range: 1 <= x <= 1000
​
offset
integer
default:0

Number of line items to skip for pagination

Required range: 0 <= x <= 10000

Response

Paginated list of line items with summary

​
object
enum<string>
required

The object type

Available options:
list
​
data
object[]
required

Array of line items

​
totalCount
integer
required

Total number of matching line items

​
summary
object
required

Aggregate summary of line item amounts