Organizations
Update organization plan
PATCH
/api/orgs/plan/{orgId}SDK setup
Create a client and set credentials (JWT and/or API key) before calling the API. Match the authentication type shown above.
import { Configuration, OrganizationsApi } from 'mudbase-sdk';
const configuration = new Configuration({
basePath: 'https://cloud.mudbase.dev',
accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});
const organizations = new OrganizationsApi(configuration);import { Configuration, OrganizationsApi } from 'mudbase-sdk';
const configuration = new Configuration({
basePath: 'https://cloud.mudbase.dev',
accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});
const organizations = new OrganizationsApi(configuration);Example request
Call this endpoint using the client from SDK setup. Use View HTTP for a raw cURL example.
const { data: result } = await organizations.updateOrganizationPlan(
"org_TlySIiaTPn",
{
plan: "microchip synthesize"
}
);const { data: result } = await organizations.updateOrganizationPlan(
"org_TlySIiaTPn",
{
plan: "microchip synthesize"
}
);Playground
liveTest this endpoint with your own credentials. Your requests will be sent to the live API.
Use the auth endpoints to obtain a JWT.
No Request Yet
Send a request to see the full inspector
Authentication
Requires JWT
Note
Include your JWT in the
Authorization: Bearer YOUR_TOKEN header (user-facing apps, RBAC). View authentication guide →Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
orgId | string | Yes | — |
Request Body
json
{
"plan": "pro"
}{
"plan": "pro"
}Responses
200Plan updated (or error if trying to upgrade to paid)
Plan updated successfully
json
{
"message": "Organization plan updated successfully",
"org": {
"_id": "685acbe0e129932fbb7a0fc3",
"name": "Mudbase Inc",
"slug": "mudbase-inc"
}
}{
"message": "Organization plan updated successfully",
"org": {
"_id": "685acbe0e129932fbb7a0fc3",
"name": "Mudbase Inc",
"slug": "mudbase-inc"
}
}Upgrade requires billing
json
{
"error": "Plan upgrades must be done through the billing system",
"message": "Please use /api/billing routes to upgrade your plan"
}{
"error": "Plan upgrades must be done through the billing system",
"message": "Please use /api/billing routes to upgrade your plan"
}