Manage Orders
List and retrieve details of your orders
Each order is exposed as a UserPlanResource. The resource is identified by a stable uuid (not a numeric id) — use it whenever you need to reference an order over the API.
username and password are null until the order has reached a state in which credentials are ready (i.e. not awaiting_payment, pending, or invoice_expired).
status is one of:
awaiting_payment · active · inactive · expired · exhausted · pending · failed · invoice_expired
List Orders
Retrieve all orders that belong to the authenticated user. Results are returned in descending order; there is no integrated pagination.
Endpoint: GET /orders
Response Example
[
{
"uuid": "9bdfe2d6-2c9a-4f7e-9e8c-1a2b3c4d5e6f",
"username": "99xhbk9uyvzry71",
"password": "tmu1rfdkw47i90d",
"initial_bandwidth_in_bytes": 1073741824,
"remaining_bandwidth_in_bytes": 1073741824,
"consumed_bandwidth_in_bytes": 0,
"expires_at": null,
"status": "active",
"price": {
"gross": 1.89,
"discount": 0,
"net": 1.89
},
"user": { /* ... */ },
"plan": { /* ... */ },
"created_at": "2026-01-04T21:19:12.000000Z",
"updated_at": "2026-01-04T21:19:12.000000Z"
}
// ...
]Get Order
Retrieve a single order by its uuid.
Endpoint: GET /orders/{uuid}
The lookup parameter changed from a numeric
idto auuid. The previousGET /orders/{id}form is no longer supported — use theuuidreturned in the order resource.
Response Example
{
"uuid": "9bdfe2d6-2c9a-4f7e-9e8c-1a2b3c4d5e6f",
"username": null,
"password": null,
"initial_bandwidth_in_bytes": 10737418240,
"remaining_bandwidth_in_bytes": 10737418240,
"consumed_bandwidth_in_bytes": 0,
"expires_at": "2026-06-03T12:00:00Z",
"status": "pending",
"price": {
"gross": 19.99,
"discount": 0,
"net": 19.99
},
"user": { /* ... */ },
"plan": { /* ... */ },
"created_at": "2026-01-04T21:19:12.000000Z",
"updated_at": "2026-01-04T21:19:12.000000Z"
}