Languages: every operation supports cURL, Node.js (TypeScript), Python, Go, Ruby, and PHP. The first 15 operations on this page show all six languages; the remaining 29 show cURL and TypeScript — the two most-used.

Subaccounts API

Subaccounts endpoints exposed by the Devotel CPaaS API Base path: /api/v1/subaccounts Endpoint count: 44

List subaccounts

GET /api/v1/subaccounts

string (enum: true|false)

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/subaccounts" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/subaccounts", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/subaccounts", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/subaccounts')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/subaccounts');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Get subaccounts

GET /api/v1/subaccounts/{id}

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Get a subaccount’s AI configuration

GET /api/v1/subaccounts/{id}/ai-config

Read (GET) or set (PUT) the parent’s AI-configuration override for this child: an enable/disable override, a curated LLM provider pin, and a comped (free) marker. Settings-JSONB-backed (no migration). GET returns the resolved view (response schema aiConfigViewJsonSchema); PUT echoes the same resolved view back. Requires owner/admin on the parent organization.

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/ai-config" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/ai-config', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/ai-config", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/ai-config", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/ai-config')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/ai-config');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "stored": {
      "enabled": null,
      "provider": "devotel",
      "comped": false
    },
    "enabled": false,
    "provider": "devotel",
    "providerSource": "stored",
    "comped": false
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "string"
  }
}

List api-keys

GET /api/v1/subaccounts/{id}/api-keys

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/api-keys" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/api-keys', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/api-keys", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/api-keys", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/api-keys')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/api-keys');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

List branding

GET /api/v1/subaccounts/{id}/branding

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/branding" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/branding', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/branding", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/branding", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/branding')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/branding');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

List channel-budgets

GET /api/v1/subaccounts/{id}/channel-budgets

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/channel-budgets" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/channel-budgets', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/channel-budgets", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/channel-budgets", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/channel-budgets')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/channel-budgets');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

List domains

GET /api/v1/subaccounts/{id}/domains

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/domains" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/domains', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/domains", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/domains", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/domains')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/domains');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

List cname-target

GET /api/v1/subaccounts/{id}/domains/cname-target

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/domains/cname-target" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/domains/cname-target', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/domains/cname-target", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/domains/cname-target", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/domains/cname-target')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/domains/cname-target');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

List invoice.html

GET /api/v1/subaccounts/{id}/invoice.html

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/invoice.html" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/invoice.html', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/invoice.html", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/invoice.html", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/invoice.html')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/invoice.html');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

List a subaccount’s MCCMNC rate overrides

GET /api/v1/subaccounts/{id}/mccmnc-overrides

Return the per-operator (MCCMNC) rate overrides set against one child subaccount, cursor-paginated. The send-path resolver prices an SMS segment against these overrides before falling through to the wholesale rate deck, so this list is the management view of what the child bills per operator. ?limit= tops at 200 and the response meta carries cursor/has_more/total to page the full override set. Requires owner or admin on the parent organization.

string

required

Subaccount (child organization) id.

string

Page size (default 100, max 200).

string

Opaque continuation token from a prior page.

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/mccmnc-overrides" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/mccmnc-overrides', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/mccmnc-overrides", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/mccmnc-overrides", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/mccmnc-overrides')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/mccmnc-overrides');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": [
    {
      "id": "msg_3f6a81c2d4e5471a9b0c2d5e",
      "mccmnc": "string",
      "operator_name": null,
      "country": null,
      "rate_per_unit": 0,
      "currency": "string",
      "created_at": "string"
    }
  ],
  "meta": {
    "request_id": "req_sample",
    "timestamp": "string",
    "cursor": null,
    "has_more": false,
    "total": 0
  }
}

List notification-email

GET /api/v1/subaccounts/{id}/notification-email

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/notification-email" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/notification-email', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/notification-email", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/notification-email", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/notification-email')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/notification-email');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Get a subaccount’s reseller pricing

GET /api/v1/subaccounts/{id}/pricing

Return the reseller pricing configuration for one child subaccount — the flat reseller_margin_pct markup, its monthly_spend_cap_cents ceiling (null = uncapped), and the current-period spend the cap is evaluated against. Use it to render the spend-cap progress / margin decks on the subaccount detail page. Requires owner or admin on the parent organization.

string

required

Subaccount (child organization) id.

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/pricing" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/pricing', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/pricing", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/pricing", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/pricing')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/pricing');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "subaccount_id": "string",
    "reseller_margin_pct": 0,
    "monthly_spend_cap_cents": null,
    "current_period_spend_cents": 0
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "string"
  }
}

Get the subaccount’s reseller rate deck

GET /api/v1/subaccounts/{id}/rate-deck

Return the subaccount’s differentiated per-channel/destination markup cells (the reseller rate deck) plus the id of the named rate card it is assigned to (or null). An empty deck means every usage line on this subaccount’s statement prices at the flat reseller_margin_pct. Requires owner or admin on the parent organization.

string

required

Subaccount (child organization) id.

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/rate-deck" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/rate-deck', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/rate-deck", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/rate-deck", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/rate-deck')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/rate-deck');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "subaccount_id": "string",
    "assigned_rate_card_id": null,
    "rate_deck": [
      {
        "channel": "sms",
        "destination": "+14155552671",
        "margin_pct": 0
      }
    ]
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "string"
  }
}

Get a subaccount’s lifetime usage

GET /api/v1/subaccounts/{id}/usage

Return a child organization’s lifetime usage counters plus its current plan/rate limit — messages sent/received, outbound call count, API call count, credits used, and data-retention days. The counters fall back to the subaccount’s stored metadata when the child tenant schema has not provisioned yet, so this read never fails a still-provisioning subaccount. Memoised for a short TTL on the service so the unbounded COUNT(*) scans the counters derive from do not starve the connection pool. Requires owner or admin on the parent organization.

string

required

Subaccount (child organization) id.

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/usage" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/usage', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/usage", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/usage", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/usage')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/usage');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "subaccount_id": "string",
    "credits_used": 0,
    "messages_sent": 0,
    "messages_received": 0,
    "calls_made": 0,
    "api_calls": 0,
    "current_plan": "string",
    "rate_limit_per_second": 0,
    "data_retention_days": null
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "string"
  }
}

List export.csv

GET /api/v1/subaccounts/{id}/usage/export.csv

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/usage/export.csv" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/usage/export.csv', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/usage/export.csv", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/usage/export.csv", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/usage/export.csv')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/usage/export.csv');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

List live

GET /api/v1/subaccounts/{id}/usage/live

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/usage/live" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/usage/live', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

List statement

GET /api/v1/subaccounts/{id}/usage/statement

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/usage/statement" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/usage/statement', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

List byo-fee-meter

GET /api/v1/subaccounts/byo-fee-meter

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/subaccounts/byo-fee-meter" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts/byo-fee-meter', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

List the parent org’s persisted rate cards

GET /api/v1/subaccounts/rate-cards

Return the parent organization’s named price-book library (settings.rateCards) — the persisted rate cards a reseller drafts, re-uses, and assigns to its subaccounts. Cards without cells are noise and never persist: each card needs an id + name plus at least one cell family (lane_cells and/or deck_cells). Requires owner or admin on the parent organization.

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/subaccounts/rate-cards" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts/rate-cards', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "rate_cards": [
      {
        "id": "msg_3f6a81c2d4e5471a9b0c2d5e",
        "name": "string",
        "lane_cells": [
          "string"
        ],
        "deck_cells": [
          "string"
        ]
      }
    ]
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "string"
  }
}

Consolidated usage rollup across the subaccount tree

GET /api/v1/subaccounts/usage-rollup

Return the parent-level usage and cost rollup for one billing period (period=YYYY-MM, defaulting to the current UTC month). Folds every child subaccount’s statement into grand totals plus a per-subaccount breakdown — each carrying quantity, base cost, the marked-up price under that subaccount’s reseller margin, and the margin earned. Use it for reseller portal spend dashboards and billing reconciliation over the whole tree; GET /api/v1/subaccounts//usage/statement drills into one subaccount and GET /api/v1/subaccounts/usage-rollup/export.csv returns the same rollup as CSV. Requires owner or admin on the parent organization.

string

Billing period in YYYY-MM; defaults to the current UTC month.

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/subaccounts/usage-rollup" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts/usage-rollup', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "parentOrgId": "string",
    "period": "string",
    "subaccountCount": 0,
    "currency": "string",
    "currencies": [
      "string"
    ],
    "subaccounts": [
      {
        "subaccountId": "string",
        "name": "string",
        "slug": "string",
        "status": "delivered",
        "marginPct": 0,
        "currency": "string",
        "totals": {
          "quantity": 0,
          "baseCost": 0,
          "markedUpPrice": 0,
          "marginEarned": 0
        }
      }
    ],
    "totals": {
      "quantity": 0,
      "baseCost": 0,
      "markedUpPrice": 0,
      "marginEarned": 0
    }
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "string"
  }
}

List export.csv

GET /api/v1/subaccounts/usage-rollup/export.csv

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/subaccounts/usage-rollup/export.csv" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts/usage-rollup/export.csv', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Create subaccounts

POST /api/v1/subaccounts

string

Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/subaccounts" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Create api-keys

POST /api/v1/subaccounts/{id}/api-keys

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/api-keys" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/api-keys', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Create channel-budgets

POST /api/v1/subaccounts/{id}/channel-budgets

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/channel-budgets" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/channel-budgets', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Create domains

POST /api/v1/subaccounts/{id}/domains

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/domains" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/domains', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Re-check a custom domain’s CNAME

POST /api/v1/subaccounts/{id}/domains/{domainId}/verify

Trigger a new CNAME/DNS verification pass against a claimed custom domain (the white-label dashboard hostname a reseller pointed at the canonical CNAME target). Returns the updated domain row: status flips to verified when the CNAME resolves, and a prior-migration / failed row can be re-checked here. The SSL certificate is provisioned asynchronously after verify succeeds. Requires owner or admin on the parent organization.

string

required

Subaccount (child organization) id.

string

required

Custom domain id (from POST /api/v1/subaccounts/:id/domains).

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/domains/{domainId}/verify" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/domains/{domainId}/verify', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "id": "msg_3f6a81c2d4e5471a9b0c2d5e",
    "organization_id": "string",
    "domain": "string",
    "status": "delivered",
    "cname_target": "string",
    "cname_verified_at": null,
    "ssl_cert_provisioned_at": null,
    "ssl_cert_secret_name": null,
    "error": null,
    "created_at": "string",
    "updated_at": "string"
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "string"
  }
}

Finalize a pending subaccount

POST /api/v1/subaccounts/{id}/finalize

Flip a wizard-created subaccount from pending to active on the new-subaccount wizard’s final Launch step. The wizard creates the row as pending so an abortable mid-wizard session never leaves a billing-active sub behind; this endpoint completes the flow. Idempotent — a 200 on an already-active row is a no-op, so safe client retries do not error. Requires owner or admin on the parent organization.

string

required

Subaccount (child organization) id.

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/finalize" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/finalize', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "id": "msg_3f6a81c2d4e5471a9b0c2d5e",
    "subscription_status": "active"
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "string"
  }
}

Upsert a subaccount MCCMNC rate override

POST /api/v1/subaccounts/{id}/mccmnc-overrides

Create or update a per-operator (MCCMNC) rate override on a child subaccount — a customer sell price (per unit) the send-path resolver applies verbatim for that operator instead of the wholesale/margin-pricing deck. The write validates the price is at-or-above the platform’s active wholesale cost for the same operator/currency, so a mis-priced override cannot put the subaccount below-cost on every segment. The currency is canonicalised to upper-case ISO-4217 before the guard + write. Requires owner or admin on the parent organization.

string

required

Subaccount (child organization) id.

string

string (enum: true|false)

string

required

Mobile network/operator identifier (MCC+MNC), 5–6 digits.

number

required

Customer sell price per unit (rejected if below wholesale cost).

string

ISO-4217 code (defaults to USD; canonicalised to upper-case).

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/mccmnc-overrides" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "mccmnc": "string",
  "rate_per_unit": 0
}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/mccmnc-overrides', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "mccmnc": "string",
  "rate_per_unit": 0
}),
})
console.log(await res.json())

{
  "data": {
    "id": "msg_3f6a81c2d4e5471a9b0c2d5e",
    "mccmnc": "string",
    "operator_name": null,
    "country": null,
    "rate_per_unit": 0,
    "currency": "string",
    "created_at": "string"
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "string"
  }
}

Reactivate a suspended subaccount

POST /api/v1/subaccounts/{id}/reactivate

Reactivate a suspended child organization so it can send again under the parent’s billing. Use it as the inverse of POST /api/v1/subaccounts//suspend; an already-active row is a no-op so safe client retries do not error. Requires owner on the parent organization.

string

required

Subaccount (child organization) id.

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/reactivate" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/reactivate', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "id": "msg_3f6a81c2d4e5471a9b0c2d5e",
    "status": "active"
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "string"
  }
}

Suspend a subaccount

POST /api/v1/subaccounts/{id}/suspend

Suspend a child organization so it stops send activity while the parent retains billing ownership. Use it to halt a runaway or abusive end-customer without permanently deleting the subaccount — POST /api/v1/subaccounts//reactivate flips it back to active. Idempotent shape: returns the subaccount id + status=suspended. Requires owner on the parent organization.

string

required

Subaccount (child organization) id.

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/suspend" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/suspend', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "id": "msg_3f6a81c2d4e5471a9b0c2d5e",
    "status": "suspended"
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "string"
  }
}

Transfer wallet credits to a subaccount

POST /api/v1/subaccounts/{id}/transfer-credits

Move credits from the parent organization’s wallet to one child subaccount’s wallet — atomic debit-then-add with rollback so a failure never leaves the parent debited. A caller-supplied client_reference_id de-duplicates safe client retries so a network-failure retry does not double-charge. Fails 402 when the parent balance is insufficient. Requires owner on the parent organization.

string

required

Subaccount (child organization) id.

string

string (enum: true|false)

integer

required

Credits (cents) to transfer — 1–1,000,000 per call.

string

Free-text audit note attached to the transfer.

string

Caller-supplied idempotency key; a retry with the same (parent, child, amount, id) tuple is treated as the prior call so the parent is never double-charged.

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/transfer-credits" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "amount_cents": 0
}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/transfer-credits', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "amount_cents": 0
}),
})
console.log(await res.json())

{
  "data": {
    "transferred": false,
    "amount_cents": 0,
    "parent_balance_cents": 0,
    "child_balance_cents": 0
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "string"
  }
}

Provision a subaccount in one call

POST /api/v1/subaccounts/provision

Collapse the new-subaccount wizard (organization → plan & limits → reseller pricing → funding → branding) into one atomic call so a reseller’s portal/automation can stand up a branded, priced, funded tenant without stepping the multi-step dashboard wizard. Validated downstream by the reseller-provisioning planner; a failure in any step (pricing/funding/branding/finalize) rolls the child org back so no partially-provisioned subaccount is left behind. Requires owner or admin on the parent organization.

string

string (enum: true|false)

string

required

—

string

—

string (enum: starter|growth|business|enterprise)

—

integer

—

integer

—

number

—

integer | null

—

object[]

—

object[]

—

integer

—

object

—

boolean

—

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/subaccounts/provision" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string"
}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts/provision', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "name": "string"
}),
})
console.log(await res.json())

{
  "data": {
    "parentOrgId": "string",
    "childOrgId": "string",
    "subscription_status": "string",
    "pricing": {
      "reseller_margin_pct": 0,
      "monthly_spend_cap_cents": null
    },
    "rate_deck": [
      {
        "channel": "sms",
        "destination": "+14155552671",
        "margin_pct": 0
      }
    ],
    "channel_budgets": null
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "string"
  }
}

Update subaccounts

PUT /api/v1/subaccounts/{id}

string

required

—

string

string (enum: true|false)

cURL

curl -X PUT "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'PUT',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Update a subaccount’s AI configuration

PUT /api/v1/subaccounts/{id}/ai-config

string

required

—

string

string (enum: true|false)

boolean | null

—

string | null (enum: devotel|anthropic)

—

boolean

—

cURL

curl -X PUT "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/ai-config" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/ai-config', {
  method: 'PUT',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "stored": {
      "enabled": null,
      "provider": "devotel",
      "comped": false
    },
    "enabled": false,
    "provider": "devotel",
    "providerSource": "stored",
    "comped": false
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "string"
  }
}

Update assigned-rate-card

PUT /api/v1/subaccounts/{id}/assigned-rate-card

string

required

—

string

string (enum: true|false)

cURL

curl -X PUT "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/assigned-rate-card" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/assigned-rate-card', {
  method: 'PUT',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Update branding

PUT /api/v1/subaccounts/{id}/branding

string

required

—

string

string (enum: true|false)

cURL

curl -X PUT "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/branding" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/branding', {
  method: 'PUT',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Update channel-budgets

PUT /api/v1/subaccounts/{id}/channel-budgets

string

required

—

string

string (enum: true|false)

cURL

curl -X PUT "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/channel-budgets" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/channel-budgets', {
  method: 'PUT',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Update notification-email

PUT /api/v1/subaccounts/{id}/notification-email

string

required

—

string

string (enum: true|false)

cURL

curl -X PUT "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/notification-email" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/notification-email', {
  method: 'PUT',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {},
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Set a subaccount’s reseller pricing

PUT /api/v1/subaccounts/{id}/pricing

Replace a child subaccount’s reseller margin percentage / monthly spend cap (a null monthly_spend_cap_cents clears the cap back to uncapped). The margin is clamped to [0, 100] and the cap clamps to a sane max so a mis-keyed dashboard edit cannot runaway an end-customer. Every usage line on the subaccount’s invoice prices against the deck resulting from this setting plus any named rate card the child is assigned. Requires owner or admin on the parent organization.

string

required

Subaccount (child organization) id.

string

string (enum: true|false)

number

Flat markup percentage on every usage line’s base cost.

integer | null

Aggregate monthly spend ceiling (cents); null clears the cap back to uncapped.

cURL

curl -X PUT "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/pricing" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/pricing', {
  method: 'PUT',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "subaccount_id": "string",
    "reseller_margin_pct": 0,
    "monthly_spend_cap_cents": null,
    "current_period_spend_cents": 0
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "string"
  }
}

Replace the subaccount’s reseller rate deck

PUT /api/v1/subaccounts/{id}/rate-deck

Replace the subaccount’s rate deck full-set (an empty rate_deck array clears it back to the flat-margin-only default). Returns the normalised, enforceable deck actually stored. Each cell pairs a channel with a markup margin_pct, optionally scoped to a destination (ISO country code / MCCMNC / region label); an omitted destination is a channel-wide cell. Requires owner or admin on the parent organization.

string

required

Subaccount (child organization) id.

string

string (enum: true|false)

object[]

required

The complete desired price book (full-set replace; empty array clears the deck).

cURL

curl -X PUT "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/rate-deck" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "rate_deck": []
}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/rate-deck', {
  method: 'PUT',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "rate_deck": []
}),
})
console.log(await res.json())

{
  "data": {
    "subaccount_id": "string",
    "assigned_rate_card_id": null,
    "rate_deck": [
      {
        "channel": "sms",
        "destination": "+14155552671",
        "margin_pct": 0
      }
    ]
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "string"
  }
}

Replace the parent org’s rate-card library

PUT /api/v1/subaccounts/rate-cards

Replace the parent organization’s rate-card library full-set (an empty rate_cards array clears it — new assignments then fall back to the flat margin / the child’s own deck). Returns the normalised library actually stored. Requires owner or admin on the parent organization.

string

string (enum: true|false)

object[]

required

The complete desired library (full-set replace; empty array clears it).

cURL

curl -X PUT "https://api.orbit.devotel.io/api/v1/subaccounts/rate-cards" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "cards": []
}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts/rate-cards', {
  method: 'PUT',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "cards": []
}),
})
console.log(await res.json())

{
  "data": {
    "rate_cards": [
      {
        "id": "msg_3f6a81c2d4e5471a9b0c2d5e",
        "name": "string",
        "lane_cells": [
          "string"
        ],
        "deck_cells": [
          "string"
        ]
      }
    ]
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "string"
  }
}

Delete subaccounts

DELETE /api/v1/subaccounts/{id}

string

required

—

string (enum: true|false)

cURL

curl -X DELETE "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'DELETE',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "ok": true
  },
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Delete domains

DELETE /api/v1/subaccounts/{id}/domains/{domainId}

string

required

—

string

required

—

string (enum: true|false)

cURL

curl -X DELETE "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/domains/{domainId}" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/domains/{domainId}', {
  method: 'DELETE',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "ok": true
  },
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Delete a subaccount MCCMNC rate override

DELETE /api/v1/subaccounts/{id}/mccmnc-overrides/{overrideId}

Remove one per-operator (MCCMNC) rate override from a child subaccount so its traffic prices back onto the wholesale/margin deck. A 404 is raised when the override does not belong to the child org scoped by the parent, so a parent cannot delete a sibling’s override via a flat id. Returns 204 No Content. Requires owner or admin on the parent organization.

string

required

Subaccount (child organization) id.

string

required

MCCMNC override row id (from GET /api/v1/subaccounts/:id/mccmnc-overrides).

string (enum: true|false)

cURL

curl -X DELETE "https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/mccmnc-overrides/{overrideId}" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/subaccounts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/mccmnc-overrides/{overrideId}', {
  method: 'DELETE',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

Response: 204 No Content

​Subaccounts API

​List subaccounts

​Get subaccounts

​Get a subaccount’s AI configuration

​List api-keys

​List branding

​List channel-budgets

​List domains

​List cname-target

​List invoice.html

​List a subaccount’s MCCMNC rate overrides

​List notification-email

​Get a subaccount’s reseller pricing

​Get the subaccount’s reseller rate deck

​Get a subaccount’s lifetime usage

​List export.csv

​List live

​List statement

​List byo-fee-meter

​List the parent org’s persisted rate cards

​Consolidated usage rollup across the subaccount tree

​List export.csv

​Create subaccounts

​Create api-keys

​Create channel-budgets

​Create domains

​Re-check a custom domain’s CNAME

​Finalize a pending subaccount

​Upsert a subaccount MCCMNC rate override

​Reactivate a suspended subaccount

​Suspend a subaccount

​Transfer wallet credits to a subaccount

​Provision a subaccount in one call

​Update subaccounts

​Update a subaccount’s AI configuration

​Update assigned-rate-card

​Update branding

​Update channel-budgets

​Update notification-email

​Set a subaccount’s reseller pricing

​Replace the subaccount’s reseller rate deck

​Replace the parent org’s rate-card library

​Delete subaccounts

​Delete domains

​Delete a subaccount MCCMNC rate override

Subaccounts API

List subaccounts

Get subaccounts

Get a subaccount’s AI configuration

List api-keys

List branding

List channel-budgets

List domains

List cname-target

List invoice.html

List a subaccount’s MCCMNC rate overrides

List notification-email

Get a subaccount’s reseller pricing

Get the subaccount’s reseller rate deck

Get a subaccount’s lifetime usage

List export.csv

List live

List statement

List byo-fee-meter

List the parent org’s persisted rate cards

Consolidated usage rollup across the subaccount tree

List export.csv

Create subaccounts

Create api-keys

Create channel-budgets

Create domains

Re-check a custom domain’s CNAME

Finalize a pending subaccount

Upsert a subaccount MCCMNC rate override

Reactivate a suspended subaccount

Suspend a subaccount

Transfer wallet credits to a subaccount

Provision a subaccount in one call

Update subaccounts

Update a subaccount’s AI configuration

Update assigned-rate-card

Update branding

Update channel-budgets

Update notification-email

Set a subaccount’s reseller pricing

Replace the subaccount’s reseller rate deck

Replace the parent org’s rate-card library

Delete subaccounts

Delete domains

Delete a subaccount MCCMNC rate override