API reference / remove.bg account info

remove.bg account info

Read your balance in the remove.bg account format, for clients that check it. subscription is your remaining monthly free credits; payg is purchased credits. Clearcut has no separate free API calls.

GET/v1.0/account
Coming from remove.bg? Keep your requests. Change the host from https://api.remove.bg to https://clearcut.sh and send a Clearcut key in X-Api-Key. Read the API migration guide →
Authenticate with X-API-Key. Keep your key on your server; never embed it in a public website.

Response

200 · Success
{
  "data": {
    "attributes": {
      "credits": {
        "total": 42,
        "subscription": 30,
        "payg": 12,
        "enterprise": 0
      },
      "api": {
        "free_calls": 0,
        "sizes": "all"
      }
    }
  }
}

Errors use a structured error.code and error.message. See error handling →

Clearcut support