Перейти к документации
API

Список дополнений

Что можно купить поверх тарифа: сегодня это выделенный IP для отправки.

GET/billing/add-ons

Выполняет любой из 3 запросов в вашем рабочем пространстве.

GET /billing/add-ons

Что можно купить поверх тарифа: сегодня это выделенный IP для отправки.

Пример

Требуется billing:read. eligibility говорит, соответствует ли рабочее пространство условиям для выделенного IP. Нужен тариф Business или Enterprise и не менее 100 000 отправленных писем за месяц, потому что при меньшем объёме выделенный IP доставляет хуже общих. reason называет, чего не хватает: plan или volume.

curl
curl "$OE/billing/add-ons" -H "$AUTH"
Ответ
{ "object": "list", "data": [{  "object": "add_on",  "addOn": "dedicated-ip",  "available": true,  "status": null,  "priceCents": 3999,  "endsAt": null,  "eligibility": {    "eligible": false,    "plan": "business",    "monthlySends": 41200,    "minimumMonthlySends": 100000,    "reason": "volume"  },  "ips": []}] }

status равен null, пока у рабочего пространства нет дополнения, затем pending, пока оно настраивается, warming, active и releasing, когда его снимают.

К оплате есть доступ только у владельца рабочего пространства: это API-ключ или токен доступа, который владелец подключил со всеми адресами. Токен участника даёт 403 owner_only, а ключ или токен, ограниченный отдельными адресами или доменами, даёт 422 capability_unsupported.

Купить

Требуется billing:write. POST /billing/add-ons/checkout возвращает ссылку, по которой человек платит. После оплаты IP настраивается и прогревается.

curl
curl -X POST "$OE/billing/add-ons/checkout" -H "$AUTH" -H 'content-type: application/json' \  -d '{ "addOn": "dedicated-ip" }'
Ответ
{ "object": "add_on_checkout", "addOn": "dedicated-ip", "url": "https://checkout.example.com/c/9Tn4wRb1xK7pQ2zd" }

Рабочее пространство, у которого оно уже есть, даёт 409 add_on_already_active, не соответствующее условиям даёт 409 add_on_not_eligible, а когда все IP заняты, это 409 add_on_sold_out.

Через API ничего не оплачивается. Ссылка открывает страницу платёжного провайдера, где человек платит, меняет карту или отменяет, как и из приложения.

Токену доступа OAuth для этого вызова нужен код подтверждения. Пока приложение не подтвердило код за последние 60 минут, вызов отвечает 403 step_up_required и ничего не меняет. У API-ключа его никогда не спрашивают. Страница «Аутентификация» показывает, как запросить код и подтвердить его.

Отменить

Требуется billing:write. DELETE /billing/add-ons/dedicated-ip отменяет его в конце уже оплаченного месяца, который указан в endsAt. После этого IP освобождается, и почта снова уходит через общие IP.

curl
curl -X DELETE "$OE/billing/add-ons/dedicated-ip" -H "$AUTH"
Ответ
{ "object": "add_on", "addOn": "dedicated-ip", "status": "active", "endsAt": "2026-11-01T00:00:00.000Z" }

Рабочее пространство без дополнения даёт 409 add_on_not_active.

Токену доступа OAuth для этого вызова нужен код подтверждения. Пока приложение не подтвердило код за последние 60 минут, вызов отвечает 403 step_up_required и ничего не меняет. У API-ключа его никогда не спрашивают. Страница «Аутентификация» показывает, как запросить код и подтвердить его.

Справочник