Get Credits
Usage
Get Credits
Pooled credit balance, grant breakdown, and expiry schedule
GET
Get Credits
Beta. Credits are the single billing currency across the Signa API. This endpoint’s schema is new and may evolve before general availability.
Overview
Returns the authenticated organization’s pooled credit balance: the spendable balance across all active grants, a breakdown of remaining credits by grant type (plan vs addon vs promo), and the per-grant expiry schedule in consumption
order (plan first, then oldest-expiry-first).
Requires the billing:read scope. Querying credits does not consume any credits.
Response
Always
"credit_balance".Authoritative spendable pooled balance. Reconciles exactly:
balance = (plan + addon + promo) - reserved - pending. May be negative under the debt floor.Credits held by open reservations (reserved but not yet settled or refunded).
Billable spend not yet attributed to specific grants by the hourly applier.
Request ID for debugging.
Code Examples
Errors
| Status | Type | Description |
|---|---|---|
| 401 | unauthorized | Missing or invalid API key |
| 403 | forbidden | API key lacks billing:read |
| 429 | rate_limited | Too many requests |
Related Endpoints
- Get Usage Summary — daily usage breakdown in credit terms
- Get Usage — current billing period totals by endpoint type