Listar os extras
O que se pode comprar além do plano: hoje, um IP de envio dedicado.
Executa qualquer uma das 3 chamadas no seu espaço de trabalho.
GET /billing/add-ons
O que se pode comprar além do plano: hoje, um IP de envio dedicado.
Exemplo
Requer billing:read. eligibility diz se o espaço de trabalho reúne as condições para um IP dedicado. É preciso o plano Business ou Enterprise e pelo menos 100 000 emails enviados num mês, porque abaixo desse volume um IP dedicado entrega pior do que os partilhados. reason indica o que falta, plan ou 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 é null até o espaço de trabalho ter o extra, depois pending enquanto é configurado, warming, active, e releasing quando está a ser retirado.
Só o proprietário do espaço de trabalho chega à faturação: uma chave de API, ou um token de acesso que o proprietário ligou com todos os endereços. O token de um membro dá um 403 owner_only, e uma chave ou um token limitado a certos endereços ou domínios dá um 422 capability_unsupported.
Comprar
Requer billing:write. POST /billing/add-ons/checkout devolve a ligação onde a pessoa paga. Depois de pago, o IP é configurado e aquecido.
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" }Um espaço de trabalho que já o tem dá um 409 add_on_already_active, um que não reúne as condições dá um 409 add_on_not_eligible, e quando todos os IP estão ocupados dá um 409 add_on_sold_out.
Nada se paga através da API. A ligação abre a página do prestador de pagamentos, onde a pessoa paga, muda o cartão ou cancela, como faz a partir da app.
Um token de acesso OAuth precisa de um código de verificação para esta chamada. Até a aplicação ter verificado um nos últimos 60 minutos, a chamada responde 403 step_up_required e não altera nada. A uma chave de API nunca é pedido. A página Autenticação mostra como pedir um código e verificá-lo.
Cancelar
Requer billing:write. DELETE /billing/add-ons/dedicated-ip cancela-o no fim do mês já pago, que endsAt indica. Depois o IP é libertado e o correio volta a sair pelos IP partilhados.
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" }Um espaço de trabalho sem o extra dá um 409 add_on_not_active.
Um token de acesso OAuth precisa de um código de verificação para esta chamada. Até a aplicação ter verificado um nos últimos 60 minutos, a chamada responde 403 step_up_required e não altera nada. A uma chave de API nunca é pedido. A página Autenticação mostra como pedir um código e verificá-lo.