---
title: "Get AI credit summary"
method: GET
path: "/accounts/self/ai/credits"
tags: ["Fax AI"]
---

# Get AI credit summary

`GET /accounts/self/ai/credits`

## Request

- Base URL: `https://restapi.fax.plus/v3`
- URL: `https://restapi.fax.plus/v3/accounts/self/ai/credits`
- Auth: one of:
  - OAuth 2
    - Authorization code: `https://accounts.fax.plus/login?response_type=code&client_id=YOUR_CLIENT_ID&redirect_uri=http://localhost&scope=all`
    - Token URL: `https://accounts.fax.plus/token` scopes: `all`
  - HTTP bearer

Get the AI credit summary including remaining credits, usage breakdown by feature, and next reload date. (Permitted scopes: **fax:all:read**, **fax:ai:read**)

## Response `200`

Response containing AI credit summary

- AiCredits: AI credit summary
  - `credits_remaining` integer, required: Number of AI credits remaining
  - `usage` AiCreditUsage[], required: Credit usage breakdown by feature
    - `feature` 'ocr' | 'field_extraction', required: AI feature name
    - `credits_used` integer, required: Number of credits consumed by this feature
  - `reload_at` string, date-time, nullable: ISO 8601 timestamp when credits will be reloaded. Null if no reload is scheduled

## Other responses

- `401`: Error object in case there's a problem with the authorization
- `500`: Error object in case there's a server error

---

[API](https://skmtc.dev/fax/apis/fax-plus-rest-api.md) - [All operations](https://skmtc.dev/fax/apis/fax-plus-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/fax/apis/fax-plus-rest-api/revisions/95a35a892239?raw)