Skip to main content
GET
List all Line Items

Authorizations

Authorization
string
header
required

Bearer Token necessary to use API

Path Parameters

order_id
string
required

The ID of the order

Query Parameters

page
integer

Pagination: Page number

Required range: x >= 1
limit
integer

Pagination: Limit number of items per page.

Required range: 1 <= x <= 100
expand
string[]

This endpoint supports expandable responses. For more, see the documentation page.

sort_by
enum<string>

Sorting by attribute. Default created_at

Available options:
created_at,
updated_at
sort_direction
enum<string>

Sorting by ASC or DESC direction. Default DESC

Available options:
ASC,
DESC
type
enum<string>[]

Filter by type. Supports multiple values separated by a comma.

Available options:
unit_type,
protection,
product,
security_deposit
created_after
string<date-time>

Filters results to created after (including given date) the given ISO 8601 timestamp (e.g., 2025-01-12T15:30:00Z).

created_before
string<date-time>

Filters results to created before (excluding given date) the given ISO 8601 timestamp (e.g., 2025-01-12T15:30:00Z).

updated_after
string<date-time>

Filters results to updated after (including given date) the given ISO 8601 timestamp (e.g., 2025-01-12T15:30:00Z).

updated_before
string<date-time>

Filters results to updated before (excluding given date) the given ISO 8601 timestamp (e.g., 2025-01-12T15:30:00Z).

Response

list of line items

List of Order Line Items

line_items
object[]
meta
object