> ## Documentation Index
> Fetch the complete documentation index at: https://docs.qumo-deploy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# client.tenants

> Tenants — the top-level multi-tenancy boundary.

Tenants — the top-level multi-tenancy boundary.

Reach it as `client.tenants` on a [`QumoClient`](/sdk/reference/client#qumoclient).

### list

```ts theme={null}
list(params?: { limit?: number; offset?: number; plan?: string }): Promise<Tenant[]>
```

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`](/sdk/reference/types#tenant)

### create

```ts theme={null}
create(name: string): Promise<Tenant>
```

Creates a workspace through the platform admin API (platform admins only).
Users create their own with [`TenantsResource.createOwned`](/sdk/reference/tenants#createowned).

Types: [`Tenant`](/sdk/reference/types#tenant)

### createOwned

```ts theme={null}
createOwned(name: string): Promise<Tenant>
```

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`](/sdk/reference/types#tenant)

### get

```ts theme={null}
get(id: string): Promise<Tenant>
```

Returns one workspace.

Types: [`Tenant`](/sdk/reference/types#tenant)

### update

```ts theme={null}
update(id: string, name: string): Promise<Tenant>
```

Renames a workspace.

Types: [`Tenant`](/sdk/reference/types#tenant)

### updateSettings

```ts theme={null}
updateSettings(id: string, patch: { name?: string; billing_email?: string | null }): Promise<Tenant>
```

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

Types: [`Tenant`](/sdk/reference/types#tenant)

### delete

```ts theme={null}
delete(id: string): Promise<void>
```

Permanently deletes a workspace and everything in it.

### getUsage

```ts theme={null}
getUsage(id: string, params: { metric: string; granularity: "hour" | "day" }): Promise<TenantUsage>
```

A workspace's usage of one metric over time, across all its projects.

Types: [`TenantUsage`](/sdk/reference/types#tenantusage)

### listInvoices

```ts theme={null}
listInvoices(id: string): Promise<Invoice[]>
```

Lists a workspace's Stripe invoices, newest first.

Types: [`Invoice`](/sdk/reference/types#invoice)