Passer au contenu principal
Le SDK TypeScript fournit un accès pratique côté serveur à l’API REST de Dodo Payments pour les applications TypeScript et JavaScript. Il propose des définitions de type complètes, la gestion des erreurs, des tentatives, des délais d’attente et une pagination automatique pour un traitement des paiements sans faille.

Installation

Installez le SDK avec le gestionnaire de paquets de votre choix:

Démarrage rapide

Initialisez le client avec votre clé API et commencez à traiter les paiements :
Stockez toujours vos clés API de manière sécurisée en utilisant des variables d’environnement. Ne les validez jamais dans le contrôle de version ni ne les exposez dans du code côté client.

Fonctionnalités principales

TypeScript First

Prise en charge complète de TypeScript avec des définitions de types exhaustives pour tous les points de terminaison de l’API

Auto-Pagination

La pagination automatique pour les réponses de listes facilite le traitement d’ensembles de données volumineux

Error Handling

Types d’erreur intégrés avec des messages détaillés pour différents scénarios d’échec

Smart Retries

Reprises automatiques configurables avec backoff exponentiel pour les erreurs transitoires

Configuration

Variables d’environnement

Définissez des variables d’environnement pour une configuration sécurisée :
.env

Configuration des délais d’attente

Configurez les délais d’attente des requêtes globalement ou par requête :

Configuration des tentatives

Configurez le comportement de tentative automatique :
Le SDK relance automatiquement les requêtes échouées en raison d’erreurs réseau ou de problèmes serveur (réponses 5xx) avec un backoff exponentiel.

Opérations courantes

Créer une session de paiement

Générez une session de paiement pour collecter des informations de paiement :

Gérer les clients

Créez et récupérez des informations sur les clients :

Gérer les abonnements

Créez et gérez des abonnements récurrents :

Facturation basée sur l’utilisation

Ingest Usage Events

Suivez des événements personnalisés pour la facturation basée sur l’utilisation :
Les événements doivent avoir des valeurs event_id uniques pour garantir l’idempotence. Les identifiants en double au sein d’une même requête sont rejetés, et les requêtes subséquentes contenant des identifiants existants sont ignorées.

Récupérer les événements d’utilisation

Récupérez des informations détaillées sur les événements d’utilisation :

Configuration du proxy

Configurez les paramètres du proxy pour différents environnements d’exécution :

Node.js (en utilisant undici)

Bun

Deno

Journalisation

Contrôlez la verbosité des journaux en utilisant des variables d’environnement ou des options client :
Niveaux de journalisation disponibles :
  • 'debug' - Affiche les messages de débogage, les infos, les avertissements et les erreurs
  • 'info' - Affiche les messages d’info, les avertissements et les erreurs
  • 'warn' - Affiche les avertissements et les erreurs (par défaut)
  • 'error' - Affiche uniquement les erreurs
  • 'off' - Désactive toute journalisation
Au niveau de débogage, toutes les requêtes et réponses HTTP sont journalisées, y compris les en-têtes et les corps. Certains en-têtes d’authentification sont masqués, mais des données sensibles présentes dans les corps peuvent rester visibles.

Migration depuis le SDK Node.js

Si vous mettez à niveau depuis le SDK Node.js hérité, le SDK TypeScript offre une sécurité de type améliorée et des fonctionnalités :

View Migration Guide

Apprenez comment migrer du SDK Node.js vers le SDK TypeScript

Auto-Pagination

Les méthodes de liste de l’API DodoPayments sont paginées. Vous pouvez utiliser la syntaxe for await … of pour parcourir les éléments de toutes les pages :
Alternativement, vous pouvez demander une seule page à la fois :

Exigences

Les environnements d’exécution suivants sont pris en charge :
  • Navigateurs Web (Chrome, Firefox, Safari, Edge à jour, et plus encore)
  • Node.js 20 LTS ou version ultérieure (non-EOL)
  • Deno v1.28.0 ou supérieur
  • Bun 1.0 ou version ultérieure
  • Cloudflare Workers
  • Vercel Edge Runtime
  • Jest 28 ou supérieur avec l’environnement "node"
  • Nitro v2.6 ou supérieur
TypeScript >= 4.9 est pris en charge.

Ressources

GitHub Repository

Consultez le code source et contribuez

API Reference

Documentation complète de l’API

Discord Community

Obtenez de l’aide et connectez-vous avec les développeurs

Report Issues

Signalez des bugs ou demandez des fonctionnalités

Support

Besoin d’aide avec le SDK TypeScript ?

Contribuer

Nous accueillons les contributions ! Consultez les directives de contribution pour commencer. Nous accueillons les contributions ! Consultez les lignes directrices pour contribuer pour commencer.
Dernière modification le 28 mai 2026