Query
query SidekickCreditBalance {
sidekickCreditBalance {
status
allowance {
grant
used
remaining
periodEndsAt
lowBalanceThreshold
}
topup {
remaining
}
}
}Response
{
"data": {
"sidekickCreditBalance": {
"status": "TRACKED",
"allowance": {
"grant": 1,
"used": 1,
"remaining": 1,
"periodEndsAt": "string",
"lowBalanceThreshold": 1
},
"topup": {
"remaining": 1
}
}
}
}Queries
sidekickCreditBalance
The workspace’s current Sidekick (Plain) credit balance: the monthly allowance grant/used/remaining and when it resets, plus any purchased top-up remaining. Use it to answer how many credits are left. Requires the billing:read permission.
QUERY
sidekickCreditBalance: SidekickCreditBalance!Returns
status
Whether metered credits apply. When UNMETERED (e.g. a trial), Sidekick is free and there is no balance — both buckets are null.
allowance
The recurring monthly allowance bucket. Null when the workspace has no allowance credit product attached (e.g. a plan without credits, or pre-onboarding).
The purchased top-up bucket, consumed after the monthly allowance is exhausted. Null when the workspace has no top-up balance.
Query
query SidekickCreditBalance {
sidekickCreditBalance {
status
allowance {
grant
used
remaining
periodEndsAt
lowBalanceThreshold
}
topup {
remaining
}
}
}Response
{
"data": {
"sidekickCreditBalance": {
"status": "TRACKED",
"allowance": {
"grant": 1,
"used": 1,
"remaining": 1,
"periodEndsAt": "string",
"lowBalanceThreshold": 1
},
"topup": {
"remaining": 1
}
}
}
}Was this page helpful?