Sign in
Organizations

Update an organization

Authorization

A OAuth token must have at least one of the following scopes in order to use this API endpoint:

OAuth Scopes

ResourceScopes
Organizationwrite_organization
patch/organizations/{name}

Path parameters

namestring required

The name of the organization

Request body

billing_emailstring

The billing email for the organization

idp_managed_rolesboolean

Whether or not the IdP provider is be responsible for managing roles in PlanetScale

invoice_budget_amountnumber

The expected monthly budget for the organization

Response

Returns the updated organization

idstring required

The ID for the organization

namestring required

The name of the organization

billing_emailstring required

The billing email of the organization

created_atstring required

When the organization was created

updated_atstring required

When the organization was last updated

planstring required

The billing plan of the organization

valid_billing_infoboolean required

Whether or not the organization's billing information is valid

ssoboolean required

Whether or not SSO is enabled on the organization

sso_directoryboolean required

Whether or not the organization uses an SSO directory

single_tenancyboolean required

Whether or not the organization has single tenancy enabled

managed_tenancyboolean required

Whether or not the organization has managed tenancy enabled

has_past_due_invoicesboolean required

Whether or not the organization has past due billing invoices

database_countnumber required

The number of databases in the organization

sso_portal_urlstring required

The URL of the organization's SSO portal

featuresobject required

Features that can be enabled on the organization

idp_managed_rolesboolean required

Whether or not the IdP provider is be responsible for managing roles in PlanetScale

invoice_budget_amountnumber required

The expected monthly budget for the organization

keyspace_shard_limitnumber required

The keyspace shard limit for the organization

has_cardboolean required

Whether or not the organization has a payment method on file

payment_info_requiredboolean required

Whether or not the organization requires payment information

Changes