پرش به مستندات
API

فهرست افزونه‌ها

آنچه می‌توان افزون بر طرح خرید: امروز، یک IP اختصاصی ارسال.

GET/billing/add-ons

هر کدام از 3 فراخوانی را روی فضای کاری شما اجرا می‌کند.

GET /billing/add-ons

آنچه می‌توان افزون بر طرح خرید: امروز، یک IP اختصاصی ارسال.

نمونه

به billing:read نیاز دارد. eligibility می‌گوید فضای کاری شرایط IP اختصاصی را دارد یا نه. طرح Business یا Enterprise و دست‌کم 100,000 ایمیل فرستاده‌شده در یک ماه لازم است، چون زیر این حجم IP اختصاصی بدتر از 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 هرگز خواسته نمی‌شود. صفحهٔ احراز هویت نشان می‌دهد چطور کد بخواهید و آن را تأیید کنید.

مرجع