---
title: "Current credit balance (in credits)"
method: GET
path: "/credits"
tags: ["Billing"]
---

# Current credit balance (in credits)

`GET /credits`

## Request

- Base URL: `https://api.aginera.ai/partner/v1`
- URL: `https://api.aginera.ai/partner/v1/credits`
- Auth: OAuth 2 (authorization code, authorization URL `https://auth.aginera.ai/oauth/authorize`, token URL `https://auth.aginera.ai/oauth/token`; client credentials, token URL `https://login.microsoftonline.com/65f567a9-6e6a-4f81-863c-aea4ece1f8eb/oauth2/v2.0/token`, scopes: `billing:read`)

## Response `200`

OK

- Credits
  - `available` number, required
  - `held` number, required
  - `purchased_total` number
  - `consumed_total` number
  - `environment` 'sandbox' | 'production', required
  - `billing_mode` 'ledger' | 'artifact', required
  - `low_balance_threshold` number
  - `rate_card` object[], required
    - `operation` string, required
    - `credits` number, required

## Other responses

- `default`: Error (RFC 7807)

---

[API](https://skmtc.dev/aginera/apis/aginera-takeoff-estimation-api.md) · [All operations](https://skmtc.dev/aginera/apis/aginera-takeoff-estimation-api/llms.txt) · [OpenAPI document](https://skmtc.dev/aginera/apis/aginera-takeoff-estimation-api/revisions/39115958da1e?raw)