latestOpenAPI 3.1.02026-08-21151184245.2 KB

6e0f476b5876

Organizations

Update an organization (owner/admin)

patch/v1/orgs/{orgId}

Path parameters

orgIdstring required

Request body

billingEmailstring
namestring
taxCountrystring

ISO 3166-1 alpha-2 (e.g. US, GB). Empty string clears it.

taxIdstring

Tax identifier to store, max 64 chars. Requires taxCountry (in this request or already on the org). Empty string clears it.

Response

Updated

accountStatusstring

User-facing account state derived from the org's trust & safety risk state. "active" = normal; "restricted" = new deploys paused pending review (existing workloads keep running, funding still allowed); "suspended" = read-only, workloads stopped, pending review; "banned" = disabled. Drives the dashboard account-status banner. Omitted/"active" means no banner.

billingEmailstring required
createdAtstring
idstring required
isProviderboolean
namestring required
planstring required
shortIdstring required
slugstring required
taxCountrystring

ISO 3166-1 alpha-2 country whose tax scheme taxId belongs to (e.g. US, GB, SG, DE).

taxIdstring

Customer tax identifier stored on the organization (US EIN, EU/UK VAT, SG GST, etc.), shown on the billing settings page. Requires taxCountry.