クレジット残高

現在の利用可能なクレジット残高を確認し、使用状況を管理してジョブの失敗を防ぎます。

GET/api/v1/balance

クイック実装

curl -X GET https://api.srtgen.com/api/v1/balance \
  -H "x-api-key: <YOUR_API_KEY>"

GEThttps://api.srtgen.com/api/v1/balance

このエンドポイントは、月間サブスクリプションの割り当て分と、購入した追加のチャージクレジットの両方を含む、利用可能な合計残高を返します。

レスポンス構造

パラメータ	タイプ	必須
IDとコンテキスト
`user`	オブジェクト	認証されたユーザーに関する基本情報。
`user.name`	タイプ	ユーザーの表示名。
`user.email`	タイプ	登録されたメールアドレス。
クレジット残高の詳細
`credits`	オブジェクト	詳細なクレジット残高の内訳。
`credits.totalBalance`	Number	利用可能なすべてのクレジットの合計（割り当て分 + 追加分）。
`credits.extraCredits`	Number	永続的なチャージクレジット。
`credits.plans`	Array	アクティブなサブスクリプションプランのリスト。
`plans[].name`	タイプ	プランの表示名（例: 'Pro Plan'）。
`plans[].status`	タイプ	サブスクリプションステータス (active, past_due)。
`plans[].balance`	Number	この特定のサイクルに残っているクレジット。
クラウドストレージの使用状況
`storage`	オブジェクト	クラウドストレージの使用統計。
`storage.usage`	Number	現在のストレージ使用量（バイト）。
`storage.limit`	Number	プランに基づいた最大ストレージ制限（バイト）。
`storage.formattedUsage`	タイプ	読みやすい形式の使用量（例: '200 MB'）。
`storage.formattedLimit`	タイプ	読みやすい形式の制限（例: '10 GB'）。

レスポンス例: 200 OK

{
  "success": true,
  "user": {
    "name": "Alex Rivera",
    "email": "[email protected]"
  },
  "credits": {
    "totalBalance": 1250,
    "totalMonthlyCredits": 1000,
    "extraCredits": 250,
    "plans": [
      {
        "id": "starter",
        "name": "Starter Plan",
        "status": "active",
        "balance": 1000,
        "total": 1000,
        "resetTime": "2026-04-29T17:48:46.000Z"
      }
    ]
  },
  "storage": {
    "usage": 209715200,
    "limit": 10737418240,
    "formattedUsage": "200 MB",
    "formattedLimit": "10 GB"
  },
  "updatedAt": "2026-03-29T17:48:46.000Z"
}

エラー

ステータス	エラーコード	説明
401	unauthorized	APIキーが欠落しているか無効です。
500	server_error	予期しない内部エラーが発生しました。

このページは役に立ちましたか？