> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.getvoxai.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.getvoxai.com/_mcp/server.

# Get usage

GET https://api.getvoxai.com/v1/usage

Returns the use of a billing period, the current one by default: minutes and SMS (included in the plan, used, left, top-ups and debt), the limit of concurrent calls and the calls rejected before an agent answered, by reason. Only quantities are returned, never amounts of money. To read a past period pass its start as `period_start`; the last periods are listed in `available_periods`. For a past period `remaining`, `credits`, `debt`, `credit_packs`, `welcome` and `overage_billing` are `null`, and the included amounts are those of today's plan. Billing periods start on the anchor day of the organization, they are not calendar months. Required scope: `usage:read`. With a test key (`vx_test_`) it behaves exactly as with a live key and consumes nothing.

Reference: https://docs.getvoxai.com/api-reference/usage/get

## Authentication

- `Authorization` header (bearer token, required) — API key created by an Owner or Admin of the organization. Never in the query string.

## Request

### Query parameters

- `period_start` (string, optional) — First day (UTC) of a past billing period, YYYY-MM-DD, to read that period instead of the current one. Only the starts listed in `available_periods` of the response are valid. Omit it for the current period.

### Headers

- `VoxAI-Version` (enum, optional) — API version for this request; defaults to the version the key is pinned to.
  - Allowed values: `2026-10-01`

## Response

### 200

Successful response.

- `object` ("usage", required) — Always `usage`.
- `period` (UsageGetResponsesContentApplicationJsonSchemaPeriod, required) — The billing period the figures refer to.
- `minutes` (UsageGetResponsesContentApplicationJsonSchemaMinutes, required) — Minutes of the period: the amount included in the plan, what was used and what is left, with top-ups, pool, welcome minutes and pay-as-you-go minutes.
- `sms` (UsageGetResponsesContentApplicationJsonSchemaSms, required) — SMS of the period: the amount included in the plan, what was used and what is left, with top-ups.
- `concurrent_calls` (UsageGetResponsesContentApplicationJsonSchemaConcurrentCalls, required) — The limit of simultaneous calls of the plan.
- `missed_calls` (UsageGetResponsesContentApplicationJsonSchemaMissedCalls, required, nullable) — Calls that were rejected before an agent answered, by reason, in the period.
- `available_periods` (list of UsageGetResponsesContentApplicationJsonSchemaAvailablePeriodsItems, required) — The most recent past billing periods, valid values for `period_start`.

## Errors

### 400 Bad Request Error

Possible errors: * `invalid_api_version`: The `VoxAI-Version` header names a version that does not exist. Use one of the versions listed in the `VoxAI-Version` parameter, or omit the header to use the version the key is pinned to. * `invalid_period`: The period is not valid: `from` or `to` with a named period, `custom` without both, a day that does not exist, or `from` after `to`. Use a named `period`, or `period=custom` with `from` and `to` (YYYY-MM-DD, `to` included). * `invalid_request`: The path, query or body does not match the schema of the operation: a missing or unknown field, a wrong type, a value out of range. Fix the request. `details` lists each problem as `{ location, path, message }`: `location` is `params`, `query` or `body` and `path` points to the field.

- `error` (string, required) — Human-readable message in English.
- `code` (string, required) — Stable machine-readable code; decide what to do from this, never from the message.
- `requestId` (string, required) — Same value as the X-Request-Id response header; quote it when contacting support.
- `details` (any, optional) — Extra information, only on some codes. For `invalid_request` it is a list of `{ location, path, message }`, one per field (`location` is `params`, `query` or `body`) with a problem; for the other codes its fields depend on the code (for example `details.limit`).

### 401 Unauthorized Error

Possible errors: - `invalid_api_key`: The `Authorization` header is missing, malformed, or carries a key that does not exist, was revoked or has expired. Send `Authorization: Bearer vx_live_…` (or `vx_test_…`) with an active key. Create a new key in the app if this one expired.

- `error` (string, required) — Human-readable message in English.
- `code` (string, required) — Stable machine-readable code; decide what to do from this, never from the message.
- `requestId` (string, required) — Same value as the X-Request-Id response header; quote it when contacting support.
- `details` (any, optional) — Extra information, only on some codes. For `invalid_request` it is a list of `{ location, path, message }`, one per field (`location` is `params`, `query` or `body`) with a problem; for the other codes its fields depend on the code (for example `details.limit`).

### 403 Forbidden Error

Possible errors: - `feature_not_available`: The plan of the organization does not include the API, or the feature this operation needs. Upgrade the plan in the app. Reads and deletions stay available after a downgrade. - `insufficient_scope`: The key does not have the scope this operation requires (written in the description of the operation). Create a key with the required scope (an Owner or Admin can do it in the app), or ask for the scope to be added. - `ip_not_allowed`: The key has an IP allow-list and the request comes from an address that is not on it. Call from an allowed address, or add this address to the key in the app. - `organization_suspended`: The organization that owns the key is suspended. Contact the organization Owner: nothing can be done through the API until the organization is active again.

- `error` (string, required) — Human-readable message in English.
- `code` (string, required) — Stable machine-readable code; decide what to do from this, never from the message.
- `requestId` (string, required) — Same value as the X-Request-Id response header; quote it when contacting support.
- `details` (any, optional) — Extra information, only on some codes. For `invalid_request` it is a list of `{ location, path, message }`, one per field (`location` is `params`, `query` or `body`) with a problem; for the other codes its fields depend on the code (for example `details.limit`).

### 429 Too Many Requests Error

Possible errors: - `rate_limited`: Too many requests: over the per-minute limit of this key or of the whole organization (see `rate_limits` in `GET /me`), or over a limit of the operation itself, such as the hourly limit on webhook tests and resends. Wait for the number of seconds in the `Retry-After` header, then retry. Spread requests over time.

- `error` (string, required) — Human-readable message in English.
- `code` (string, required) — Stable machine-readable code; decide what to do from this, never from the message.
- `requestId` (string, required) — Same value as the X-Request-Id response header; quote it when contacting support.
- `details` (any, optional) — Extra information, only on some codes. For `invalid_request` it is a list of `{ location, path, message }`, one per field (`location` is `params`, `query` or `body`) with a problem; for the other codes its fields depend on the code (for example `details.limit`).

### 500 Internal Server Error

Possible errors: - `internal_error`: An unexpected error on our side. Retry once after a few seconds. For writes marked as retriable, retry with the same `Idempotency-Key`, so the operation is never done twice; for the other writes, first read the state of the resource, then retry with a NEW key only if the operation did not happen. If it persists, contact support with the `requestId`.

- `error` (string, required) — Human-readable message in English.
- `code` (string, required) — Stable machine-readable code; decide what to do from this, never from the message.
- `requestId` (string, required) — Same value as the X-Request-Id response header; quote it when contacting support.
- `details` (any, optional) — Extra information, only on some codes. For `invalid_request` it is a list of `{ location, path, message }`, one per field (`location` is `params`, `query` or `body`) with a problem; for the other codes its fields depend on the code (for example `details.limit`).

### 503 Service Unavailable Error

Possible errors: - `api_not_configured`: The API is not enabled on this service. Contact support.

- `error` (string, required) — Human-readable message in English.
- `code` (string, required) — Stable machine-readable code; decide what to do from this, never from the message.
- `requestId` (string, required) — Same value as the X-Request-Id response header; quote it when contacting support.
- `details` (any, optional) — Extra information, only on some codes. For `invalid_request` it is a list of `{ location, path, message }`, one per field (`location` is `params`, `query` or `body`) with a problem; for the other codes its fields depend on the code (for example `details.limit`).

## Types

### UsageGetResponsesContentApplicationJsonSchemaPeriod

The billing period the figures refer to.

- `start` (datetime, required) — Start of the billing period, ISO 8601 UTC.
- `end` (datetime, required) — End of the billing period, ISO 8601 UTC.
- `anchor_day` (integer, required) — Day of the month on which the billing periods of the organization start.
- `days_total` (integer, required) — Length of the period in days.
- `days_elapsed` (integer, required) — Days of the period already elapsed. For a past period, all of them.
- `days_remaining` (integer, required) — Days of the period still to come. 0 for a past period.
- `current` (boolean, required) — `true` for the current billing period, `false` when a past one was chosen with `period_start`.

### UsageGetResponsesContentApplicationJsonSchemaMinutes

Minutes of the period: the amount included in the plan, what was used and what is left, with top-ups, pool, welcome minutes and pay-as-you-go minutes.

- `included` (integer, required) — Included in the plan for the period: minutes in `minutes`, messages in `sms`. For a past period it is the allowance of today's plan.
- `used` (integer, required) — How much of `included` was used: minutes (rounded up to a whole minute) or messages.
- `remaining` (integer, required, nullable) — `null` for an unlimited plan and for a past period.
- `credits` (integer, required, nullable) — Prepaid top-ups still available; `null` for a past period.
- `overage` (integer, required) — Consumption beyond the included amount in the period: minutes or messages.
- `unlimited` (boolean, required) — `true` when `included` is 0, which this API reports as no cap.
- `debt` (integer, required, nullable) — Consumption beyond the included amount and the top-ups, still to be recovered (it is taken from the next included amount or top-up); `null` for a past period. `remaining` and `credits` are already net of it.
- `credit_packs` (list of UsageGetResponsesContentApplicationJsonSchemaMinutesCreditPacksItems, required, nullable) — Top-ups with something left and not expired, the one expiring first at the top (the order they are consumed in); `expires_at` is `null` for a top-up that does not expire. `null` for a past period or when they could not be read.
- `source` (enum, required) — Where the included minutes come from. `monthly`: the allowance of the month. `pool`: an annual pool of minutes (annual plans).
  - Allowed values: `monthly`, `pool`
- `pool` (UsageGetResponsesContentApplicationJsonSchemaMinutesPool, required, nullable) — The annual pool of minutes. `null` unless `source` is `pool`.
- `welcome` (UsageGetResponsesContentApplicationJsonSchemaMinutesWelcome, required, nullable) — `null` if the organization has no welcome minutes (and for a past period).
- `overage_billing` (UsageGetResponsesContentApplicationJsonSchemaMinutesOverageBilling, required, nullable) — `null` if the organization never used pay-as-you-go beyond the plan, and for a past period.

### UsageGetResponsesContentApplicationJsonSchemaSms

SMS of the period: the amount included in the plan, what was used and what is left, with top-ups.

- `included` (integer, required) — Included in the plan for the period: minutes in `minutes`, messages in `sms`. For a past period it is the allowance of today's plan.
- `used` (integer, required) — How much of `included` was used: minutes (rounded up to a whole minute) or messages.
- `remaining` (integer, required, nullable) — `null` for an unlimited plan and for a past period.
- `credits` (integer, required, nullable) — Prepaid top-ups still available; `null` for a past period.
- `overage` (integer, required) — Consumption beyond the included amount in the period: minutes or messages.
- `unlimited` (boolean, required) — `true` when `included` is 0, which this API reports as no cap.
- `debt` (integer, required, nullable) — Consumption beyond the included amount and the top-ups, still to be recovered (it is taken from the next included amount or top-up); `null` for a past period. `remaining` and `credits` are already net of it.
- `credit_packs` (list of UsageGetResponsesContentApplicationJsonSchemaSmsCreditPacksItems, required, nullable) — Top-ups with something left and not expired, the one expiring first at the top (the order they are consumed in); `expires_at` is `null` for a top-up that does not expire. `null` for a past period or when they could not be read.

### UsageGetResponsesContentApplicationJsonSchemaConcurrentCalls

The limit of simultaneous calls of the plan.

- `limit` (integer, required) — Maximum number of simultaneous calls allowed by the plan; 0 when the plan has no limit.
- `unlimited` (boolean, required) — `true` when the plan has no limit (`limit` is 0).

### UsageGetResponsesContentApplicationJsonSchemaMissedCalls

Calls that were rejected before an agent answered, by reason, in the period.

- `total` (integer, required) — All the calls rejected before an agent answered, in the period.
- `lines_busy` (integer, required) — Calls rejected because all the lines were busy.
- `quota_exhausted` (integer, required) — Calls rejected because the minutes included in the plan were used up.
- `suspended` (integer, required) — Calls rejected because the organization was suspended.
- `platform` (integer, required) — Calls rejected because the service was at capacity.
- `agent_suspended` (integer, required) — Calls rejected because the agent was suspended by the organization.

### UsageGetResponsesContentApplicationJsonSchemaAvailablePeriodsItems

- `start` (datetime, required) — ISO 8601, UTC.
- `end` (datetime, required) — ISO 8601, UTC.

### UsageGetResponsesContentApplicationJsonSchemaMinutesCreditPacksItems

- `remaining` (integer, required) — What is left of this top-up: minutes or messages.
- `initial` (integer, required) — What this top-up started with: minutes or messages.
- `expires_at` (datetime, required, nullable) — When the top-up expires; `null` if it does not expire.

### UsageGetResponsesContentApplicationJsonSchemaMinutesPool

All values in minutes. With a pool, `included` is `accrued`, not the monthly allowance.

- `mode` (enum, required) — `upfront`: the whole pool is available from the start; `monthly`: it is credited month by month.
  - Allowed values: `upfront`, `monthly`
- `months` (integer, required) — Length of the pool in months.
- `monthly` (integer, required) — Minutes credited each month.
- `total` (integer, required) — Minutes of the whole pool at the end of the contract.
- `accrued` (integer, required) — Minutes credited so far (the whole pool when `mode` is `upfront`).
- `used` (integer, required) — Minutes used from the pool.
- `remaining` (integer, required) — `accrued` minus `used`, net of the debt. Never below 0.
- `carried_over` (integer, required) — Minutes carried over from the previous contract at renewal, already counted in `accrued`.
- `expires_at` (datetime, required, nullable) — When the pool expires; `null` when it has no expiry date.

### UsageGetResponsesContentApplicationJsonSchemaMinutesWelcome

Welcome minutes of a new customer, spent before the included minutes and the top-ups; they do not count in `used`. Minutes only, never an amount.

- `granted_minutes` (integer, required) — Welcome minutes granted at the start.
- `remaining_minutes` (integer, required) — Minutes still spendable now: 0 when exhausted, expired or lost.
- `expires_at` (datetime, required, nullable) — When the welcome minutes expire; `null` when they do not expire.
- `status` (enum, required) — `active`: the minutes can still be spent. `exhausted`: all spent. `expired`: the expiry date has passed. `lost`: no longer spendable.
  - Allowed values: `active`, `exhausted`, `expired`, `lost`

### UsageGetResponsesContentApplicationJsonSchemaMinutesOverageBilling

Minutes only: the spending cap, the amount spent and the rate are never exposed.

- `active` (boolean, required) — Pay-as-you-go beyond the plan is working right now.
- `minutes_accrued` (integer, required) — Pay-as-you-go minutes used in the period.
- `minutes_left_in_cap` (integer, required) — Pay-as-you-go minutes still allowed before the spending cap is reached.

### UsageGetResponsesContentApplicationJsonSchemaSmsCreditPacksItems

- `remaining` (integer, required) — What is left of this top-up: minutes or messages.
- `initial` (integer, required) — What this top-up started with: minutes or messages.
- `expires_at` (datetime, required, nullable) — When the top-up expires; `null` if it does not expire.

## Examples

### Current period

**Response**

```json
{
  "object": "usage",
  "period": {
    "start": "2026-11-01T00:00:00Z",
    "end": "2026-12-01T00:00:00Z",
    "anchor_day": 1,
    "days_total": 30,
    "days_elapsed": 15,
    "days_remaining": 15,
    "current": true
  },
  "minutes": {
    "included": 600,
    "used": 412,
    "remaining": 188,
    "credits": 120,
    "overage": 0,
    "unlimited": false,
    "debt": 0,
    "credit_packs": [
      {
        "remaining": 120,
        "initial": 300,
        "expires_at": "2027-05-01T00:00:00Z"
      }
    ],
    "source": "monthly",
    "pool": null,
    "welcome": null,
    "overage_billing": null
  },
  "sms": {
    "included": 100,
    "used": 23,
    "remaining": 77,
    "credits": 0,
    "overage": 0,
    "unlimited": false,
    "debt": 0,
    "credit_packs": []
  },
  "concurrent_calls": {
    "limit": 3,
    "unlimited": false
  },
  "missed_calls": {
    "total": 7,
    "lines_busy": 5,
    "quota_exhausted": 0,
    "suspended": 0,
    "platform": 0,
    "agent_suspended": 2
  },
  "available_periods": [
    {
      "start": "2026-10-01T00:00:00Z",
      "end": "2026-11-01T00:00:00Z"
    },
    {
      "start": "2026-09-01T00:00:00Z",
      "end": "2026-10-01T00:00:00Z"
    },
    {
      "start": "2026-08-01T00:00:00Z",
      "end": "2026-09-01T00:00:00Z"
    }
  ]
}
```

**SDK Code**

```python Current period
import requests

url = "https://api.getvoxai.com/v1/usage"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript Current period
const url = 'https://api.getvoxai.com/v1/usage';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Current period
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getvoxai.com/v1/usage"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Current period
require 'uri'
require 'net/http'

url = URI("https://api.getvoxai.com/v1/usage")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java Current period
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.getvoxai.com/v1/usage")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Current period
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.getvoxai.com/v1/usage', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp Current period
using RestSharp;

var client = new RestClient("https://api.getvoxai.com/v1/usage");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift Current period
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.getvoxai.com/v1/usage")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Past period

**Response**

```json
{
  "object": "usage",
  "period": {
    "start": "2026-10-01T00:00:00Z",
    "end": "2026-11-01T00:00:00Z",
    "anchor_day": 1,
    "days_total": 31,
    "days_elapsed": 31,
    "days_remaining": 0,
    "current": false
  },
  "minutes": {
    "included": 600,
    "used": 587,
    "remaining": null,
    "credits": null,
    "overage": 0,
    "unlimited": false,
    "debt": null,
    "credit_packs": null,
    "source": "monthly",
    "pool": null,
    "welcome": null,
    "overage_billing": null
  },
  "sms": {
    "included": 100,
    "used": 61,
    "remaining": null,
    "credits": null,
    "overage": 0,
    "unlimited": false,
    "debt": null,
    "credit_packs": null
  },
  "concurrent_calls": {
    "limit": 3,
    "unlimited": false
  },
  "missed_calls": {
    "total": 12,
    "lines_busy": 9,
    "quota_exhausted": 3,
    "suspended": 0,
    "platform": 0,
    "agent_suspended": 0
  },
  "available_periods": [
    {
      "start": "2026-10-01T00:00:00Z",
      "end": "2026-11-01T00:00:00Z"
    },
    {
      "start": "2026-09-01T00:00:00Z",
      "end": "2026-10-01T00:00:00Z"
    },
    {
      "start": "2026-08-01T00:00:00Z",
      "end": "2026-09-01T00:00:00Z"
    }
  ]
}
```

**SDK Code**

```python Past period
import requests

url = "https://api.getvoxai.com/v1/usage"

querystring = {"period_start":"2026-10-01"}

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript Past period
const url = 'https://api.getvoxai.com/v1/usage?period_start=2026-10-01';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Past period
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getvoxai.com/v1/usage?period_start=2026-10-01"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Past period
require 'uri'
require 'net/http'

url = URI("https://api.getvoxai.com/v1/usage?period_start=2026-10-01")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java Past period
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.getvoxai.com/v1/usage?period_start=2026-10-01")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Past period
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.getvoxai.com/v1/usage?period_start=2026-10-01', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp Past period
using RestSharp;

var client = new RestClient("https://api.getvoxai.com/v1/usage?period_start=2026-10-01");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift Past period
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.getvoxai.com/v1/usage?period_start=2026-10-01")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```