Chuyển đến nội dung chính
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 yêu cầu tối thiểu mã quốc gia ISO hai chữ cái. customer là một liên minh của { customer_id } (để đính kèm khách hàng hiện có) hoặc { email, name? } (để tạo mới). product_price được biểu thị bằng đơn vị tiền tệ thấp nhất.

Tính phí dựa trên mức sử dụng

Tiếp nhận Sự kiện Sử dụng

Theo dõi sự kiện tùy chỉnh cho tính phí dựa trên mức sử dụng:
Sự kiện phải có giá trị event_id độc nhất để đảm bảo idempotency. ID trùng lặp trong cùng yêu cầu bị từ chối và yêu cầu tiếp theo với ID hiện có sẽ bị bỏ qua.

Lấy Sự kiện Sử dụng

Truy xuất thông tin chi tiết về các sự kiện sử dụng:

Cấu hình Proxy

Cấu hình cài đặt proxy cho các runtime khác nhau:

Node.js (sử dụng undici)

Bun

Deno

Logging

Kiểm soát độ chi tiết của bản ghi sử dụng biến môi trường hoặc tùy chọn của client:
Các mức độ bản ghi có sẵn:
  • 'debug' - Hiển thị thông điệp gỡ lỗi, thông tin, cảnh báo và lỗi
  • 'info' - Hiển thị thông điệp thông tin, cảnh báo và lỗi
  • 'warn' - Hiển thị cảnh báo và lỗi (mặc định)
  • 'error' - Chỉ hiển thị lỗi
  • 'off' - Tắt hoàn toàn ghi nhật ký
Ở mức gỡ lỗi, tất cả các yêu cầu và phản hồi HTTP đều được ghi lại, bao gồm tiêu đề và nội dung. Một số tiêu đề xác thực bị ẩn, nhưng dữ liệu nhạy cảm trong nội dung có thể vẫn hiển thị.

Di cư từ SDK Node.js

Nếu bạn đang nâng cấp từ SDK Node.js cũ, SDK TypeScript cung cấp độ an toàn kiểu tốt hơn và các tính năng mới:

View Migration Guide

Tìm hiểu cách di cư từ SDK Node.js sang SDK TypeScript

Tự động phân trang

Phương thức danh sách trong API DodoPayments được phân trang. Bạn có thể sử dụng cú pháp for await … of để lặp qua các mục trên tất cả các trang:
Ngoài ra, bạn có thể yêu cầu từng trang một:

Yêu cầu

Các runtime sau đây được hỗ trợ:
  • Trình duyệt web (Chrome, Firefox, Safari, Edge và nhiều hơn nữa được cập nhật)
  • Node.js 20 LTS hoặc mới hơn (không hết hạn)
  • Deno v1.28.0 hoặc cao hơn
  • Bun 1.0 hoặc mới hơn
  • Cloudflare Workers
  • Vercel Edge Runtime
  • Jest 28 hoặc cao hơn với môi trường "node"
  • Nitro v2.6 hoặc lớn hơn
TypeScript >= 4.9 được hỗ trợ.

Tài nguyên

GitHub Repository

Xem mã nguồn và đóng góp

API Reference

Tài liệu API đầy đủ

Discord Community

Nhận sự trợ giúp và kết nối với các nhà phát triển

Report Issues

Báo cáo lỗi hoặc yêu cầu tính năng

Hỗ trợ

Cần hỗ trợ với SDK TypeScript?

Đóng góp

Chúng tôi hoan nghênh sự đóng góp! Kiểm tra hướng dẫn đóng góp để bắt đầu.
Lần sửa đổi cuối 28 tháng 5, 2026