Skip to content

Get an order

GET /api/v2/orders/{id}

Returns one of your orders with its invoice, payment state and the ordered items. actions.canCancel says whether POST /api/v2/orders/{id}/actions/cancel is allowed. An order whose invoice is paid can no longer be cancelled. invoiceLookupPending: true means the invoice could not be read right now. The payment fields then do not reflect it. The shape matches POST /api/v2/orders without the fields only that call returns: checkoutUrl, pendingManualProcessing, enableAffiliateTracking and restoreIntents.

Authentication: An API key with one of these scopes: read:orders, read:billing, read:domains. About keys and scopes

Request

Path parameters

idstringrequired
The order ID (ord_…).

Example

GET /api/v2/orders/{id}
curl "https://cloud.hostup.se/api/v2/orders/ord_01hxa3b4c5d6e7f8g9h0j1k2m3" \
-H "Authorization: Bearer $HOSTUP_API_KEY"

Responses

200 The order.

Response 200
{
"id": "ord_01hxa3b4c5d6e7f8g9h0j1k2m3",
"number": "1072061075",
"status": "active",
"type": "new",
"invoiceId": "inv_01hxa3b4c5d6e7f8g9h0j1k2m3",
"client": {
"id": "client_01hxa3b4c5d6e7f8g9h0j1k2m3",
"email": null,
"firstName": "Alex",
"lastName": "Example",
"companyName": "Example AB"
},
"billing": {
"amount": 1050.8,
"currencyCode": "SEK",
"billingCycle": null,
"isPayg": false
},
"invoice": {
"id": "inv_01hxa3b4c5d6e7f8g9h0j1k2m3",
"number": "202600001",
"amount": 1050.8,
"currencyCode": "SEK",
"dueAt": "2026-05-11T23:59:59.000Z",
"status": "paid",
"paymentUrl": "/billing?invoice=202600001",
"totals": {
"currencyCode": "SEK",
"total": 1050.8,
"amountPaid": 1050.8,
"outstanding": 0
},
"dates": {
"dueAt": "2026-05-11T23:59:59.000Z"
}
},
"paymentStatus": {
"status": "paid",
"reason": "Invoice is fully paid."
},
"actions": {
"canRetry": {
"allowed": false,
"reason": "Order is already completed."
},
"canCancel": {
"allowed": false,
"reason": "Active orders cannot be cancelled."
}
},
"domains": [
{
"name": "example.com",
"tld": "com",
"amount": 164.78,
"currencyCode": "SEK"
}
],
"hosting": [],
"addons": [],
"upgrades": [],
"invoiceLookupPending": false,
"createdAt": "2026-04-27T12:00:00.000Z",
"contractAcceptedAt": null,
"notes": null,
"referenceNumber": null
}
Response fields
idstring
numberstring
statusstring
One of pending, active, completed, cancelled, failed.
typestring
One of new, renew, upgrade, transfer.
invoiceIdstring or null
checkoutUrlstring or null
Older name for the payment link. Read invoice.paymentUrl when invoice is present.
clientobject
idstring or null
emailstring or null
firstNamestring or null
lastNamestring or null
companyNamestring or null
billingobject
amountnumber or null
The price per billing cycle, in the currency of the resource. Null when there is no fixed price, as for a Cloud VPS.
currencyCodestring
billingCyclestring or null
The billing cycle. A Cloud VPS also shows monthly. Use isPayg to tell it apart from a fixed-cycle VPS. One of monthly, quarterly, semiannually, annually, biennially, triennially, free.
isPaygboolean
True for a Cloud VPS, which is billed for what it uses. False for a fixed-cycle VPS. Other services normally return false.
periodYearsinteger or null
invoiceobject | null
idstring
numberstring or null
amountnumber
currencyCodestring
dueAtstring or null
statusstring
One of paid, unpaid, partially_paid, draft, cancelled, refunded.
paymentUrlstring or null
totalsobject
datesobject
paymentStatusobject
statusstring
One of paid, unpaid, credit_note, pending, unknown.
reasonstring or null
actionsobject
canRetryobject
allowedboolean
reasonstring or null
codestring or null
A machine-readable code for why the action is blocked.
canCancelobject
allowedboolean
True when the action can be called now.
reasonstring or null
Why the action is blocked, ready to show. Null when allowed is true.
domainsarray of object
hostingarray of object
addonsarray of object
upgradesarray of object
invoiceLookupPendingboolean
restoreIntentsobject
Present when the order restores a backup onto the new VPS. dispatchDeferred: true means the restore is saved. It is tried again once the VPS has been created.
requestedinteger
createdinteger
queuedinteger
skippedinteger
dispatchDeferredboolean
createdAtstring or null
contractAcceptedAtstring or null
notesstring or null
referenceNumberstring or null

Errors

Errors are Problem Details with a stable code. Branch on the code, not on the text.

400Invalid request. The response body is an RFC 7807 Problem Details document.
401Unauthorized. Authentication is required.
403Forbidden. The caller lacks a required scope or does not own the resource.
404order_not_found: no order with this ID on your account.
429Rate limited. Retry after the limit resets. 429 responses include Retry-After seconds plus X-RateLimit-* headers.
500Internal error. Retry later or contact support if the issue persists.