Get Spend User Detail

GET

/metering-service/api/v2/organizations/{organization_id}/spend/users/{user_id}

Describes one user's spend for a billing period: their spend against their limit, tokens, and spend per assistant. A call for a user with no usage returns a zero-spend view with a 200, not a 404.
Only Organization admin can call this endpoint.

Path Parameters

organization_id: The Ejento AI organization ID.

user_id: The user whose spend is being read.

Query Parameters

billing_period: Defines the billing period in YYYY-MM format. Defaults to the current month.

Returns

JSON Response: the user's spend detail for the period in a success envelope.

Current Version

2.0.0

Request

Path Params

Query Params

Header Params

Responses

🟢200

application/json

Successful Response

Bodyapplication/json

🟠400

🟠401

🟠403

🟠422

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https:///metering-service/api/v2/organizations//spend/users/?billing_period=undefined' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "user_id": 0,
        "first_name": "string",
        "last_name": "string",
        "email": "string",
        "billing_period": "string",
        "spend": "string",
        "limit_amount": "string",
        "approved_increase_amount": "string",
        "pct_used": 0,
        "input_tokens": 0,
        "output_tokens": 0,
        "total_tokens": 0,
        "sessions": 0,
        "status": "ACTIVE",
        "blocked_reason": "USER_LIMIT",
        "blocked_since": "2019-08-24T14:15:22.123Z",
        "resets_at": "2019-08-24T14:15:22.123Z",
        "has_open_increase_request": true,
        "by_agent": [
            {
                "agent_id": 0,
                "agent_name": "string",
                "spend": "string",
                "total_tokens": 0
            }
        ]
    }
}

Get Spend Users Table

Get My Spend