Баланс кредитов
Запрашивайте текущий доступный баланс кредитов для управления использованием и предотвращения сбоев задач.
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
Этот эндпоинт возвращает общий доступный баланс, который включает в себя как ежемесячные лимиты по подписке, так и любые дополнительные купленные кредиты.
Структура ответа
| Параметр | Тип | Обязателен |
|---|---|---|
| Идентификация и контекст | ||
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 | Тип | Человекочитаемое использование (например, '2 ГБ'). |
storage.formattedLimit | Тип | Человекочитаемый лимит (например, '10 ГБ'). |
Пример ответа: 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 | Произошла непредвиденная внутренняя ошибка. |
Была ли эта страница полезна?