​

Per-channel connection mode: BYO vs platform default

• Platform default — Orbit’s shared connection. Standard usage billing; nothing to set up.
• Your own connection (BYO) — a connection you bring (your own SIP trunk, SMPP account, email domain, WhatsApp Business account, and so on). Traffic on it carries a flat per-transaction platform fee in place of the platform default rate.

1. Turn on reseller mode
2. Bring your own connection for a channel
3. Revert a channel to the platform default
4. Read the current state

​

What reseller mode is

​

The inheritance model

• One active BYO connection per channel. The registry holds at most one connection per provider type. Activate your SIP trunk, and that trunk is the voice connection for the whole account family.
• No per-subaccount registry. There is no subaccount-level override. A subaccount cannot pick its own connection, and you cannot give one subaccount a different SIP trunk from another — BYO inheritance is all-or-nothing per channel, from the parent down.
• Subaccounts inherit transparently. When the parent has an active BYO connection for a channel, every subaccount’s traffic on that channel rides it. When the parent has none — or reseller mode is off — every subaccount falls back to the platform default for that channel. A subaccount’s own view of the connection settings says so, and who manages it.

​

Provider types

​

1. Turn on reseller mode

curl -X PATCH https://api.orbit.devotel.io/api/v1/organization/reseller/mode \
  -H "X-API-Key: dv_live_sk_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "enabled": true }'

{
  "data": { "enabled": true },
  "meta": { "request_id": "req_abc123" }
}

​

2. Bring your own connection for a channel

curl -X PUT https://api.orbit.devotel.io/api/v1/organization/reseller/providers/smpp \
  -H "X-API-Key: dv_live_sk_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "active",
    "credentials": {
      "system_id": "your-smpp-system-id",
      "password": "your-smpp-password",
      "host": "smpp.yourcarrier.example",
      "port": "2775"
    }
  }'

• status — set it to "active" to put the connection in service. Anything else (pending, degraded, failed) keeps the registry entry but resolves the channel to the platform default. Only active rows take traffic.
• credentials — a plaintext map of whatever fields that connection needs. The API encrypts every value before it persists, and never echoes a raw secret back: reads return each saved field as the masked sentinel ••••••. To rotate a secret, send the new value in the same field; to clear a field, send it as an empty string. Send at most 50 fields, each value at most 2000 characters.

{
  "data": {
    "provider_type": "smpp",
    "status": "active",
    "mode": "byo"
  },
  "meta": { "request_id": "req_def456" }
}

​

3. Revert a channel to the platform default

curl -X DELETE https://api.orbit.devotel.io/api/v1/organization/reseller/providers/smpp \
  -H "X-API-Key: dv_live_sk_YOUR_KEY"

{
  "data": { "provider_type": "smpp", "deleted": true },
  "meta": { "request_id": "req_ghi789" }
}

​

4. Read the current state

curl https://api.orbit.devotel.io/api/v1/organization/reseller \
  -H "X-API-Key: dv_live_sk_YOUR_KEY"

{
  "data": {
    "enabled": true,
    "isSubaccount": false,
    "effectiveResellerOrgId": "org_parent_123",
    "providers": [
      {
        "providerType": "smpp",
        "status": "active",
        "feeMeterHook": null,
        "credentials": {
          "system_id": "••••••",
          "password": "••••••",
          "host": "••••••",
          "port": "••••••"
        }
      }
    ]
  },
  "meta": { "request_id": "req_jkl012" }
}

• enabled — the reseller-mode flag.
• isSubaccount — true when the caller itself is a subaccount. Subaccounts always receive an empty providers list; provider configuration is parent-only and never readable by a child org.
• effectiveResellerOrgId — the org the caller resolves against: its parent when the caller is a subaccount, itself when it is the reseller org, otherwise null.
• providers — the registry with credential values masked.

​

Dashboard surface

• The Subaccounts list page — manage the whole account family from one card.
• The 5-step new-subaccount wizard — decide the connection mode at onboarding, in the same flow that sets plan, pricing, funding, and branding.

​

Per-channel behavior

• SMS — when smpp is active on the parent’s registry, subaccount SMS terminates on your SMPP account. Delete or deactivate it and SMS falls back to the platform default route.
• Voice — when sip_trunk is active, outbound calls from every subaccount terminate on your SIP trunk. Otherwise they run on the platform default.

​

Limits and rules

• Exactly one active BYO connection per provider type. A second PUT to the same type replaces the first — there is no multi-carrier mode.
• Reseller mode is a capability gate. Off means off: every channel resolves to the platform default regardless of saved connections.
• No per-subaccount override. Inheritance is all-or-nothing per channel from the parent. The only exception-free reading of “a subaccount wants its own connection” is: it wants its parent to bring one for the whole family.
• Secrets are masked, never returned. GET shows •••••• per saved field. Loss of the plaintext is yours to handle — rotate by re-saving.
• Parent-only management. Provider config and the mode toggle reject subaccount callers with 403.
• Subaccount-created channels are unaffected. A subaccount with no reseller-mode parent sees zero behavior change — everything it does resolves to the platform default, exactly as before.

​

Related

• Subaccounts API — create, fund, price, and brand child orgs
• Organization API — own-org profile, branding, and domains
• SMS channel and Voice channel — the two channels with live BYO termination today