Skip to main content
Tenants — the top-level multi-tenancy boundary. Reach it as client.tenants on a QumoClient.

list

Lists every tenant (platform admins only). plan narrows it to one plan by its exact, case-sensitive name — e.g. "Enterprise" for the Enterprise customer list. An unknown name, including "enterprise", is a 400. Types: Tenant

create

Creates a workspace through the platform admin API (platform admins only). Users create their own with TenantsResource.createOwned. Types: Tenant

createOwned

Self-service workspace creation (POST /v1/auth/tenants): any session user may create workspaces they own and admin, capped at 3 owned per user (breach → 422). Unlike create(), this needs no platform permission — the first workspace must be creatable before any IAM context exists. Types: Tenant

get

Returns one workspace. Types: Tenant

update

Renames a workspace. Types: Tenant

updateSettings

Updates a workspace’s name and billing email. Omitted fields are left unchanged; billing_email: null clears it. Types: Tenant

delete

Permanently deletes a workspace and everything in it.

getUsage

A workspace’s usage of one metric over time, across all its projects. Types: TenantUsage

listInvoices

Lists a workspace’s Stripe invoices, newest first. Types: Invoice