Organizations

Update an organization (owner/admin)

patch/v1/orgs/{orgId}

Path parameters

orgIdstring required

Request body

billingAddressLine1string

Max 128 chars. Empty string clears it.

billingAddressLine2string

Max 128 chars. Empty string clears it.

billingCitystring

Max 128 chars. Empty string clears it.

billingCountrystring

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

billingEmailstring

billingNamestring

Name to print on invoices, max 128 chars. Empty string clears it (the org name is then used).

billingPostalCodestring

Max 32 chars. Empty string clears it.

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; "pending" = a verification hold: the account can sign in and use the dashboard but cannot be funded, new deploys are paused, existing workloads keep running, and it clears on review (usually under one business day); "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.

billingAddressLine1string

billingAddressLine2string

billingCitystring

billingCountrystring

ISO 3166-1 alpha-2 country of the billing address.

billingEmailstring required

billingNamestring

Name printed on invoices and credit notes. Empty means the org name is used.

billingPostalCodestring

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.

Changes

Changed in 2 of the 36 revisions of this API.18

Sep 23, 2026623ef854267a12See the full diff
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
Aug 21, 20266e0f476b58766See the full diff
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the new optional request property
  new-optional-request-property
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added

Full history