الانتقال إلى المحتوى الرئيسي
The TypeScript SDK provides convenient server-side access to the Dodo Payments REST API for TypeScript and JavaScript applications. It features comprehensive type definitions, error handling, retries, timeouts, and auto-pagination for seamless payment processing.

Installation

Install the SDK using your package manager of choice:

Quick Start

Initialize the client with your API key and start processing payments:
Always store your API keys securely using environment variables. Never commit them to version control or expose them in client-side code.

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:
The SDK automatically retries requests that fail due to network errors or server issues (5xx responses) with exponential backoff.

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 فريدة لضمان عدم التكرار. يتم رفض المعرفات المكررة ضمن نفس الطلب، وتُتجاهل الطلبات اللاحقة التي تحتوي على معرفات موجودة بالفعل.

استرجاع أحداث الاستخدام

جلب معلومات مفصلة عن أحداث الاستخدام:

تكوين الوكيل

تكوين إعدادات الوكيل لأوقات التشغيل المختلفة:

Node.js (باستخدام undici)

Bun

Deno

التسجيل

التحكم في وضوح السجلات باستخدام متغيرات البيئة أو خيارات العميل:
مستويات السجل المتاحة:
  • 'debug' - عرض رسائل التصحيح، المعلومات، التحذيرات، والأخطاء
  • 'info' - عرض رسائل المعلومات، التحذيرات، والأخطاء
  • 'warn' - عرض التحذيرات والأخطاء (افتراضي)
  • 'error' - عرض الأخطاء فقط
  • 'off' - تعطيل جميع السجلات
في مستوى التصحيح، يتم تسجيل جميع طلبات واستجابات HTTP، بما في ذلك الرؤوس والهيئات. يتم حجب بعض رؤوس المصادقة، ولكن قد تظل البيانات الحساسة مرئية في الهيئات.

الانتقال من 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 أو أكبر
TypeScript >= 4.9 مدعومة.

الموارد

GitHub Repository

عرض الكود المصدر والمساهمة

API Reference

وثائق API الكاملة

Discord Community

الحصول على المساعدة والتواصل مع المطورين

Report Issues

الإبلاغ عن الأخطاء أو طلب الميزات

الدعم

هل تحتاج إلى مساعدة مع TypeScript SDK؟

المساهمة

نرحب بالمساهمات! اطلع على إرشادات المساهمة للبدء.
آخر تعديل في ٢٨ مايو ٢٠٢٦