Intelligence API error reference · Updated August 2026
subscription_required.
Every Orbyt Intelligence error envelope carries a permanent doc_url that resolves here. This page is generated from the same error registry the API serves from, so it can never drift from runtime behavior.
What it means.
The API key is valid but the account behind it has no active Orbyt Intelligence subscription (never subscribed, or the subscription was canceled, paused, or expired). Keys are not revoked on cancellation; access resumes automatically once a qualifying subscription exists. Manage billing in the Intelligence dashboard or subscribe on the pricing page. There is no trial; every subscription bills immediately.
Retry strategy.
The envelope returns retry_strategy: "do_not_retry" by default for this code.
Retrying the same request will fail again. Fix the underlying cause first, then issue a fresh request.
Example error envelope.
Locked RFC-001 shape. The HTTP status is 403, the x-request-id header mirrors error.request_id, and the doc_url points back to this page.
{
"error": {
"type": "permission_error",
"code": "subscription_required",
"message": "The API key is valid but the account behind it has no active Orbyt Intelligence subscription (never subscribed, or the subscription was canceled, paused, or expired).",
"doc_url": "https://www.orbytlabs.ai/intelligence/api/errors/subscription_required",
"request_id": "req_0123456789abcdef",
"retry_strategy": "do_not_retry"
}
}How to fix it.
- Read error.message for the specific cause. It is written to be quoted verbatim.
- Fix the cause in your integration (key, scope, tier, or request shape) before sending the request again.
- If you believe the error is wrong, contact support with the error.request_id so we can pull the exact log row.
Related codes.
Other codes in the permission_error family.