Skip to main content
GET
Get credit balance

Authorizations

Authorization
string
header
required

Organization API key, generated in studio.sidenet.ai. Backend only — never in a browser.

Response

The balance

balance
number

Credits left, in USD. The spend gate closes at 0.

period_start
string<date>

First day of the current statement month (UTC).

period_end
string<date>

First day of the next month (exclusive).

opening_balance
number

Credits carried into the current month from the previous statement.

credits_added
number

Completed purchases not yet on a closed statement.

consumed
number

Cost of requests started since the month opened.

spend
object | null

Attributed spend in USD over four UTC windows. Null only when the figures could not be read.

pricing
object