Skip to documentation
DocumentationAPI referenceGet order details
GETBearer token

Get order details

/api/v1/orders/:id

Read an order and its serverId after delivery.

Before you call

Query pending or unknown outcomes. Do not create another purchase to resolve an uncertain result.

Request example

cURL
curl "https://tovahub.com/api/v1/orders/507f1f77bcf86cd799439012" \
  -H "Authorization: Bearer $TOVAHUB_TOKEN"

Examples only. No requests are sent from this page.

Parameters

idPath · Required

string

Resource ID: 24 hexadecimal characters. Use the platform ID returned by the matching list endpoint, not a supplier instance ID.

Response

HTTP status 200

Read one organization order and the delivered local server identifier.

_idstring (ObjectId)

Order identifier.

assetstring ('USD' | 'xTOVA')

Stored payment asset.

amountstring

Integer USD cents or integer xTOVA units.

planIdstring

Purchased plan identifier.

regionstring

Purchased region code.

daysnumber

Purchased billing duration in days.

hostnamestring

Server hostname.

namestring (optional)

User-assigned display name, when present.

osstring

Requested operating system identifier.

statusstring ('pending' | 'provisioning' | 'completed' | 'failed' | 'refunded')

Order fulfillment status.

providerServerIdstring | null

Supplier instance identifier, when known.

failureReasonstring | null

Recorded failure reason, if any.

createdAtstring (ISO 8601)

Order creation time.

updatedAtstring (ISO 8601)

Order last-update time.

testOnlyboolean

Whether the order uses isolated test inventory.

serverIdstring | null

Local platform server ObjectId after delivery, or null; distinct from providerServerId.