Usage and balance for the current period

GET

/entitlements/usage

curl --request GET \
  --url https://api.sloose.com/entitlements/usage \
  --header 'Authorization: Bearer <token>'

• Production
• Staging

Straight from the ledger, without resolving the whole entitlement set. Cheaper than /entitlements/me when all you need is the counters.

Authorizations

• sessionAuth
• apiTokenAuth

Responses

200

Period counters and credit balance.

Media typeapplication/json

object

usage

required

object

periodStart

required

string

periodEnd

required

string

rowsWritten

required

number

rowsOverage

required

number

creditsUsed

required

number

runs

required

number

balance

required

AI credits. Included credits reset each period; purchased ones do not.

object

included

required

number

purchased

required

number

reserved

required

number

available

required

Included + purchased − reserved

number

periodStart

required

string

periodEnd

required

string

Example^generated

{
  "usage": {
    "periodStart": "example",
    "periodEnd": "example",
    "rowsWritten": 1,
    "rowsOverage": 1,
    "creditsUsed": 1,
    "runs": 1
  },
  "balance": {
    "included": 1,
    "purchased": 1,
    "reserved": 1,
    "available": 1,
    "periodStart": "example",
    "periodEnd": "example"
  }
}

401

No bearer, or one that is expired, revoked or no longer resolves to a member.

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

403

The bearer’s role is too low, or it was issued for a different org.

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}