Get the caller's credit balance and usage

getapi.modelmatch.com/v1/me/credits

Balance split by bucket (cycle allowance, purchased on-demand, personal), the per-cycle allowance and on-demand unit price, and ledger totals over a window.

The window defaults to the current calendar month to date (UTC). Figures are for the caller's own membership in their active organization — the same organization the API meters requests against.

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Query parameters

startDatestring

Usage window start (YYYY-MM-DD, inclusive)

endDatestring

Usage window end (YYYY-MM-DD, inclusive)

Responses

200objectCredit balance and usage

Show attributes

allowanceobjectrequired

Show child attributes

perCyclenumberrequired

Credits granted to each member per billing cycle

unitPriceCentsnumberrequired

Price of one on-demand credit, in cents

balanceobjectrequired

Show child attributes

cyclenumberrequired

Credits from the current subscription cycle allowance

onDemandnumberrequired

Purchased credits that do not expire with the cycle

personalnumberrequired

The user's personal (non-workspace) credit balance

totalnumberrequired

organizationIdstringrequired

usageobjectrequired

Show child attributes

grantednumberrequired

purchasednumberrequired

spentnumberrequired

spentByCategoryobjectrequired

Show child attributes

ai_agentnumberrequired

ai_chatnumberrequired

apinumberrequired

enrichmentnumberrequired

windowobjectrequired

Show child attributes

endDatestringrequired

ISO-8601, inclusive

startDatestringrequired

ISO-8601, inclusive

400objectValidation error

401objectUnauthorized

403objectForbidden (authenticated, but missing required context — e.g. no active organization)

404objectNot found

413objectResponse payload too large — detail endpoint capped to fit Lambda response limits

502objectAccount service unavailable

503objectSearch timed out or the cluster is overloaded — retry after `Retry-After` seconds.

curl -X GET "https://api.modelmatch.com/v1/me/credits" \
  -H "x-api-key: $MODEL_MATCH_API_KEY"

import { createClient, Me } from "@model-match/api";

createClient({ apiKey: process.env.MODEL_MATCH_API_KEY });

const { data, error } = await Me.getMeCredits();

import os
import requests

res = requests.get(
    "https://api.modelmatch.com/v1/me/credits",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
)
data = res.json()

200 response

{
  "allowance": {
    "perCycle": 123.45,
    "unitPriceCents": 123.45
  },
  "balance": {
    "cycle": 123.45,
    "onDemand": 123.45,
    "personal": 123.45,
    "total": 123.45
  },
  "organizationId": "<string>",
  "usage": {
    "granted": 123.45,
    "purchased": 123.45,
    "spent": 123.45,
    "spentByCategory": {
      "ai_agent": 123.45,
      "ai_chat": 123.45,
      "api": 123.45,
      "enrichment": 123.45
    },
    "window": {
      "endDate": "<string>",
      "startDate": "<string>"
    }
  }
}