Aller à la documentation
API

Lister les modules

Ce qui peut s’acheter en plus de l’offre : aujourd’hui, une IP d’envoi dédiée.

GET/billing/add-ons

Exécute l'un des 3 appels sur votre espace de travail.

GET /billing/add-ons

Ce qui peut s’acheter en plus de l’offre : aujourd’hui, une IP d’envoi dédiée.

Exemple

Nécessite billing:read. eligibility dit si l’espace de travail remplit les conditions pour une IP dédiée. Il faut l’offre Business ou Enterprise et au moins 100 000 e-mails envoyés en un mois, car en dessous de ce volume une IP dédiée délivre moins bien que les IP partagées. reason nomme ce qui manque, plan ou volume.

curl
curl "$OE/billing/add-ons" -H "$AUTH"
Réponse
{ "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 vaut null tant que l’espace de travail n’a pas le module, puis pending pendant sa mise en place, warming, active, et releasing une fois qu’il est en cours de retrait.

Seul le propriétaire de l’espace de travail atteint la facturation : une clé d’API, ou un jeton d’accès que le propriétaire a connecté avec toutes les adresses. Le jeton d’un membre donne un 403 owner_only, et une clé ou un jeton limité à certaines adresses ou certains domaines un 422 capability_unsupported.

L’acheter

Nécessite billing:write. POST /billing/add-ons/checkout renvoie le lien où la personne paie. Une fois payé, l’IP est mise en place et préchauffée.

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

Un espace de travail qui l’a déjà donne un 409 add_on_already_active, un espace qui ne remplit pas les conditions un 409 add_on_not_eligible, et quand toutes les IP sont prises, un 409 add_on_sold_out.

Rien ne se paie par l’API. Le lien ouvre la page du prestataire de paiement, où la personne paie, change la carte ou résilie, comme depuis l’application.

Un jeton d'accès OAuth a besoin d'un code de vérification pour cet appel. Tant que l'application n'en a pas vérifié un dans les 60 dernières minutes, l'appel répond 403 step_up_required et ne change rien. On ne le demande jamais à une clé API. La page Authentification montre comment demander un code et le vérifier.

Le résilier

Nécessite billing:write. DELETE /billing/add-ons/dedicated-ip le résilie à la fin du mois déjà payé, que donne endsAt. Ensuite, l’IP est libérée et le courrier repart par les IP partagées.

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

Un espace de travail sans le module donne un 409 add_on_not_active.

Un jeton d'accès OAuth a besoin d'un code de vérification pour cet appel. Tant que l'application n'en a pas vérifié un dans les 60 dernières minutes, l'appel répond 403 step_up_required et ne change rien. On ne le demande jamais à une clé API. La page Authentification montre comment demander un code et le vérifier.

Référence