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

تشغيل الدفع حسب الاستخدام أو إيقافه

المفتاح في الخطط والفوترة، والبطاقة التي يحتاجها في المرة الأولى.

PATCH/billing/pay-as-you-go

ينفّذ أيًّا من الاستدعاءات الـ2 على مساحة عملك.

PATCH /billing/pay-as-you-go

المفتاح في الخطط والفوترة، والبطاقة التي يحتاجها في المرة الأولى.

مثال

يتطلب billing:write. الإيقاف يسري فورًا، ويتوقف الاستخدام عند الحصص. والتشغيل يسري فورًا إذا كانت هناك بطاقة محفوظة. وفي المرة الأولى يكون checkoutUrl رابطًا يضيف فيه الشخص بطاقة، ويبدأ الدفع حسب الاستخدام بعد أن يفعل. وtheme وlocale يحددان مظهر الصفحة التي يفتحها الرابط.

curl
curl -X PATCH "$OE/billing/pay-as-you-go" -H "$AUTH" -H 'content-type: application/json' \  -d '{ "enabled": true, "locale": "de" }'
الاستجابة
{  "object": "pay_as_you_go_switch",  "enabled": false,  "suspended": false,  "activating": false,  "checkoutUrl": "https://checkout.example.com/c/7Yw2kq9RzX4mB1vN?locale=de"}

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

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

بعد الدفع

يتطلب billing:write. بعد أن يضيف الشخص البطاقة، يتحقق POST /billing/pay-as-you-go/confirm لدى مزوّد الدفع ويسجّلها، كما يفعل التطبيق عندما يعود الشخص. يقول enabled هل الدفع حسب الاستخدام مفعّل الآن، واستدعاؤه مرة أخرى آمن.

curl
curl -X POST "$OE/billing/pay-as-you-go/confirm" -H "$AUTH"
الاستجابة
{ "object": "pay_as_you_go_confirmation", "enabled": true }

activating: true من المفتاح يعني أن بطاقة حُفظت للتو وأن الدفع حسب الاستخدام يُشغَّل الآن، فاقرأه مرة أخرى بعد قليل.

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

المرجع