> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.voicecheap.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get project usage lifecycle

> Get translation and lip-sync minute charges, refunds, and lifecycle events for a project in your workspace.

Get translation and lip-sync minute charges, refunds, and lifecycle events for a project in your workspace.

```http theme={null}
POST https://api.voicecheap.ai/v1/actions/usage_project_get
```

## Authentication and permissions

**x-api-key** `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.

Required permissions: `usage:read`.

An active paid subscription is required. Permissions do not change team roles, resource ownership, media credits, or plan limits.

## Parameters

**projectId** `string` *required*

Text value.

Minimum length: 1. Maximum length: 200. Pattern: `^[^/]+$`.

> [accordion] 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.
>
> ```json theme={null}
> {
>   "type": "object",
>   "properties": {
>     "projectId": {
>       "type": "string",
>       "minLength": 1,
>       "maxLength": 200,
>       "pattern": "^[^/]+$"
>     }
>   },
>   "required": ["projectId"],
>   "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.

```bash cURL theme={null}
curl --request POST 'https://api.voicecheap.ai/v1/actions/usage_project_get' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"projectId":"project_123"}'
```

```javascript JavaScript theme={null}
const input = {
  projectId: 'project_123',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/usage_project_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);
```

```python Python theme={null}
import os
import requests

response = requests.post(
    "https://api.voicecheap.ai/v1/actions/usage_project_get",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"projectId": "project_123"},
    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 project-wide minute totals and lifecycle events across its translation runs in the active workspace.

```json HTTP 200 theme={null}
{
  "data": {
    "kind": "project",
    "isHistoricalDerived": false,
    "summary": {
      "title": "Product launch",
      "sourceLanguage": "English",
      "totals": {
        "translationBaseMinutes": 2,
        "lipSyncExtraMinutes": 0,
        "lipSyncProExtraMinutes": 0,
        "lipSyncPro2ExtraMinutes": 0,
        "totalChargedMinutes": 2,
        "refundedMinutes": 0,
        "netUsedMinutes": 2
      }
    },
    "events": [
      {
        "id": "project_123-project-created",
        "type": "project_created",
        "timestamp": 1792065540000,
        "tone": "neutral"
      },
      {
        "id": "version_123-translation-launched",
        "type": "translation_launched",
        "timestamp": 1792065600000,
        "tone": "neutral",
        "minuteDelta": 2,
        "relatedRunLabel": "French"
      },
      {
        "id": "version_123-translation-completed",
        "type": "translation_completed",
        "timestamp": 1792065720000,
        "tone": "success",
        "isDerived": false,
        "relatedRunLabel": "French"
      }
    ]
  }
}
```

## Result fields

| Field | Description |
| - | - |
| `data.kind` | translation or project. |
| `data.isHistoricalDerived` | Whether one or more usage details were derived from historical data. |
| `data.summary.title` | Project display name. |
| `data.summary.sourceLanguage` | Formatted source language label when available. |
| `data.summary.targetLanguage` | Target language for a translation lifecycle; omitted from a project lifecycle. |
| `data.summary.translationStatus` | Translation status for a translation lifecycle; omitted from a project lifecycle. |
| `data.summary.lipSyncStatus` | Lip-sync status for a translation lifecycle; omitted from a project lifecycle. |
| `data.summary.totals.translationBaseMinutes` | Base translation minutes charged across the matching rows. |
| `data.summary.totals.lipSyncExtraMinutes` | Additional Standard lip-sync minutes charged. |
| `data.summary.totals.lipSyncProExtraMinutes` | Additional Pro lip-sync minutes charged. |
| `data.summary.totals.lipSyncPro2ExtraMinutes` | Additional Pro 2 lip-sync minutes charged. |
| `data.summary.totals.totalChargedMinutes` | Total minutes charged before refunds. |
| `data.summary.totals.refundedMinutes` | Minutes refunded. |
| `data.summary.totals.netUsedMinutes` | Charged minutes minus refunded minutes. |
| `data.events` | Lifecycle events in timestamp order; events without timestamps follow timed events. |
| `data.events[].id` | Stable event identifier for the reported lifecycle step. |
| `data.events[].type` | Event type such as project\_created, translation\_launched, translation\_completed, or lip\_sync\_refunded. |
| `data.events[].timestamp` | Optional event timestamp in milliseconds. |
| `data.events[].tone` | neutral, success, warning, or danger. |
| `data.events[].relatedRunLabel` | Optional target-language and run label for project lifecycle events. |
| `data.events[].minuteDelta` | Optional charged minutes as a positive number or refunded minutes as a negative number. |
| `data.events[].isDerived` | Optional flag indicating an event reconstructed from historical data. |

## Operation notes

* The project must have at least one usage row in the active workspace; a project without usage rows returns an error.
* The summary is project-wide and omits a single targetLanguage, translationStatus, and lipSyncStatus. Individual events include a target-language/run label when applicable.
* Events omit raw processing error messages and event display labels.

## Usage

Each successful invocation consumes one monthly API/MCP call. Media credits and the operation's own generation allowances also apply.

## Errors

| HTTP status | Code | Meaning or recovery |
| - | - | - |
| 400 | `BAD_REQUEST` | The project could not be found or has no translation usage rows in the active workspace. |
| 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 account's integration limits could not be verified. |
| 403 | `SUBSCRIPTION_REQUIRED` | Use an active paid subscription. |
| 403 | `TEAM_MEMBERSHIP_INVALID` | The account’s current team membership does not match this connection’s workspace. Refresh the membership and reconnect. |
| 403 | `TEAM_OWNER_NOT_FOUND` | The effective team owner account could not be found. |
| 404 | `ACCOUNT_NOT_FOUND` | The account or active workspace account could not be found. |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Wait for the monthly reset or change plan. |
| 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. |

```json theme={null}
{
  "code": "INSUFFICIENT_SCOPE",
  "message": "This credential does not permit the requested action.",
  "status": 403,
  "details": {
    "requiredScopes": ["usage:read"]
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.