Включить пробный период Маркета

POST /v1/cowork/activate-market-trial

Включает одноразовый пробный период подписки Маркета для аккаунта Битрикс24, к которому привязан ключ десктопа Коворк/Код. Аккаунт берётся из привязки ключа, параметра пути нет.

Перед показом шага активации прочитайте activation.marketTrial.available в состоянии подписки — этот признак считается заранее и говорит, стоит ли предлагать включение. Вызов самого метода остаётся законным и тогда, когда признак говорит «не предлагать»: подписка Маркета может быть нужна аккаунту для другого — вызовов ботов, развёртывания и пробуждения приложений, создания приложения и замены его ключа, привязки встроек или выдачи ключа агента.

Поля запроса (body)

Примеры

Эндпоинт принимает только ключ десктопа Коворк/Код, поэтому примеров два: ключ приложения с сессией пользователя получает 403 COWORK_DESKTOP_KEY_REQUIRED.

curl — ключ десктопа Коворк/Код

curl -X POST https://vibecode.bitrix24.tech/v1/cowork/activate-market-trial \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"acknowledgedOneTimeConsumption": true}'

JavaScript — ключ десктопа Коворк/Код

const res = await fetch('https://vibecode.bitrix24.tech/v1/cowork/activate-market-trial', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ acknowledgedOneTimeConsumption: true }),
})

if (!res.ok) {
  const { error } = await res.json()
  console.error(error.code, error.message)
} else {
  const { data } = await res.json()
  console.log(data.status === 'activated'
    ? `Пробный период включён до ${data.trialEndsAt}`
    : `Состояние: ${data.status}`)
}

Поля ответа

Пример ответа

{
  "success": true,
  "data": {
    "status": "activated",
    "trialEndsAt": "2026-09-01T00:00:00.000Z"
  }
}

Включение состоялось, подтверждение ещё не пришло:

{
  "success": true,
  "data": {
    "status": "pending"
  }
}

Пример ответа при ошибке

400 — тело без подтверждения:

{
  "success": false,
  "error": {
    "code": "DISCLOSURE_REQUIRED",
    "message": "Body must contain {\"acknowledgedOneTimeConsumption\": true} — confirm that the user was shown that this starts a one-time trial and when it ends."
  }
}

Ошибки

Полный список общих ошибок API — Ошибки.

Известные особенности

Пробный период одноразовый, и отозвать его нельзя. Отсчёт начинается в момент успешного ответа, отмены у этой операции нет ни у нас, ни у Битрикс24. Поэтому включение и требует подтверждения в теле запроса.

Срок периода задаёт Битрикс24. Показывайте пользователю дату из trialEndsAt, а не собственное число дней: оно менялось и может отличаться от того, что вы видели раньше.

Статус pending — не повод повторять запрос. Включение уже состоялось, не хватает только подтверждения от Битрикс24. Повтор израсходует попытку и вернёт 409 ALREADY_ACTIVATED. Отдельного признака подтверждения снаружи сейчас нет: состояние подписки сразу показывает status: activated, и endsAt там тоже заполняется сразу. Показывайте пользователю включённый период и дату из состояния, а сам ответ pending считайте успехом.

Признак available — прогноз, а не гарантия. Значение true в состоянии подписки означает «предлагать можно», но окончательное решение остаётся за Битрикс24: между запросом состояния и включением условия могли измениться, поэтому обработку отказа оставьте.

Ключ десктопа выдаёт вход в приложение Коворк/Код. Личный ключ и ключ приложения этот эндпоинт не принимают, для них включение живёт на другом адресе. Ключ места агента несёт тот же скоуп vibe:cowork, но тоже получает отказ: за ним нет человека, которому показали бы расход одноразового ресурса.

Три попытки в час считаются на аккаунт, а не на ключ, и расходуются в том числе на отказах. Все устройства одного человека и все сотрудники одного аккаунта делят этот предел, а проверка частоты идёт раньше остальных: запрос без подтверждения или с ключом другого класса уменьшает остаток так же, как удачный.

Отсутствие подтверждения всегда приходит одним кодом. Пустое тело, отсутствие заголовка Content-Type и чужой тип содержимого без тела — всё это 400 DISCLOSURE_REQUIRED, а не внутренняя ошибка разбора запроса. Отдельной ветки на такие случаи заводить не нужно.

Смотрите также

• Активировать пробный период Маркета
• Состояние подписки Cowork/Code
• Сводка по подписке Cowork/Code
• Предрасчёт смены тарифа
• Cowork/Code
• Ошибки