Skip to content
Error envelope
{
  "error": {
    "code": "not_found",
    "message": "Order not found.",
    "request_id": "83955522c09ff2d1"
  }
}

An undefined path also returns a JSON 404 not_found in the same envelope; it never returns an HTML page.

Codes

HTTPcodeWhen
401unauthorizedNo token, a malformed token or an invalid token.
403insufficient_scopeThe token lacks the scope this endpoint requires.
403tier_requiredThe requested feature is not in your plan (e.g. choosing your own username).
403forbiddenThis operation is not allowed.
404not_foundThe resource was not found, or it is hidden because it expired.
404api_disabledAPI access is turned off.
405method_not_allowedThis endpoint does not support this HTTP method. The supported methods are in the Allow header.
400invalid_requestAn invalid field, an unknown field or parameter, or a field that belongs to another type.
402insufficient_balanceThe balance is not enough for this operation.
409conflictState conflict: a service that cannot be renewed, an idempotent request still being processed, a username already taken.
429rate_limitedRate limit exceeded.
502 / 503service_unavailableThe provider or the log store could not be reached; try again.
500 / 502internal_errorUnexpected error; contact support with the request_id.

details

If the error has machine-readable details, they come back in the details field: the faulty field (field), stock (available), minimum quantity (min_required), balance (balance), the highest allowed value (max), the reason for the error (reason) and so on. For example, if the service type is under maintenance, you getreason: maintenance together with service_unavailable.

402 insufficient_balance
{
  "error": {
    "code": "insufficient_balance",
    "message": "Insufficient balance for this operation.",
    "request_id": "5f1c0a9e7b2d4c61",
    "details": { "field": "balance", "balance": 3.2, "min_required": 12.5 }
  }
}

request_id

Log the request_id value; the support team can search the server logs with that ID.