Skip to main content
objectSidekickCreditAllowanceBalance

Fields

grant
Int

Credits granted for the current period. Null when the subscription line item is unavailable — grant/used can't be determined, but remaining still holds.

used
Int

Credits consumed this period, best-effort as max(0, grant - remaining). Null when grant is unavailable.

remaining
Int!

Credits still available in the monthly allowance.

periodEndsAt
String

End of the current billing period in ISO 8601, when the allowance resets. Null when unavailable.

lowBalanceThreshold
Int

The low-balance warning threshold, if one is configured.