Belgelere geç
API

Eklentileri listeleme

Plana ek olarak satın alınabilenler: bugün için bir özel gönderim IP'si.

GET/billing/add-ons

3 çağrıdan herhangi birini çalışma alanınızda çalıştırır.

GET /billing/add-ons

Plana ek olarak satın alınabilenler: bugün için bir özel gönderim IP'si.

Örnek

billing:read gerektirir. eligibility, çalışma alanının özel IP koşullarını karşılayıp karşılamadığını söyler. Business ya da Enterprise planı ve bir ayda en az 100.000 gönderilmiş e-posta gerekir; çünkü bu hacmin altında özel bir IP, paylaşılanlardan daha kötü teslim eder. reason neyin eksik olduğunu belirtir: plan ya da volume.

curl
curl "$OE/billing/add-ons" -H "$AUTH"
Yanıt
{ "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, çalışma alanı eklentiye sahip olana kadar null'dır; sonra kurulurken pending, ardından warming, active ve kaldırılırken releasing olur.

Faturalandırmaya yalnızca çalışma alanının sahibi erişir: bir API anahtarı ya da sahibin her adresle bağladığı bir erişim token’ı. Bir üyenin token’ı 403 owner_only, belirli adreslerle ya da alan adlarıyla sınırlı bir anahtar ya da token ise 422 capability_unsupported döndürür.

Satın alma

billing:write gerektirir. POST /billing/add-ons/checkout, kişinin ödeme yaptığı bağlantıyı döndürür. Ödeme yapılınca IP kurulur ve ısıtılır.

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

Eklentiye zaten sahip bir çalışma alanı 409 add_on_already_active, koşulları karşılamayan bir çalışma alanı 409 add_on_not_eligible, tüm IP'ler doluyken de 409 add_on_sold_out döndürür.

API üzerinden hiçbir şey ödenmez. Bağlantı ödeme sağlayıcısının sayfasını açar; kişi orada, uygulamadan yaptığı gibi öder, kartı değiştirir ya da iptal eder.

Bir OAuth erişim tokenı bu çağrı için bir doğrulama kodu gerektirir. Uygulama son 60 dakika içinde bir kod doğrulayana kadar çağrı 403 step_up_required yanıtını verir ve hiçbir şeyi değiştirmez. Bir API anahtarından asla istenmez. Kimlik doğrulama sayfası bir kodun nasıl isteneceğini ve doğrulanacağını gösterir.

İptal etme

billing:write gerektirir. DELETE /billing/add-ons/dedicated-ip, eklentiyi endsAt ile verilen, ödemesi yapılmış ayın sonunda iptal eder. Sonra IP serbest bırakılır ve posta yeniden paylaşılan IP'lerden çıkar.

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

Eklentisi olmayan bir çalışma alanı 409 add_on_not_active döndürür.

Bir OAuth erişim tokenı bu çağrı için bir doğrulama kodu gerektirir. Uygulama son 60 dakika içinde bir kod doğrulayana kadar çağrı 403 step_up_required yanıtını verir ve hiçbir şeyi değiştirmez. Bir API anahtarından asla istenmez. Kimlik doğrulama sayfası bir kodun nasıl isteneceğini ve doğrulanacağını gösterir.

Referans