Billing

Get billing estimate and forecast

Returns current-month overage estimate and an optional end-of-month forecast for the authenticated organization. Includes spend limit settings (soft/hard) and whether usage is currently blocked. Requires org-level JWT.

AuthBearer (JWT)
GroupBilling
Rate limitSee Rate Limits
GET/api/billing/estimate

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, BillingApi } from 'mudbase-sdk';

const configuration = new Configuration({
  basePath: 'https://cloud.mudbase.dev',
  accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});

const billing = new BillingApi(configuration);
import { Configuration, BillingApi } from 'mudbase-sdk';

const configuration = new Configuration({
  basePath: 'https://cloud.mudbase.dev',
  accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});

const billing = new BillingApi(configuration);

Example request

Call this endpoint using the client from SDK setup. Use View HTTP for a raw cURL example.

const { data: result } = await billing.getBillingEstimate();
const { data: result } = await billing.getBillingEstimate();

Playground

live

Test 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 →

Responses

200Billing estimate and forecast
json
{
  "period": "matrix program",
  "lineItems": [
    {
      "resource": "matrix generate",
      "units": 821.41,
      "amount": 98.35,
      "currency": "UAH",
      "unit": "feed input"
    }
  ],
  "estimatedOverageCents": 578.12,
  "estimatedOverage": "$12.50",
  "forecastOverageCents": 718.66,
  "forecastOverage": "$38.00",
  "message": "Stylish Keyboard designed to make you stand out with lively looks",
  "spendLimits": {
    "softLimitCents": 662.64,
    "hardLimitCents": 901.64,
    "spendBlocked": true
  }
}
{
  "period": "matrix program",
  "lineItems": [
    {
      "resource": "matrix generate",
      "units": 821.41,
      "amount": 98.35,
      "currency": "UAH",
      "unit": "feed input"
    }
  ],
  "estimatedOverageCents": 578.12,
  "estimatedOverage": "$12.50",
  "forecastOverageCents": 718.66,
  "forecastOverage": "$38.00",
  "message": "Stylish Keyboard designed to make you stand out with lively looks",
  "spendLimits": {
    "softLimitCents": 662.64,
    "hardLimitCents": 901.64,
    "spendBlocked": true
  }
}
401—
503—

Errors

CodeMeaning
401—
503—
Run in PostmanDownload OpenAPI

Next

NEXT →API Reference OverviewBase URL, rate limits, pagination, and the full endpoint index.NEXT →AuthenticationAPI keys, Bearer tokens, and user sessions.NEXT →API PlaygroundSearch any endpoint and send a live request.
Edit this page on GitHub