Account Balance

Get account balance info

This endpoint is considered legacy and is scheduled for future deprecation. Please plan to migrate to the new /v2/billing and /v2/billing/detail endpoints documented below.

You can query your account balance and other billing details through this API. To make a request, you only need your AIMLAPI key obtained from your account dashboard.

get

Body

application/json

–Optional

Responses

200Success

application/json

balancenumberRequired

The total credits associated with the provided API key.

Example: 10000000

lowBalancebooleanRequired

True if the balance is below the threshold.

Example: false

lowBalanceThresholdnumberRequired

Threshold for switching to low balance status.

Example: 10000

lastUpdatedstring · date-timeRequired

The date of the request — i.e., the current date.

Example: 2025-11-25T17:45:00Z

autoDebitStatusstringRequired

Indicates whether auto top-up is enabled for the plan.

Example: disabled

statusstringRequired

The status of the plan associated with the provided API key.

Example: current

statusExplanationstringRequired

A more detailed explanation of the plan status.

Example: Balance is current and up to date

get/v1/billing/balance

cURLJavaScriptPython

curl -L \
  --request GET \
  --url 'https://api.aimlapi.com/v1/billing/balance' \
  --header 'Authorization: Bearer <YOUR_AIMLAPI_KEY>'

200Success

{
  "balance": 10000000,
  "lowBalance": false,
  "lowBalanceThreshold": 10000,
  "lastUpdated": "2025-11-25T17:45:00Z",
  "autoDebitStatus": "disabled",
  "status": "current",
  "statusExplanation": "Balance is current and up to date"
}

Get balance info

Returns a user's balance.

get

Body

application/json

–Optional

Responses

200Success

application/json

current_balancenumberRequired

current user balance in USD.

Example: 123.45

currencystringRequired

balance currency (always USD)

Example: USD

get/v2/billing

cURLJavaScriptPython

curl -L \
  --request GET \
  --url 'https://api.aimlapi.com/v2/billing' \
  --header 'Authorization: Bearer <YOUR_AIMLAPI_KEY>'

200Success

{
  "current_balance": 123.45,
  "currency": "USD"
}

Get detailed billing info

Returns detailed billing information, balance and auto top-up settings.

get

Body

application/json

–Optional

Responses

200Success

application/json

user_idnumberOptional

User ID.

Example: 111

emailstringOptional

User email.

Example: [e-mail]

current_balancenumberOptional

Current balance in USD.

Example: 100.5

currencystringOptional

Currency (always USD).

Example: USD

get/v2/billing/detail

cURLJavaScriptPython

curl -L \
  --request GET \
  --url 'https://api.aimlapi.com/v2/billing/detail' \
  --header 'Authorization: Bearer <YOUR_AIMLAPI_KEY>'

200Success

{
  "user_id": 111,
  "email": "[e-mail]",
  "current_balance": 100.5,
  "currency": "USD",
  "autotopup_settings": {
    "is_enabled": true,
    "threshold": 50,
    "amount": 100,
    "currency": "USD"
  }
}