Provision a subaccount tenant (create + mint key + webhook secret). plainTextKey & webhookSecret returned ONCE.

Authorization

provider-key

x-provider-key<token>

Provider control-plane key (reseller: manage owned tenants)

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

slug?string

URL-safe slug (lowercase, hyphens only). Auto-derived if omitted.

Match^[a-z0-9]+(?:-[a-z0-9]+)*$

Lengthlength <= 60

plan?string

Plan tier; selects the feature set + numeric limits. INTERNAL is reserved for staff-provisioned first-party tenants and cannot be set through the provider control plane.

Value in

"FREE"
"PRO"
"ENTERPRISE"

webhookUrl?string

Where the platform delivers this tenant's webhooks.

contactEmail?string

entitlementOverrides?

Per-tenant entitlement overrides: { features?: string[]; limits?: {...} }. Byte limits as decimal strings.

keyLabel?string

Label for the initial API key minted for this tenant.

isTestMode?boolean

Provision a sandbox tenant: vcp_test_ keys, billable media refused.

Defaultfalse

Response Body

curl -X POST "https://example.com/api/v1/provider/tenants" \  -H "Content-Type: application/json" \  -d '{    "name": "Acme Corp Workspace"  }'

Empty

Provision a subaccount tenant (create + mint key + webhook secret). plainTextKey & webhookSecret returned ONCE.

Authorization

Request Body

Response Body

201

409