Documentation Index
Fetch the complete documentation index at: https://orbit-docs.devotel.io/llms.txt
Use this file to discover all available pages before exploring further.
Subaccounts API
For platforms reselling Orbit to their own customers — agencies, MSPs, vertical SaaS. A parent org creates and operates subaccount orgs, each with its own API keys, isolated data, optional custom branding and domain, and per-subaccount pricing.
Base path: /v1/subaccounts
Authentication: Parent-org session JWT or API key with admin role.
Lifecycle
| Method | Path | Purpose |
|---|
POST | /v1/subaccounts/ | Create a subaccount |
GET | /v1/subaccounts/ | List subaccounts |
GET | /v1/subaccounts/{id} | Get a subaccount |
PUT | /v1/subaccounts/{id} | Update name / contact / metadata |
DELETE | /v1/subaccounts/{id} | Delete (irreversible) |
POST | /v1/subaccounts/{id}/suspend | Suspend (blocks API + UI access) |
POST | /v1/subaccounts/{id}/reactivate | Lift a suspension |
Usage & credits
| Method | Path | Purpose |
|---|
GET | /v1/subaccounts/{id}/usage | Per-subaccount usage rollup |
POST | /v1/subaccounts/{id}/transfer-credits | Move credits from parent to subaccount |
API keys
| Method | Path | Purpose |
|---|
GET | /v1/subaccounts/{id}/api-keys | List the subaccount’s API keys |
POST | /v1/subaccounts/{id}/api-keys | Issue a new key for the subaccount |
Branding & custom domains
| Method | Path | Purpose |
|---|
GET | /v1/subaccounts/{id}/branding | Get effective branding |
PUT | /v1/subaccounts/{id}/branding | Override logo / colors / brand name |
POST | /v1/subaccounts/{id}/domains | Add a custom domain (CNAME-verified) |
GET | /v1/subaccounts/{id}/domains | List domains |
DELETE | /v1/subaccounts/{id}/domains/{domainId} | Remove a domain |
POST | /v1/subaccounts/{id}/domains/{domainId}/verify | Trigger DNS re-verification |
Pricing overrides
| Method | Path | Purpose |
|---|
GET | /v1/subaccounts/{id}/pricing | Get effective pricing |
PUT | /v1/subaccounts/{id}/pricing | Override per-channel pricing |
GET | /v1/subaccounts/{id}/mccmnc-overrides | Per-MCCMNC pricing overrides |
POST | /v1/subaccounts/{id}/mccmnc-overrides | Add an override |
DELETE | /v1/subaccounts/{id}/mccmnc-overrides/{overrideId} | Remove an override |
