Skip to navigation
Spyglass APITeam management

Get the team's credit usage

Credits left on the API key’s team, the credits included in the plan, and the current billing period. Granted credits count toward remainingCredits and not planCredits.

Limited to 120 requests per minute per user. This call is free and does not use credits. It still responds when the team is out of credits.

Authentication

AuthorizationBearer

An API key from Settings → API, prefixed sg_live_.

Response

Credit balance for the current billing period.
remainingCreditsinteger
Credits left in this billing period, including granted credits.
planCreditsinteger
Credits included in the team's plan for this billing period.
billingPeriodStartstring
Start of the current billing period, UTC.
billingPeriodEndstring
End of the current billing period, UTC.

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
405
Method Not Allowed Error
429
Too Many Requests Error
500
Internal Server Error