Organizations
Get organization usage and billing
Get usage statistics and billing information for an organization. Requires: OrgBearerAuth (organization-level authentication only).
GET
/api/orgs/{orgId}/usageSDK 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.getOrganizationUsage("org_7k2Qu5snhv");const { data: result } = await organizations.getOrganizationUsage("org_7k2Qu5snhv");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 | — |
Responses
200Usage and billing information
json
{
"usage": {
"apiCalls": 15000,
"storage": 5000000
},
"limits": {
"apiCalls": 100000,
"storage": 10000000
},
"plan": {
"name": "pro"
},
"billing": {
"status": "active"
},
"suborgs": []
}{
"usage": {
"apiCalls": 15000,
"storage": 5000000
},
"limits": {
"apiCalls": 100000,
"storage": 10000000
},
"plan": {
"name": "pro"
},
"billing": {
"status": "active"
},
"suborgs": []
}