Subscription

Get the AI credit balance

Return the AI credit wallet the authenticated key can spend from: credits available now, the monthly included allowance and how much of it is used, purchased pack balance, plan tier, and when the included pool next resets. Credits are a shared WORKSPACE wallet owned by the billing owner, and every active member draws the same pool. This endpoint reports that wallet, not a personal figure, so a member key sees the balance it can actually spend. workspace.role reports the caller role. Requires the billing:read scope. Bypasses the API add-on paywall so a user can always inspect their own balance. Returns 503 wallet_unavailable if the wallet lookup degrades, rather than reporting a misleading zero balance.

get/api/v1/credits

Request

  • Base URL: https://www.poster.ly
  • URL: https://www.poster.ly/api/v1/credits
  • Auth: HTTP bearer

Response

Credit balance fetched successfully.

Example response

{
  "credits": {
    "available": 3532,
    "included": {
      "monthly": 4000,
      "used": 468,
      "remaining": 3532
    },
    "purchased_balance": 0,
    "plan_tier": "agency",
    "is_trial": false,
    "period_start": "2026-08-01T00:00:00.000Z",
    "resets_at": "2026-09-01T00:00:00.000Z",
    "workspace": {
      "role": "owner",
      "shared_wallet": true
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.