> ## 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.

# アカウントとクレジット残高を取得

> アカウント情報、適用中のプラン、プラン付属および追加購入分の分数残高、テキスト読み上げの文字数残高、この接続の権限を取得します。

アカウント情報、適用中のプラン、プラン付属および追加購入分の分数残高、テキスト読み上げの文字数残高、この接続の権限を取得します。

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

## 認証と権限

<ParamField header="x-api-key" type="string" required>
  このヘッダーに VoiceCheap API キーを指定してください。同じ API キーを Authorization: Bearer で送信することもできます。OAuth アクセストークンは MCP
  でのみ使用でき、この REST エンドポイントでは使用できません。
</ParamField>

必要な権限: `account:read`.

有効な有料サブスクリプションが必要です。権限によってチーム内のロール、リソースの所有権、メディアクレジット、プランの制限が変わることはありません。

## パラメーター

空の JSON オブジェクトを送信してください。このアクションに入力フィールドはありません。

<Accordion title="完全な入力スキーマ">
  以下の JSON Schema は、ディスカバリーで公開される正確なフィールド名、ネストされた型、デフォルト値、範囲、許容値を保持しています。フィールド間の追加ルールは操作の注意事項に記載されています。

  ```json theme={null}
  {
    "type": "object",
    "properties": {},
    "additionalProperties": false
  }
  ```
</Accordion>

## リクエスト例

例に記載されたリソース識別子とメディアキーを、ご自身のアカウントで返された値に置き換えてください。同じ変更操作を再試行する場合は、リクエスト識別子を変更しないでください。

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

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

## レスポンス

初回実行が成功すると、操作結果を data に格納して HTTP 200 を返します。同じリクエストを再送した場合は、代わりに保存済みリクエストの状態を返すことがあります。例はサポートされるレスポンスの一例であり、すべての任意フィールドを示すものではありません。

呼び出し元の公開プロフィール、実効プラン、アクティブなワークスペース、利用可能なメディアクレジット、接続権限、翻訳上限を返します。

<ResponseExample>
  ```json HTTP 200 theme={null}
  {
    "data": {
      "userId": "user_123",
      "email": "developer@example.com",
      "displayName": "Studio owner",
      "companyName": "Studio",
      "plan": "pro",
      "workspace": {
        "ownerUserId": "user_123",
        "teamId": null,
        "isTeamMember": false
      },
      "credits": {
        "availableMinutes": 150,
        "includedMinutes": 120,
        "purchasedMinutes": 30,
        "textToSpeech": {
          "limit": 4000000,
          "used": 125000,
          "remaining": 3925000,
          "includedRemaining": 3875000,
          "purchasedRemaining": 50000,
          "resetsAt": 1793491200000
        }
      },
      "permissions": {
        "scopes": [
          "account:read"
        ],
        "canManageOwnTeam": false,
        "canEditSharedSettings": true
      },
      "limits": {
        "maxConcurrentTranslations": 5,
        "accessToLipSyncPro": false
      }
    }
  }
  ```
</ResponseExample>

## 結果フィールド

| フィールド | 説明 |
| - | - |
| `data.userId` | 認証済みアカウントの識別子。 |
| `data.email` | 認証済みアカウントのメールアドレス。 |
| `data.displayName` | 認証済みアカウントの表示名。 |
| `data.companyName` | 保存済みの会社名、または null。 |
| `data.plan` | この接続で使用される実効プラン。 |
| `data.workspace.ownerUserId` | アクティブなワークスペースのプロジェクトと分数クレジットを所有するアカウント。 |
| `data.workspace.teamId` | アクティブなチームの識別子。個人ワークスペースの場合は null。 |
| `data.workspace.isTeamMember` | この接続がメンバーとしてチーム所有者のワークスペースで操作するかどうか。 |
| `data.credits.availableMinutes` | 利用可能な合計時間（分単位の整数、購入済みクレジットを含む）。 |
| `data.credits.includedMinutes` | 付帯残高から利用できる分数（整数）。 |
| `data.credits.purchasedMinutes` | 購入済み分数クレジットの利用可能な分数（整数）。 |
| `data.credits.textToSpeech.limit` | 現在の利用期間にプランに含まれるテキスト読み上げの文字数枠。 |
| `data.credits.textToSpeech.used` | 現在の期間に使用した、プラン付属のテキスト読み上げ文字数。 |
| `data.credits.textToSpeech.remaining` | 利用可能な、プラン付属と購入済みのテキスト読み上げ文字数の合計。 |
| `data.credits.textToSpeech.includedRemaining` | 利用可能な、プラン付属のテキスト読み上げ文字数。 |
| `data.credits.textToSpeech.purchasedRemaining` | 利用可能な、購入済みのテキスト読み上げ文字数。 |
| `data.credits.textToSpeech.resetsAt` | 現在のテキスト読み上げ利用期間の終了時刻。ミリ秒単位。有効な期間がない場合は null。 |
| `data.permissions.scopes` | この API キーまたは MCP 接続に付与された権限。 |
| `data.permissions.canManageOwnTeam` | 認証済みアカウントがすでにチームを所有しているかどうか。 |
| `data.permissions.canEditSharedSettings` | 呼び出し元がワークスペースの語彙とアカウントの翻訳指示を編集できるかどうか。 |
| `data.limits.maxConcurrentTranslations` | 適用中の同時翻訳利用枠。 |
| `data.limits.accessToLipSyncPro` | この接続の適用先アカウントが Pro リップシンクにアクセスできるかどうか。 |

## 操作の注意事項

* 分数クレジットは、アクティブな個人またはチームのワークスペースに属します。テキスト読み上げの履歴と文字クレジットは、認証済みアカウントに属します。
* TTSの利用枠期間は、前の期間が終了した後の最初の生成から30日間です。リセットは、暦月単位の連携呼び出し枠とは独立しています。
* このアクションは、保存済みAPIキー、Webhook署名シークレット、外部アカウントの認証情報を返しません。

## 使用量

正常に実行された呼び出しごとに、月間 API/MCP 呼び出し回数を 1 回消費します。メディアクレジットと、その操作固有の生成枠も適用されます。

## エラー

| HTTP ステータス | コード | 意味または対処方法 |
| - | - | - |
| 400 | `CREDENTIAL_IN_QUERY` | access\_token または api\_key クエリパラメーターに認証情報が指定されています。認証情報はヘッダーで送信してください。 |
| 400 | `VALIDATION_ERROR` | JSONオブジェクトに未対応のフィールド、無効な値、または必須引数の欠落があります。 |
| 401 | `API_KEY_EXPIRED` | API キーの有効期限が切れています。 |
| 401 | `INVALID_API_KEY` | 有効期限内の有効な API キーを指定してください。 |
| 401 | `INVALID_CREDENTIAL` | Authorization ヘッダーの形式が不正、または x-api-key と競合しています。 |
| 401 | `MISSING_CREDENTIAL` | 利用可能なヘッダー認証情報が指定されていないか、4096文字を超えています。 |
| 401 | `USER_NOT_FOUND` | 認証情報に対応するアカウントはすでに存在しません。 |
| 403 | `AMBIGUOUS_TEAM_API_KEY` | 認証情報のユーザーが複数のチームに属しているため、課金コンテキストが曖昧です。 |
| 403 | `INSUFFICIENT_SCOPE` | 必要な権限をすべて付与するか、別の認証情報を使用してください。 |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | アカウントの連携上限を確認できませんでした。 |
| 403 | `SUBSCRIPTION_REQUIRED` | 有効な有料サブスクリプションを使用してください。 |
| 403 | `TEAM_MEMBERSHIP_INVALID` | アカウントの現在のチーム所属が、この接続のワークスペースと一致しません。所属情報を更新して再接続してください。 |
| 403 | `TEAM_OWNER_NOT_FOUND` | 実効的なチームオーナーのアカウントが見つかりませんでした。 |
| 404 | `ACCOUNT_NOT_FOUND` | アカウントまたはアクティブなワークスペースのアカウントが見つかりませんでした。 |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | 月次リセットを待つか、プランを変更してください。 |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Retry-After がある場合は指定時間を待ち、バックオフを使用してください。 |
| 500 | `INTERNAL_ERROR` | 変更操作を再試行するか判断する前に、保存済みリクエストの状態とリソースの履歴を確認してください。 |
| 503 | `SERVER_RESTARTING` | サーバーが再起動中です。少し待ってから再試行し、変更操作では同じリクエスト識別子を使用してください。 |

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


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