Skip to main content
GET
List Line Items

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]+$
expand
string

Comma-separated list of fields to expand. Supports: items — resolves each returned line's item and that item's external accounting codes into an items collection, so a line can be translated to a GL/SKU code without a second call.

provider
string

Narrows which external references are returned per item when expand=items. Matched exactly against the provider stored on the reference (e.g. accountsiq); there is no allowlist of known providers, but the value must satisfy the same format every stored provider does, so a malformed one is rejected rather than answered with an empty result that reads as "nothing is mapped". It never removes lines or items: an item with no reference for this provider comes back with an empty list, so unmapped SKUs stay visible. Ignored when the items expansion is not requested. Lowercase snake_case provider identifier (e.g. salesforce, netsuite)

Maximum string length: 64
Pattern: ^[a-z][a-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

items
object[]

Items the returned lines were tagged with, each appearing once, ordered by id. Only present when expand=items is requested. Scoped to the lines in THIS response, not to any invoice as a whole — combine the collections across pages for a complete set. Join a line to its entry via the line's itemId. A line whose itemId has no entry here is a data-integrity fault — the tag points at an item that no longer resolves for this merchant. It is not the same as an untagged line and must not be counted as unmapped; report it.