Get Organization Usage

curl https://api.bctrl.ai/v1/usage \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "blockedReasons": [
    "insufficientCredits"
  ],
  "computedAt": "2024-06-10T12:00:00Z",
  "credits": {
    "available": 25.75,
    "breakdown": {
      "aiCredits": 10.5,
      "browserCredits": 5,
      "captchaCredits": 3.25,
      "filesCredits": 4,
      "proxyCredits": 3
    },
    "effectiveBalance": 25.75,
    "monthlyLimit": 100,
    "monthlyRemaining": 74.25,
    "monthlyUsed": 25.75,
    "outstandingDebt": 0,
    "purchasedRemaining": 50
  },
  "cycle": {
    "endsAt": "2024-06-30T23:59:59Z",
    "startedAt": "2024-06-01T00:00:00Z"
  },
  "isBlocked": true,
  "organizationId": "org_9f8b7c6d5e4a3b2c1d0e"
}

Get current organization credit usage and balance.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Response

blockedReasonslist of enums

computedAtdatetime

creditsobject

cycleobject

isBlockedboolean

organizationIdstring>=1 character

Errors

401

Unauthorized Error

403

Forbidden Error