Get Spend Overview

GET

/metering-service/api/v2/organizations/{organization_id}/spend/overview

Describes the organization's total spend for one billing period, measured against the organization limit.

Spend is the cost of metered usage in USD. Every spend value in this API is a decimal string rather than a number, to avoid precision loss.

A billing period is one calendar month, written YYYY-MM. Spend accumulates within a period and starts again when the next one begins.

A session is one chat conversation a user started. The per-user reads report how many each user started.

limit_amount and pct_used are null when the organization limit is Unlimited, or when it is a $0 limit.
Only Organization admin can call this endpoint.

Path Parameters

organization_id: The Ejento AI organization ID.

Query Parameters

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

Returns

JSON Response: the organization's spend overview 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/overview?billing_period=undefined' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "billing_period": "string",
        "spend": "string",
        "limit_amount": "string",
        "pct_used": 0,
        "total_tokens": 0,
        "resets_at": "2019-08-24T14:15:22.123Z",
        "enforcement_status": {
            "status": "ACTIVE",
            "blocked_reason": "USER_LIMIT",
            "blocked_since": "2019-08-24T14:15:22.123Z"
        }
    }
}

Deny Spend Limit Increase Request

Get Spend Trends Summary