API Reference
API Reference / Endpoints / Platform

Read remaining API call allowance

/v1/credits

Read remaining API calls for the authenticated workspace.

GET/v1/credits
Auth: API keyBilling: FreeBehavior: SyncScopes: analytics:read
GETSyncNo bodyanalytics:read

When to use it

Use this when you need a lightweight allowance check inside your integration, especially before launching higher-cost workflows.

Behavior on success

Returns a completed payload on the normal success path.

Integration shape

Authorization model
analytics:read
Request format
No request body
Polling pattern
No polling required on the normal success path.

Example request

GET /v1/credits
const response = await fetch('https://prod-backup-backend.wubble.ai/v1/credits', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.WUBBLE_API_KEY}`,
  },
});

const payload = await response.json();
console.log(payload);

Example response

Response shapejson
{
  "success": true,
  "data": {
    "credits_remaining": 154,
    "api_calls_remaining": 154,
    "monthly_api_call_allowance": 155,
    "plan": "free",
    "reset_at": "2026-06-01T00:00:00.000Z",
    "deprecated": {
      "credits_label": "Use api_calls_remaining / monthly_api_call_allowance"
    }
  }
}

Implementation notes

This compatibility route still returns legacy credit field names, but the values now represent API call allowance.

Production guidance

Pair this route with idempotency on POST requests and either request polling or webhooks whenever the response is asynchronous.
Was this page helpful?
Previous
Usage logsNext