Listar los complementos
Lo que se puede comprar además del plan: hoy, una IP de envío dedicada.
Ejecuta cualquiera de las 3 llamadas en tu espacio de trabajo.
GET /billing/add-ons
Lo que se puede comprar además del plan: hoy, una IP de envío dedicada.
Ejemplo
Requiere billing:read. eligibility dice si el espacio de trabajo cumple los requisitos para una IP dedicada. Hace falta el plan Business o Enterprise y al menos 100.000 correos enviados en un mes, porque por debajo de ese volumen una IP dedicada entrega peor que las compartidas. reason nombra lo que falta, plan o volume.
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 es null hasta que el espacio de trabajo tiene el complemento, luego pending mientras se configura, warming, active, y releasing cuando se está retirando.
Solo el propietario del espacio de trabajo llega a la facturación: una clave de API, o un token de acceso que el propietario conectó con todas las direcciones. El token de un miembro es un 403 owner_only, y una clave o un token limitado a ciertas direcciones o dominios es un 422 capability_unsupported.
Comprarlo
Requiere billing:write. POST /billing/add-ons/checkout devuelve el enlace donde la persona paga. Una vez pagado, la IP se configura y se calienta.
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" }Un espacio de trabajo que ya lo tiene es un 409 add_on_already_active, uno que no cumple los requisitos es un 409 add_on_not_eligible, y cuando todas las IP están ocupadas es un 409 add_on_sold_out.
Nada se paga mediante la API. El enlace abre la página del proveedor de pagos, donde la persona paga, cambia la tarjeta o cancela, igual que desde la app.
Un token de acceso OAuth necesita un código de verificación para esta llamada. Hasta que la app haya verificado uno en los últimos 60 minutos, la llamada responde 403 step_up_required y no cambia nada. A una clave de API nunca se le pide. La página Autenticación muestra cómo pedir un código y verificarlo.
Cancelarlo
Requiere billing:write. DELETE /billing/add-ons/dedicated-ip lo cancela al final del mes ya pagado, que da endsAt. Después la IP se libera y el correo vuelve a salir por las IP compartidas.
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" }Un espacio de trabajo sin el complemento es un 409 add_on_not_active.
Un token de acceso OAuth necesita un código de verificación para esta llamada. Hasta que la app haya verificado uno en los últimos 60 minutos, la llamada responde 403 step_up_required y no cambia nada. A una clave de API nunca se le pide. La página Autenticación muestra cómo pedir un código y verificarlo.