Skip to main content
GET
List orders

Overview

Retrieve a paginated list of orders with optional filtering and sorting. Orders represent subscription checkout transactions—each order contains customer information, line items with products and pricing, and fulfillment status.

Common Use Cases

Dashboard Integration

Build custom dashboards showing recent orders, fulfillment queues, or revenue reports

Order Management

Display order lists for your operations team to process and fulfill

Customer Portal

Show customers their order history in your customer-facing application

Sync & Export

Sync orders to external systems like ERPs, accounting software, or data warehouses

Filtering Orders

Filter orders by status to power different views in your application:

Sorting Options

Pagination

Results are paginated using cursor-based pagination. See Pagination for details.

Response Fields

Key fields in each order object:

Authorizations

Authorization
string
header
required

API key obtained from FlexPortal dashboard

Headers

Tenant-ID
string
required

Your tenant identifier

Query Parameters

limit
string

Items per page (default: 50, max: 100)

startAfter
string

Cursor for pagination

status
string

Filter by status (pending, confirmed, partial, fulfilled, cancelled)

customerId
string

Filter by customer ID

Response

200 - application/json

List of orders

orders
object[]
required
count
number
required
limit
number
required
hasMore
boolean
required
nextCursor
string | null
required