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
idstringrequiredThe order ID (
ord_…).Example
curl "https://cloud.hostup.se/api/v2/orders/ord_01hxa3b4c5d6e7f8g9h0j1k2m3" \ -H "Authorization: Bearer $HOSTUP_API_KEY"Responses
200 The order.
{ "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
idstringnumberstringstatusstringOne of
pending, active, completed, cancelled, failed.typestringOne of
new, renew, upgrade, transfer.invoiceIdstring or nullcheckoutUrlstring or nullOlder name for the payment link. Read
invoice.paymentUrl when invoice is present.clientobjectidstring or nullemailstring or nullfirstNamestring or nulllastNamestring or nullcompanyNamestring or nullbillingobjectamountnumber or nullThe price per billing cycle, in the currency of the resource. Null when there is no fixed price, as for a Cloud VPS.
currencyCodestringbillingCyclestring or nullThe 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.isPaygbooleanTrue for a Cloud VPS, which is billed for what it uses. False for a fixed-cycle VPS. Other services normally return false.
periodYearsinteger or nullinvoiceobject | nullidstringnumberstring or nullamountnumbercurrencyCodestringdueAtstring or nullstatusstringOne of
paid, unpaid, partially_paid, draft, cancelled, refunded.paymentUrlstring or nulltotalsobjectdatesobjectpaymentStatusobjectstatusstringOne of
paid, unpaid, credit_note, pending, unknown.reasonstring or nullactionsobjectcanRetryobjectallowedbooleanreasonstring or nullcodestring or nullA machine-readable code for why the action is blocked.
canCancelobjectallowedbooleanTrue when the action can be called now.
reasonstring or nullWhy the action is blocked, ready to show. Null when
allowed is true.domainsarray of objecthostingarray of objectaddonsarray of objectupgradesarray of objectinvoiceLookupPendingbooleanrestoreIntentsobjectPresent 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.requestedintegercreatedintegerqueuedintegerskippedintegerdispatchDeferredbooleancreatedAtstring or nullcontractAcceptedAtstring or nullnotesstring or nullreferenceNumberstring or nullErrors
Errors are Problem Details with a stable code. Branch on the code, not on the text.
| 400 | Invalid request. The response body is an RFC 7807 Problem Details document. |
| 401 | Unauthorized. Authentication is required. |
| 403 | Forbidden. The caller lacks a required scope or does not own the resource. |
| 404 | order_not_found: no order with this ID on your account. |
| 429 | Rate limited. Retry after the limit resets. 429 responses include Retry-After seconds plus X-RateLimit-* headers. |
| 500 | Internal error. Retry later or contact support if the issue persists. |