curl --request POST 'https://api.voicecheap.ai/v1/actions/usage_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{}'
const input = {};
const response = await fetch('https://api.voicecheap.ai/v1/actions/usage_get', {
method: 'POST',
headers: {
'x-api-key': process.env.VOICECHEAP_API_KEY,
'Content-Type': 'application/json',
},
body: JSON.stringify(input),
});
const body = await response.json();
if (!response.ok) throw new Error(body.code + ': ' + body.message);
console.log(body);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/usage_get",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"month": "2026-10",
"usedCalls": 120,
"pendingCalls": 2,
"monthlyLimit": 500,
"remainingCalls": 378,
"requestsPerMinute": 30,
"resetsAt": 1793491200000,
"plan": "beginner"
}
}
Usage and activity
Get API and MCP call usage
Get the shared monthly API and MCP call allowance, remaining calls, reset time, and request rate limit for your billing workspace.
POST
/
v1
/
actions
/
usage_get
curl --request POST 'https://api.voicecheap.ai/v1/actions/usage_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{}'
const input = {};
const response = await fetch('https://api.voicecheap.ai/v1/actions/usage_get', {
method: 'POST',
headers: {
'x-api-key': process.env.VOICECHEAP_API_KEY,
'Content-Type': 'application/json',
},
body: JSON.stringify(input),
});
const body = await response.json();
if (!response.ok) throw new Error(body.code + ': ' + body.message);
console.log(body);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/usage_get",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"month": "2026-10",
"usedCalls": 120,
"pendingCalls": 2,
"monthlyLimit": 500,
"remainingCalls": 378,
"requestsPerMinute": 30,
"resetsAt": 1793491200000,
"plan": "beginner"
}
}
Get the shared monthly API and MCP call allowance, remaining calls, reset time, and request rate limit for your billing workspace.
Required permissions:
POST https://api.voicecheap.ai/v1/actions/usage_get
Authentication and permissions
string
required
Send a VoiceCheap API key in this header. Authorization: Bearer with the same API key is also supported. OAuth access tokens are accepted only by
MCP, not by this REST endpoint.
usage:read.
An active paid subscription is required. Permissions do not change team roles, resource ownership, media credits, or plan limits.
Parameters
Send an empty JSON object. This action has no input fields.Complete input schema
Complete input schema
The JSON Schema below preserves the exact field names, nested types, defaults, bounds, and accepted values exposed by discovery. Additional cross-field rules are listed in the operation notes.
{
"type": "object",
"properties": {},
"additionalProperties": false
}
Request examples
Replace example resource identifiers and media keys with values returned for your account. Keep the request identifier stable when retrying the same mutation.curl --request POST 'https://api.voicecheap.ai/v1/actions/usage_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{}'
const input = {};
const response = await fetch('https://api.voicecheap.ai/v1/actions/usage_get', {
method: 'POST',
headers: {
'x-api-key': process.env.VOICECHEAP_API_KEY,
'Content-Type': 'application/json',
},
body: JSON.stringify(input),
});
const body = await response.json();
if (!response.ok) throw new Error(body.code + ': ' + body.message);
console.log(body);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/usage_get",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
Response
A successful first execution returns HTTP 200 with the operation result under data. A replay may return saved request state instead. The example shows one supported response, not every optional field. Returns the active workspace’s shared API and MCP call allowance for the current UTC calendar month.{
"data": {
"month": "2026-10",
"usedCalls": 120,
"pendingCalls": 2,
"monthlyLimit": 500,
"remainingCalls": 378,
"requestsPerMinute": 30,
"resetsAt": 1793491200000,
"plan": "beginner"
}
}
Result fields
| Field | Description |
|---|---|
data.month | UTC calendar month in YYYY-MM format. |
data.usedCalls | Successfully completed calls counted toward this month. |
data.pendingCalls | Admitted calls that are still reserved and count toward the allowance. |
data.monthlyLimit | Monthly call allowance; null means no monthly ceiling. |
data.remainingCalls | Allowance remaining after completed and pending calls; null when monthlyLimit is null. |
data.requestsPerMinute | Shared workspace request limit per minute. |
data.resetsAt | First instant of the next UTC calendar month as a Unix timestamp in milliseconds. |
data.plan | Effective workspace plan. |
Operation notes
- API and MCP consume the same workspace allowance. Unlimited monthly calls remain subject to rate limits and media credits.
- usage_get itself is exempt from the monthly call counter and remains authenticated and rate limited.
Usage
This status or usage control does not consume the monthly API/MCP call allowance. Authentication, paid access, ownership, and rate limits still apply.Errors
| HTTP status | Code | Meaning or recovery |
|---|---|---|
| 400 | CREDENTIAL_IN_QUERY | Credentials were supplied in an access_token or api_key query parameter. Send credentials in headers. |
| 400 | VALIDATION_ERROR | The JSON object contains an unsupported field, an invalid value, or a missing required argument. |
| 401 | API_KEY_EXPIRED | The API key has expired. |
| 401 | INVALID_API_KEY | Provide a valid, unexpired API key. |
| 401 | INVALID_CREDENTIAL | The Authorization header is malformed or conflicts with x-api-key. |
| 401 | MISSING_CREDENTIAL | No usable header credential was supplied, or it exceeded 4096 characters. |
| 401 | USER_NOT_FOUND | The credential’s account no longer exists. |
| 403 | AMBIGUOUS_TEAM_API_KEY | The credential’s user belongs to more than one team, so the billing context is ambiguous. |
| 403 | INSUFFICIENT_SCOPE | Grant every required permission or choose another credential. |
| 403 | INTEGRATION_PLAN_UNSUPPORTED | The effective plan could not be verified. |
| 403 | SUBSCRIPTION_REQUIRED | Use an active paid subscription. |
| 403 | TEAM_OWNER_NOT_FOUND | The effective team owner account could not be found. |
| 429 | INTEGRATION_RATE_LIMIT_REACHED | Wait for Retry-After when present and use backoff. |
| 500 | INTERNAL_ERROR | Check saved request state and resource history before deciding to retry a mutation. |
| 503 | SERVER_RESTARTING | The server is restarting. Retry shortly and keep the same request identifier for a mutation. |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["usage:read"]
}
}
Was this page helpful?