Get Credits Available

Developing

Staging Env

https://staging-api.formi.co.in

GET

/v2/usage/credits

Last modified:2025-07-01 10:40:51

Maintainer:Not configured

Retrieves credit usage and balance information for all agents associated with an outlet over a specified date range.

Request

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://staging-api.formi.co.in/v2/usage/credits?start_date=2025-06-02&end_date=2025-06-02' \
--header 'token: abc-test-1234'

Responses

🟢200Success

application/json

Body

Example


Example Response:

{
  "success": true,
  "message": "Credits fetched successfully",
  "payload": {
    "agents": [
      {
        "agent_id": 101,
        "credits_type": "MINUTE_BASED",
        "filtered_credit_usage": {
          "from_date": "2023-11-01",
          "to_date": "2023-11-30",
          "credit_usage": 450.75
        },
        "available_credits": 549.25,
        "total_recharge": 2000.0,
        "total_usage": 1450.75
      }
    ]
  }
}
Field Descriptions:

agent_id (integer): The unique ID of the agent.

credits_type (string): The billing method for this agent. See definitions below.

filtered_credit_usage (object): An object detailing usage within the requested date range.

available_credits (float): The current remaining credit balance for the agent.

total_recharge (float): The sum of all credit refills for the agent in the specified period.

total_usage (float): The sum of all credit transactions for the agent.

Modified at 2025-07-01 10:40:51

Agent Utilisation

Interaction Utilisation