تخطَّ إلى المستندات
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 أبدًا. وتبيّن صفحة المصادقة كيف تطلب رمزًا وتتحقق منه.

المرجع