Provision a subaccount in one call
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/subaccounts/provision \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"slug": "<string>",
"max_team_members": 250,
"rate_limit_per_second": 5000,
"reseller_margin_pct": 50,
"monthly_spend_cap_cents": 500000000,
"rate_deck": [
{
"channel": "<string>",
"margin_pct": 50,
"destination": "<string>"
}
],
"channel_budgets": [
{
"channel": "<string>",
"threshold_cents": 500000000,
"period": "monthly"
}
],
"initial_credits_cents": 50000000,
"branding": {
"primary_color": "<string>",
"accent_color": "<string>",
"dashboard_name": "<string>",
"support_email": "jsmith@example.com",
"logo_url": "<string>",
"logomark_url": "<string>",
"favicon_url": "<string>",
"custom_domain": "<string>"
},
"inherit_branding_from_parent": true
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/subaccounts/provision"
payload = {
"name": "<string>",
"slug": "<string>",
"max_team_members": 250,
"rate_limit_per_second": 5000,
"reseller_margin_pct": 50,
"monthly_spend_cap_cents": 500000000,
"rate_deck": [
{
"channel": "<string>",
"margin_pct": 50,
"destination": "<string>"
}
],
"channel_budgets": [
{
"channel": "<string>",
"threshold_cents": 500000000,
"period": "monthly"
}
],
"initial_credits_cents": 50000000,
"branding": {
"primary_color": "<string>",
"accent_color": "<string>",
"dashboard_name": "<string>",
"support_email": "jsmith@example.com",
"logo_url": "<string>",
"logomark_url": "<string>",
"favicon_url": "<string>",
"custom_domain": "<string>"
},
"inherit_branding_from_parent": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
slug: '<string>',
max_team_members: 250,
rate_limit_per_second: 5000,
reseller_margin_pct: 50,
monthly_spend_cap_cents: 500000000,
rate_deck: [{channel: '<string>', margin_pct: 50, destination: '<string>'}],
channel_budgets: [{channel: '<string>', threshold_cents: 500000000, period: 'monthly'}],
initial_credits_cents: 50000000,
branding: {
primary_color: '<string>',
accent_color: '<string>',
dashboard_name: '<string>',
support_email: 'jsmith@example.com',
logo_url: '<string>',
logomark_url: '<string>',
favicon_url: '<string>',
custom_domain: '<string>'
},
inherit_branding_from_parent: true
})
};
fetch('https://api.orbit.devotel.io/api/v1/subaccounts/provision', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.orbit.devotel.io/api/v1/subaccounts/provision",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'slug' => '<string>',
'max_team_members' => 250,
'rate_limit_per_second' => 5000,
'reseller_margin_pct' => 50,
'monthly_spend_cap_cents' => 500000000,
'rate_deck' => [
[
'channel' => '<string>',
'margin_pct' => 50,
'destination' => '<string>'
]
],
'channel_budgets' => [
[
'channel' => '<string>',
'threshold_cents' => 500000000,
'period' => 'monthly'
]
],
'initial_credits_cents' => 50000000,
'branding' => [
'primary_color' => '<string>',
'accent_color' => '<string>',
'dashboard_name' => '<string>',
'support_email' => 'jsmith@example.com',
'logo_url' => '<string>',
'logomark_url' => '<string>',
'favicon_url' => '<string>',
'custom_domain' => '<string>'
],
'inherit_branding_from_parent' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.orbit.devotel.io/api/v1/subaccounts/provision"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"max_team_members\": 250,\n \"rate_limit_per_second\": 5000,\n \"reseller_margin_pct\": 50,\n \"monthly_spend_cap_cents\": 500000000,\n \"rate_deck\": [\n {\n \"channel\": \"<string>\",\n \"margin_pct\": 50,\n \"destination\": \"<string>\"\n }\n ],\n \"channel_budgets\": [\n {\n \"channel\": \"<string>\",\n \"threshold_cents\": 500000000,\n \"period\": \"monthly\"\n }\n ],\n \"initial_credits_cents\": 50000000,\n \"branding\": {\n \"primary_color\": \"<string>\",\n \"accent_color\": \"<string>\",\n \"dashboard_name\": \"<string>\",\n \"support_email\": \"jsmith@example.com\",\n \"logo_url\": \"<string>\",\n \"logomark_url\": \"<string>\",\n \"favicon_url\": \"<string>\",\n \"custom_domain\": \"<string>\"\n },\n \"inherit_branding_from_parent\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.orbit.devotel.io/api/v1/subaccounts/provision")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"max_team_members\": 250,\n \"rate_limit_per_second\": 5000,\n \"reseller_margin_pct\": 50,\n \"monthly_spend_cap_cents\": 500000000,\n \"rate_deck\": [\n {\n \"channel\": \"<string>\",\n \"margin_pct\": 50,\n \"destination\": \"<string>\"\n }\n ],\n \"channel_budgets\": [\n {\n \"channel\": \"<string>\",\n \"threshold_cents\": 500000000,\n \"period\": \"monthly\"\n }\n ],\n \"initial_credits_cents\": 50000000,\n \"branding\": {\n \"primary_color\": \"<string>\",\n \"accent_color\": \"<string>\",\n \"dashboard_name\": \"<string>\",\n \"support_email\": \"jsmith@example.com\",\n \"logo_url\": \"<string>\",\n \"logomark_url\": \"<string>\",\n \"favicon_url\": \"<string>\",\n \"custom_domain\": \"<string>\"\n },\n \"inherit_branding_from_parent\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/subaccounts/provision")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"max_team_members\": 250,\n \"rate_limit_per_second\": 5000,\n \"reseller_margin_pct\": 50,\n \"monthly_spend_cap_cents\": 500000000,\n \"rate_deck\": [\n {\n \"channel\": \"<string>\",\n \"margin_pct\": 50,\n \"destination\": \"<string>\"\n }\n ],\n \"channel_budgets\": [\n {\n \"channel\": \"<string>\",\n \"threshold_cents\": 500000000,\n \"period\": \"monthly\"\n }\n ],\n \"initial_credits_cents\": 50000000,\n \"branding\": {\n \"primary_color\": \"<string>\",\n \"accent_color\": \"<string>\",\n \"dashboard_name\": \"<string>\",\n \"support_email\": \"jsmith@example.com\",\n \"logo_url\": \"<string>\",\n \"logomark_url\": \"<string>\",\n \"favicon_url\": \"<string>\",\n \"custom_domain\": \"<string>\"\n },\n \"inherit_branding_from_parent\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"parentOrgId": "<string>",
"childOrgId": "<string>",
"subscription_status": "<string>",
"pricing": {
"reseller_margin_pct": 123,
"monthly_spend_cap_cents": 123
},
"rate_deck": [
{
"channel": "<string>",
"margin_pct": 123,
"destination": "<string>"
}
],
"channel_budgets": "<array>"
},
"meta": {
"request_id": "<string>",
"timestamp": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "<string>",
"status": 429,
"retry_after": 2
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Subaccounts
Provision a subaccount in one call
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.
POST
/
api
/
v1
/
subaccounts
/
provision
Provision a subaccount in one call
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/subaccounts/provision \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"slug": "<string>",
"max_team_members": 250,
"rate_limit_per_second": 5000,
"reseller_margin_pct": 50,
"monthly_spend_cap_cents": 500000000,
"rate_deck": [
{
"channel": "<string>",
"margin_pct": 50,
"destination": "<string>"
}
],
"channel_budgets": [
{
"channel": "<string>",
"threshold_cents": 500000000,
"period": "monthly"
}
],
"initial_credits_cents": 50000000,
"branding": {
"primary_color": "<string>",
"accent_color": "<string>",
"dashboard_name": "<string>",
"support_email": "jsmith@example.com",
"logo_url": "<string>",
"logomark_url": "<string>",
"favicon_url": "<string>",
"custom_domain": "<string>"
},
"inherit_branding_from_parent": true
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/subaccounts/provision"
payload = {
"name": "<string>",
"slug": "<string>",
"max_team_members": 250,
"rate_limit_per_second": 5000,
"reseller_margin_pct": 50,
"monthly_spend_cap_cents": 500000000,
"rate_deck": [
{
"channel": "<string>",
"margin_pct": 50,
"destination": "<string>"
}
],
"channel_budgets": [
{
"channel": "<string>",
"threshold_cents": 500000000,
"period": "monthly"
}
],
"initial_credits_cents": 50000000,
"branding": {
"primary_color": "<string>",
"accent_color": "<string>",
"dashboard_name": "<string>",
"support_email": "jsmith@example.com",
"logo_url": "<string>",
"logomark_url": "<string>",
"favicon_url": "<string>",
"custom_domain": "<string>"
},
"inherit_branding_from_parent": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
slug: '<string>',
max_team_members: 250,
rate_limit_per_second: 5000,
reseller_margin_pct: 50,
monthly_spend_cap_cents: 500000000,
rate_deck: [{channel: '<string>', margin_pct: 50, destination: '<string>'}],
channel_budgets: [{channel: '<string>', threshold_cents: 500000000, period: 'monthly'}],
initial_credits_cents: 50000000,
branding: {
primary_color: '<string>',
accent_color: '<string>',
dashboard_name: '<string>',
support_email: 'jsmith@example.com',
logo_url: '<string>',
logomark_url: '<string>',
favicon_url: '<string>',
custom_domain: '<string>'
},
inherit_branding_from_parent: true
})
};
fetch('https://api.orbit.devotel.io/api/v1/subaccounts/provision', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.orbit.devotel.io/api/v1/subaccounts/provision",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'slug' => '<string>',
'max_team_members' => 250,
'rate_limit_per_second' => 5000,
'reseller_margin_pct' => 50,
'monthly_spend_cap_cents' => 500000000,
'rate_deck' => [
[
'channel' => '<string>',
'margin_pct' => 50,
'destination' => '<string>'
]
],
'channel_budgets' => [
[
'channel' => '<string>',
'threshold_cents' => 500000000,
'period' => 'monthly'
]
],
'initial_credits_cents' => 50000000,
'branding' => [
'primary_color' => '<string>',
'accent_color' => '<string>',
'dashboard_name' => '<string>',
'support_email' => 'jsmith@example.com',
'logo_url' => '<string>',
'logomark_url' => '<string>',
'favicon_url' => '<string>',
'custom_domain' => '<string>'
],
'inherit_branding_from_parent' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.orbit.devotel.io/api/v1/subaccounts/provision"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"max_team_members\": 250,\n \"rate_limit_per_second\": 5000,\n \"reseller_margin_pct\": 50,\n \"monthly_spend_cap_cents\": 500000000,\n \"rate_deck\": [\n {\n \"channel\": \"<string>\",\n \"margin_pct\": 50,\n \"destination\": \"<string>\"\n }\n ],\n \"channel_budgets\": [\n {\n \"channel\": \"<string>\",\n \"threshold_cents\": 500000000,\n \"period\": \"monthly\"\n }\n ],\n \"initial_credits_cents\": 50000000,\n \"branding\": {\n \"primary_color\": \"<string>\",\n \"accent_color\": \"<string>\",\n \"dashboard_name\": \"<string>\",\n \"support_email\": \"jsmith@example.com\",\n \"logo_url\": \"<string>\",\n \"logomark_url\": \"<string>\",\n \"favicon_url\": \"<string>\",\n \"custom_domain\": \"<string>\"\n },\n \"inherit_branding_from_parent\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.orbit.devotel.io/api/v1/subaccounts/provision")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"max_team_members\": 250,\n \"rate_limit_per_second\": 5000,\n \"reseller_margin_pct\": 50,\n \"monthly_spend_cap_cents\": 500000000,\n \"rate_deck\": [\n {\n \"channel\": \"<string>\",\n \"margin_pct\": 50,\n \"destination\": \"<string>\"\n }\n ],\n \"channel_budgets\": [\n {\n \"channel\": \"<string>\",\n \"threshold_cents\": 500000000,\n \"period\": \"monthly\"\n }\n ],\n \"initial_credits_cents\": 50000000,\n \"branding\": {\n \"primary_color\": \"<string>\",\n \"accent_color\": \"<string>\",\n \"dashboard_name\": \"<string>\",\n \"support_email\": \"jsmith@example.com\",\n \"logo_url\": \"<string>\",\n \"logomark_url\": \"<string>\",\n \"favicon_url\": \"<string>\",\n \"custom_domain\": \"<string>\"\n },\n \"inherit_branding_from_parent\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/subaccounts/provision")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"max_team_members\": 250,\n \"rate_limit_per_second\": 5000,\n \"reseller_margin_pct\": 50,\n \"monthly_spend_cap_cents\": 500000000,\n \"rate_deck\": [\n {\n \"channel\": \"<string>\",\n \"margin_pct\": 50,\n \"destination\": \"<string>\"\n }\n ],\n \"channel_budgets\": [\n {\n \"channel\": \"<string>\",\n \"threshold_cents\": 500000000,\n \"period\": \"monthly\"\n }\n ],\n \"initial_credits_cents\": 50000000,\n \"branding\": {\n \"primary_color\": \"<string>\",\n \"accent_color\": \"<string>\",\n \"dashboard_name\": \"<string>\",\n \"support_email\": \"jsmith@example.com\",\n \"logo_url\": \"<string>\",\n \"logomark_url\": \"<string>\",\n \"favicon_url\": \"<string>\",\n \"custom_domain\": \"<string>\"\n },\n \"inherit_branding_from_parent\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"parentOrgId": "<string>",
"childOrgId": "<string>",
"subscription_status": "<string>",
"pricing": {
"reseller_margin_pct": 123,
"monthly_spend_cap_cents": 123
},
"rate_deck": [
{
"channel": "<string>",
"margin_pct": 123,
"destination": "<string>"
}
],
"channel_budgets": "<array>"
},
"meta": {
"request_id": "<string>",
"timestamp": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "<string>",
"status": 429,
"retry_after": 2
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Authorizations
BearerApiKey
Dashboard JWT token from Clerk
Headers
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.
Required string length:
1 - 255Sandbox 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.
Available options:
true, false Body
application/json
Required string length:
2 - 100Required string length:
2 - 60Pattern:
^[a-z0-9-]+$Available options:
starter, growth, business, enterprise Required range:
1 <= x <= 500Required range:
1 <= x <= 10000Required range:
0 <= x <= 100Required range:
0 <= x <= 1000000000Show child attributes
Show child attributes
Show child attributes
Show child attributes
Required range:
0 <= x <= 100000000Show child attributes
Show child attributes