दस्तावेज़ पर जाएँ
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 कुंजी से कभी नहीं पूछा जाता। प्रमाणीकरण पेज बताता है कि कोड कैसे माँगें और सत्यापित करें।

संदर्भ