تخطَّ إلى المستندات
API

فتح بوابة الفوترة

الرابط الذي تُغيَّر فيه الخطة أو تُلغى.

POST/billing/portal

ينفّذ الاستدعاء الحقيقي على مساحة عملك.

POST /billing/portal

الرابط الذي تُغيَّر فيه الخطة أو تُلغى.

مثال

يتطلب billing:write. هو «إدارة» في الخطط والفوترة: في البوابة يغيّر الشخص الخطة أو يلغيها، ويحدّث البطاقة، وينزّل الفواتير السابقة. الجسم اختياري، وtheme وlocale يحددان مظهر الصفحة.

curl
curl -X POST "$OE/billing/portal" -H "$AUTH" -H 'content-type: application/json' \  -d '{ "theme": "dark" }'
الاستجابة
{ "object": "billing_portal", "url": "https://billing.example.com/portal/s/Qm4vT8" }

لا يُدفع شيء عبر API. يفتح الرابط صفحة مزوّد الدفع، حيث يدفع الشخص أو يغيّر البطاقة أو يلغي، كما يفعل من التطبيق.

يحتاج رمز وصول OAuth إلى رمز تحقق لهذا الاستدعاء. وإلى أن يتحقق التطبيق من رمز خلال آخر 60 دقيقة، يردّ الاستدعاء بـ 403 step_up_required ولا يغيّر شيئًا. ولا يُطلب ذلك من مفتاح API أبدًا. وتبيّن صفحة المصادقة كيف تطلب رمزًا وتتحقق منه.

المرجع