Endpoint
GET /api/v1/orders
Returns a paginated list of orders placed by the authenticated client. Each order includes a list of line items showing what was purchased.
Query Parameters
| Parameter | Type | Description |
|---|---|---|
status |
string | Filter by status: pending, active, fraud, cancelled |
page |
integer | Page number (default: 1) |
per_page |
integer | Results per page (default: 15, max: 100) |
Request Examples
List all orders:
curl "https://billing.example.com/api/v1/orders" \
-H "Authorization: Bearer {your-token}"
List completed (active) orders only:
curl "https://billing.example.com/api/v1/orders?status=active" \
-H "Authorization: Bearer {your-token}"
Response
{
"data": [
{
"id": 88,
"order_number": "ORD-0088",
"status": "active",
"total": 2200,
"currency_code": "USD",
"created_at": "2026-04-01T09:15:00Z",
"items": [
{
"product_name": "Starter Hosting Plan",
"qty": 1,
"amount": 2000
},
{
"product_name": "Domain Registration — .com",
"qty": 1,
"amount": 1200
}
]
},
{
"id": 91,
"order_number": "ORD-0091",
"status": "pending",
"total": 500,
"currency_code": "USD",
"created_at": "2026-04-10T14:22:00Z",
"items": [
{
"product_name": "Business Email Add-on",
"qty": 1,
"amount": 500
}
]
}
],
"meta": {
"current_page": 1,
"last_page": 1,
"per_page": 15,
"total": 2
}
}
Response Fields — Order Object
| Field | Type | Description |
|---|---|---|
id |
integer | Unique order ID |
order_number |
string | Human-readable order reference |
status |
string | Order status (see below) |
total |
integer | Order total in the smallest currency unit |
currency_code |
string | Three-letter ISO currency code |
created_at |
string | ISO 8601 timestamp when the order was placed |
items |
array | Line items included in the order |
Response Fields — Item Object
| Field | Type | Description |
|---|---|---|
product_name |
string | Name of the product or add-on ordered |
qty |
integer | Quantity ordered |
amount |
integer | Unit price in the smallest currency unit |
Order Status Values
| Status | Meaning |
|---|---|
pending |
Order received, awaiting payment or review |
active |
Order completed and services are active |
fraud |
Order was flagged and blocked |
cancelled |
Order was cancelled before completion |
[!IMPORTANT] Placing new orders via the API is not supported. Orders must be placed through the client portal checkout flow. This endpoint is read-only.
[!TIP] Use the
itemsarray to show a client a full breakdown of what they purchased in each order, without needing a separate request per item.