# Credit balance

`GET /api/agent-hub/credits`  (operationId: `getCredits`, group: Credits)

The plan, the current calendar-month cycle (resets on the 1st, India time), credits used, the allocation (bundle plus active top-ups), remaining credits and any overage. Also returns usage by feature. Requires the AI agent to be enabled for the workspace.

Part of the full API, which is included in the Scale plan. Any authenticated caller in a workspace with the AI agent enabled.

**Response 200**: OK (schema `Credits`)

| Field | Type | Description |
| --- | --- | --- |
| `plan` | object |  |
| `plan.key` | string |  |
| `plan.label` | string |  |
| `plan.monthly_inr` | number |  |
| `plan.credits_allocation` | integer |  |
| `plan.overage_inr_per_credit` | number |  |
| `cycle` | object |  |
| `cycle.start` | string (date-time) |  |
| `cycle.end` | string (date-time) |  |
| `cycle.kind` | string | calendar_month. |
| `used_credits` | number |  |
| `allocation` | number | Plan bundle plus active top-ups. |
| `topup_credits` | number |  |
| `remaining_credits` | number |  |
| `overage_credits` | number |  |
| `overage_inr` | number |  |

Example:

```json
{
  "plan": {
    "key": "growth",
    "label": "Growth",
    "monthly_inr": 2499,
    "credits_allocation": 2500,
    "overage_inr_per_credit": 0.2
  },
  "cycle": {
    "start": "2026-09-30T18:30:00.000Z",
    "end": "2026-10-02T09:30:00.000Z",
    "kind": "calendar_month"
  },
  "used_credits": 3120.4,
  "allocation": 12500,
  "topup_credits": 10000,
  "remaining_credits": 9379.6,
  "overage_credits": 0,
  "overage_inr": 0
}
```

Part of the InboxWA API reference: https://inboxwa.online/docs/api . Full reference as one document: https://inboxwa.online/docs/api.md . OpenAPI: https://inboxwa.online/openapi.json