One shared credit pool

Who this is for

Anyone on a team plan who is about to be surprised by a balance. If two people use Boardwalk and one of them uses the API, this page is the one that prevents the surprise.

The rule

The worked case: your plan includes 500 credits. A teammate downloads a CSV of 200 projects. You then pull 300 records over the API. The pool is now at zero, and your next metered request is refused with a 402 and a quote — not truncated.

Check the balance before you assume it

curl 'https://api.boardwalkai.com/api/v1/account/credits' \
  -H 'Authorization: Bearer bwk_live_YOUR_KEY'

{
  "data": {
    "plan": "state",
    "planDisplayName": "State",
    "creditsLimit": 500,
    "creditsUsed": 200,
    "creditsRemaining": 300,
    "periodStart": "2026-08-01",
    "periodEnd": "2026-08-31",
    "rateLimit": 60,
    "rateLimitPer": "minute",
    "isTeamPool": true,
    "poolUserId": 8814
  }
}

isTeamPool: true is the field that matters here. It says the numbers you are reading are the team's, not yours, and that a colleague can move them while you are not looking. poolUserId identifies the pool so two seats can tell they are drawing on the same one.

What this means in practice

• Do not build a client that assumes its own balance is the whole story. Read X-Credits-Remaining off each response, or re-read the balance, rather than decrementing a local counter.
• Before a large pull, price it with the free count endpoint — it reads the same pool and reports the same remaining figure.
• A 402 is not a failure of your credentials. Your key is fine; the pool is empty.

Next