User Credit Details

Description

This API returns current credits and total credits of the user.

This API is rate-limited to 100 requests per minute per user.

API Request & Response Guidelines

🟢 200 OK

User Credit Details Retrieved Successfully

Returned when the system successfully fetches the user's current and total credit information.

{
  "status": true,
  "message": "",
  "data": {
    "current_credits": 120,
    "total_credits": 500
  }
}

🟠 401 Unauthorized

Missing or Invalid Authorization

Returned when:

Authorization header is missing

API key is invalid

API key is not associated with a user

{
  "status": false,
  "message": "You are not Authorized"
}

🟠 429 Too Many Requests

Returned when the request limit is exceeded.

Limit:

100 requests per minute per user/API key

{
  "status": false,
  "message": "Rate limit exceeded."
}

🔴 500 Internal Server Error

Unexpected Server Error

Returned when an unexpected error occurs outside normal validation flow.

{
  "status": false,
  "message": "Service unavailable"
}

Generic format:

{
  "status": false,
  "message": "<error message>"
}

Important Note

Consumers of this API should not rely solely on the HTTP status code. Some validation and business-rule failures may return HTTP 200 OK with "status": false in the response body. Always inspect the status field to determine whether the operation succeeded.

User Credit Details

Description#

API Request & Response Guidelines#

🟢 200 OK#

User Credit Details Retrieved Successfully#

🟠 401 Unauthorized#

Missing or Invalid Authorization#

🟠 429 Too Many Requests#

🔴 500 Internal Server Error#

Unexpected Server Error#

Important Note#

Request

Responses