#Сводка по подписке Cowork
GET /v1/cowork/me
Возвращает краткое состояние подписки Cowork: тариф, состояние подписки и расход трёх окон квоты в процентах. Облегчённый вариант полного состояния — без рекомендаций и каталога тарифов.
#Примеры
#curl — личный ключ
curl https://vibecode.bitrix24.tech/v1/cowork/me \
-H "X-Api-Key: YOUR_API_KEY"
#curl — OAuth-приложение
curl https://vibecode.bitrix24.tech/v1/cowork/me \
-H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN"
#JavaScript — личный ключ
const res = await fetch('https://vibecode.bitrix24.tech/v1/cowork/me', {
headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
if (!res.ok) {
const { error } = await res.json()
console.error(error.code, error.message)
} else {
const { tier, quotaPct } = await res.json()
console.log(`Тариф ${tier}: месяц ${quotaPct.month}%, неделя ${quotaPct.week}%, 5ч ${quotaPct.fiveHour}%`)
}
#JavaScript — OAuth-приложение
const res = await fetch('https://vibecode.bitrix24.tech/v1/cowork/me', {
headers: {
'X-Api-Key': 'YOUR_APP_KEY',
'Authorization': 'Bearer USER_SESSION_TOKEN',
},
})
const me = await res.json()
#Поля ответа
| Поле | Тип | Описание |
|---|---|---|
tier |
string | Текущий тариф: FREE, START, PRO, MAX |
state |
string | Состояние подписки: ACTIVE, PAUSED, CANCELLED |
quotaPct.fiveHour |
number | 5-часовое окно, использование в процентах (целое 0–100) |
quotaPct.week |
number | Недельное окно, использование в процентах (целое 0–100) |
quotaPct.month |
number | Месячное окно, использование в процентах (целое 0–100) |
resetAt.fiveHour |
string | Время сброса 5-часового окна (ISO 8601) |
resetAt.week |
string | Время сброса недельного окна (ISO 8601) |
resetAt.month |
string | Время сброса месячного окна — конец расчётного периода (ISO 8601) |
nextChargeAt |
string или null | Дата следующего списания, null для тарифа FREE |
#Пример ответа
{
"tier": "FREE",
"state": "ACTIVE",
"quotaPct": { "fiveHour": 40, "week": 24, "month": 20 },
"resetAt": {
"fiveHour": "2026-06-09T17:30:00.000Z",
"week": "2026-06-12T09:00:00.000Z",
"month": "2026-07-01T00:00:00.000Z"
},
"nextChargeAt": null
}
#Пример ответа при ошибке
404 — подписка не активирована:
{
"success": false,
"error": {
"code": "COWORK_NOT_ACTIVATED",
"message": "No active Cowork subscription for this user+portal"
}
}
#Ошибки
| HTTP | Код | Описание |
|---|---|---|
| 401 | MISSING_API_KEY |
Не передан заголовок X-Api-Key |
| 401 | INVALID_API_KEY |
Неверный API-ключ |
| 403 | INSUFFICIENT_SCOPE |
У ключа нет скоупа vibe:cowork |
| 404 | COWORK_NOT_ACTIVATED |
Подписка Cowork не найдена для пары пользователь и портал |
| 500 | INVALID_TIER_CONFIGURATION |
Конфигурация тарифов на платформе некорректна |
| 503 | COWORK_FEATURE_DISABLED |
Cowork отключён на уровне платформы |
Полный список общих ошибок API — Ошибки.
#Известные особенности
Успешный ответ (200) — это сам объект, без обёртки success. Ошибки приходят в конверте { success: false, error: { code, message } }. Определяйте успех по HTTP-статусу (res.ok).
Эндпоинт отдаёт только проценты. Признака исчерпания (exhausted), серверного времени и рекомендаций здесь нет — для них используйте полное состояние.