Skip to main content
GET
/
accounts
/
self
/
ai
/
credits
Get AI credit summary
curl --request GET \
  --url https://restapi.fax.plus/v3/accounts/self/ai/credits \
  --header 'Authorization: Bearer <token>'
{
  "credits_remaining": 450,
  "usage": [
    {
      "feature": "ocr",
      "credits_used": 30
    },
    {
      "feature": "field_extraction",
      "credits_used": 20
    }
  ],
  "reload_at": "2026-04-01T00:00:00Z"
}

Documentation Index

Fetch the complete documentation index at: https://apidoc.fax.plus/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

OAuth2 Authorization Grant

Response

Response containing AI credit summary

AI credit summary

credits_remaining
integer
required

Number of AI credits remaining

usage
object[]
required

Credit usage breakdown by feature

reload_at
string<date-time> | null

ISO 8601 timestamp when credits will be reloaded. Null if no reload is scheduled