FAfax
Fax AI

Get AI credit summary

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

get/accounts/self/ai/credits

Request

  • Base URL
    https://restapi.fax.plus/v3
  • URL
    https://restapi.fax.plus/v3/accounts/self/ai/credits
  • Auth
    • 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
    • or HTTP bearer

Response

Response containing AI credit summary

credits_remaininginteger required

Number of AI credits remaining

reload_atstring date-time nullable

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

Example response

{
  "credits_remaining": 450,
  "usage": [
    {
      "feature": "ocr",
      "credits_used": 30
    },
    {
      "feature": "field_extraction",
      "credits_used": 20
    }
  ],
  "reload_at": "2026-04-01T00:00:00Z"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.