Installation
Install the SDK using your package manager of choice:Quick Start
Initialize the client with your API key and start processing payments:Core Features
TypeScript First
Full TypeScript support with comprehensive type definitions for all API endpoints
Auto-Pagination
Automatic pagination for list responses makes working with large datasets effortless
Error Handling
Built-in error types with detailed messages for different failure scenarios
Smart Retries
Configurable automatic retries with exponential backoff for transient errors
Configuration
Environment Variables
Set environment variables for secure configuration:.env
Timeout Configuration
Configure request timeouts globally or per-request:Retry Configuration
Configure automatic retry behavior:Common Operations
Create a Checkout Session
Generate a checkout session for collecting payment information:Manage Customers
Create and retrieve customer information:Handle Subscriptions
Create and manage recurring subscriptions:يتطلب
billing رمز البلد ISO المكوّن من حرفين على الأقل. وcustomer هو اتحاد من { customer_id } (لإرفاق عميل حالي) أو { email, name? } (لإنشاء عميل جديد). ويُعبَّر عن product_price بأصغر فئة من فئات العملة.الفوترة حسب الاستخدام
استيعاب أحداث الاستخدام
تتبّع الأحداث المخصّصة للفوترة حسب الاستخدام:يجب أن تحتوي الأحداث على قيم
event_id فريدة لضمان idempotency. ويُرفض تكرار المعرّفات ضمن الطلب نفسه، بينما يتم تجاهل الطلبات اللاحقة التي تحتوي على معرّفات موجودة مسبقًا.استرداد أحداث الاستخدام
اجلب معلومات تفصيلية حول أحداث الاستخدام:إعداد الوكيل الوسيط
اضبط إعدادات الوكيل الوسيط لبيئات التشغيل المختلفة:Node.js (باستخدام undici)
Bun
Deno
التسجيل
تحكّم في مستوى تفصيل السجلات باستخدام متغيرات البيئة أو خيارات العميل:'debug'- عرض رسائل التصحيح والمعلومات والتحذيرات والأخطاء'info'- عرض رسائل المعلومات والتحذيرات والأخطاء'warn'- عرض التحذيرات والأخطاء (الافتراضي)'error'- عرض الأخطاء فقط'off'- تعطيل التسجيل بالكامل
الترحيل من Node.js SDK
إذا كنت تقوم بالترقية من Node.js SDK القديم، فإن TypeScript SDK يوفر أمانًا محسّنًا للأنواع وميزات إضافية:View Migration Guide
تعرّف على كيفية الترحيل من Node.js SDK إلى TypeScript SDK
الترقيم التلقائي للصفحات
تستخدم أساليب القائمة في DodoPayments API الترقيم على صفحات. يمكنك استخدام صيغةfor await … of للتكرار عبر العناصر الموجودة في جميع الصفحات:
المتطلبات
بيئات التشغيل التالية مدعومة:- متصفحات الويب (أحدث إصدارات Chrome وFirefox وSafari وEdge وغيرها)
- Node.js 20 LTS أو الإصدارات الأحدث (غير منتهية الصلاحية)
- Deno v1.28.0 أو إصدار أحدث
- Bun 1.0 أو إصدار أحدث
- Cloudflare Workers
- Vercel Edge Runtime
- Jest 28 أو إصدار أحدث مع بيئة
"node" - Nitro v2.6 أو إصدار أحدث
الموارد
GitHub Repository
عرض التعليمات البرمجية المصدر والمساهمة
API Reference
وثائق API الكاملة
Discord Community
احصل على المساعدة وتواصل مع المطورين
Report Issues
أبلغ عن الأخطاء أو اطلب ميزات جديدة
الدعم
هل تحتاج إلى مساعدة بشأن TypeScript SDK؟- Discord: انضم إلى خادم مجتمعنا للحصول على الدعم في الوقت الفعلي
- البريد الإلكتروني: تواصل معنا عبر support@dodopayments.com
- GitHub: افتح مشكلة في المستودع