---
title: "Get Credits"
method: GET
path: "/api/billing/{team_key}/credits"
tags: ["billing"]
---

# Get Credits

`GET /api/billing/{team_key}/credits`

## Request

- Base URL: `https://api.superit.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.superit.ai/api/billing/{team_key}/credits`
- Auth: HTTP bearer

## Path parameters

- `team_key` string, required

## Query parameters

- `cycle` string, required

## Response `200`

Successful Response

- CreditUsageResponse: A cycle's usage priced in credits against the team's plan allowance.
  - `cycleKey` string, required
  - `periodStart` string, date-time, required
  - `periodEnd` string, date-time, required
  - `planName` string, nullable, required
  - `planCredits` integer, nullable, required
  - `totalCredits` string, required
  - `consumedCredits` string, nullable: Credits actually allocated in the active entitlement interval; excludes unfunded usage.
  - `spendableCredits` string, nullable: Unspent allowance plus live grant balances at the reporting instant.
  - `outcomes` CreditOutcomeResponse[], required
    - `outcome` string, required
    - `label` string, required
    - `count` integer, required
    - `credits` string, required
  - `categories` CreditCategoryResponse[], required
    - `category` string, required
    - `label` string, required
    - `count` integer, required
    - `credits` string, required
  - `grants` CreditGrantBalanceResponse[], required: Credit grants (e.g. the PSA bonus) live at the cycle's end or now, spent only on usage beyond the plan allowance.
    - `key` string, required
    - `source` 'offer' | 'topup' | 'upgrade', required
    - `usdCents` integer, required
    - `credits` integer, required
    - `creditsRemaining` string, required
    - `grantedAt` string, date-time, required
    - `expiresAt` string, date-time, required

## Other responses

- `400`: Invalid input
- `401`: Not authenticated
- `403`: Forbidden
- `404`: Not found
- `405`: Method not allowed
- `409`: Conflict
- `422`: Validation Error

---

[API](https://skmtc.dev/superit/apis/super-it-api.md) - [All operations](https://skmtc.dev/superit/apis/super-it-api/llms.txt) - [OpenAPI document](https://skmtc.dev/superit/apis/super-it-api/revisions/4944d556c2bb?raw)