Usage

Usage statistics and billing endpoints

Get current usage

get

Get current usage statistics and billing information

Authorizations
Responses
200

Current usage statistics

application/json
get
GET /api/v1/usage HTTP/1.1
Host: api.visobird.com
Authorization: Bearer JWT
Accept: */*

{
  "currentPeriod": {
    "startDate": "2025-09-05T17:44:15.693Z",
    "endDate": "2025-09-05T17:44:15.693Z",
    "requestsUsed": 1,
    "requestsLimit": 1,
    "percentage": 1
  },
  "plan": {
    "name": "text",
    "price": 1,
    "currency": "text",
    "billingCycle": "monthly"
  },
  "nextBilling": "2025-09-05T17:44:15.693Z"
}

Get usage history

get

Get historical usage data

Authorizations
Query parameters
periodstring · enumOptional

Time period for aggregation

Default: monthlyPossible values:
limitinteger · min: 1 · max: 100Optional

Number of periods to return

Default: 12
Responses
200

Historical usage data

application/json
get
GET /api/v1/usage/history HTTP/1.1
Host: api.visobird.com
Authorization: Bearer JWT
Accept: */*

{
  "monthlyUsage": [
    {
      "period": "text",
      "requests": 1,
      "successRate": 1,
      "avgProcessingTime": 1
    }
  ],
  "totalRequests": 1,
  "avgSuccessRate": 1
}
PreviousAPI Keys