> ## 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.organizations

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

Organizations — the top-level multi-tenancy boundary.

Reach it as `client.organizations` on a [`QumoClient`](https://docs.qumo-deploy.com/sdk/reference/client#qumoclient).

### list

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

Lists every organization (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: [`Organization`](https://docs.qumo-deploy.com/sdk/reference/types#organization)

### create

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

Creates an organization through the platform admin API (platform admins only).
Users create their own with [`OrganizationsResource.createOwned`](https://docs.qumo-deploy.com/sdk/reference/organizations#createowned).

Types: [`Organization`](https://docs.qumo-deploy.com/sdk/reference/types#organization)

### createOwned

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

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

Types: [`Organization`](https://docs.qumo-deploy.com/sdk/reference/types#organization)

### get

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

Returns one organization.

Types: [`Organization`](https://docs.qumo-deploy.com/sdk/reference/types#organization)

### update

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

Renames an organization.

Types: [`Organization`](https://docs.qumo-deploy.com/sdk/reference/types#organization)

### updateSettings

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

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

Types: [`Organization`](https://docs.qumo-deploy.com/sdk/reference/types#organization)

### delete

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

Permanently deletes an organization and everything in it.

### getUsage

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

An organization's usage of one metric over time, across all its projects.

Types: [`OrganizationUsage`](https://docs.qumo-deploy.com/sdk/reference/types#organizationusage)

### listInvoices

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

Lists an organization's Stripe invoices, newest first.

Types: [`Invoice`](https://docs.qumo-deploy.com/sdk/reference/types#invoice)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.