يتم خصم المبلغ من طريقة الدفع المحفوظة لدى المستخدم على منصة Stripe، ويتم إضافة الرصيد إلى الحساب فورًا. تخضع عملية الشراء للحدود المحددة لكل عملية شراء والحدود الشهرية المحددة في إعدادات فوترة واجهة برمجة تطبيقات الوكيل.
طلبPOST https://payments.builtwith.com/v1/billing/api-purchase
أرسل مفتاح فوترة الوكيل المحدد النطاق كـ Authorization: Bearer YOUR_AGENT_BILLING_KEY, وأرسل رمزًا فريدًا Idempotency-Key. أعد استخدام هذا المفتاح فقط عند إعادة محاولة عملية الشراء نفسها.
نص الطلب| مجال | يكتب | مطلوب | وصف |
|---|
credits | number | نعم | عدد الرصيد المتاح للشراء بزيادات ثابتة قدرها 2000. يجب ألا يتجاوز max_per_purchase أو البدل الشهري المتبقي. |
استجابة النجاح (HTTP 200)| مجال | يكتب | وصف |
|---|
success | boolean | true |
credits_purchased | number | تمت إضافة رصيد إلى الحساب. |
cost_usd | number | المبلغ المدفوع بالدولار الأمريكي. |
payment_id | string | معرّف Stripe PaymentIntent للمطابقة. |
credits_available | number | تم تحديث رصيد الائتمان المتاح بعد الشراء. |
مثال على الطلبAuthorization: Bearer YOUR_AGENT_BILLING_KEY
Idempotency-Key: 72b7b97c-3b6d-4c64-9bbf-20fd2a931514
Content-Type: application/json
{ "credits": 2000 }مثال على استجابة النجاح{
"success": true,
"credits_purchased": 2000,
"cost_usd": 99.00,
"payment_id": "pi_3abc123xyz",
"credits_available": 10766
}ردود الأخطاء| HTTP | معنى |
|---|
| 400 | فشل التحقق - مفتاح التكرار مفقود، الرصيد ليس بزيادات 2000، تم تجاوز حد الشراء الواحد، أو تم تجاوز الحد الشهري للتوقيت العالمي المنسق. |
| 401 | مفتاح فوترة الوكيل مفقود أو غير صالح. يتضمن ذلك تحدي WWW-Authenticate. |
| 402 | فشلت عملية الدفع عبر Stripe أو لا توجد طريقة دفع قابلة للدفع مسجلة. |
| 403 | تم توفير مفتاح API واسع النطاق بدلاً من مفتاح الفوترة المحدد النطاق، أو تم تعليق فوترة الحساب. |
| 409 | لا يزال مفتاح التكرار قيد التطوير أو تم استخدامه سابقًا مع مدخلات مختلفة. |
| 405 | الطريقة غير مسموحة - نقطة النهاية تتطلب POST. |