Skip to main content
Das TypeScript SDK bietet bequemen serverseitigen Zugriff auf die Dodo Payments REST API für TypeScript- und JavaScript-Anwendungen. Es verfügt über umfassende Typdefinitionen, Fehlerbehandlung, Wiederholungen, Zeitüberschreitungen und automatische Seitenumbruch für nahtlose Zahlungsabwicklung.

Installation

Installieren Sie das SDK mit dem Paketmanager Ihrer Wahl:

Schnellstart

Initialisieren Sie den Client mit Ihrem API-Schlüssel und beginnen Sie mit der Zahlungsabwicklung:
Speichern Sie Ihre API-Schlüssel stets sicher über Umgebungsvariablen. Kommittieren Sie sie niemals in die Versionsverwaltung und setzen Sie sie nicht in clientseitigem Code ein.

Kernfunktionen

TypeScript First

Vollständige TypeScript-Unterstützung mit umfassenden Typdefinitionen für alle API-Endpunkte

Auto-Pagination

Automatische Paginierung für Listenantworten erleichtert die Arbeit mit großen Datensätzen

Error Handling

Eingebaute Fehlertypen mit detaillierten Meldungen für verschiedene Fehlerfälle

Smart Retries

Konfigurierbare automatische Wiederholungen mit exponentiellem Backoff für temporäre Fehler

Konfiguration

Umgebungsvariablen

Setzen Sie Umgebungsvariablen für eine sichere Konfiguration:
.env

Zeitüberschreitungs-Konfiguration

Konfigurieren Sie Zeitüberschreitungen für Anfragen global oder pro Anfrage:

Wiederholungs-Konfiguration

Konfigurieren Sie das Verhalten automatischer Wiederholungen:
Das SDK wiederholt automatisch Anfragen, die aufgrund von Netzwerkfehlern oder Serverproblemen (5xx-Antworten) fehlschlagen, mit exponentiellem Backoff.

Häufige Operationen

Erstellen einer Checkout-Sitzung

Generieren Sie eine Checkout-Sitzung zur Erfassung von Zahlungsinformationen:

Kunden verwalten

Erstellen und Abrufen von Kundeninformationen:

Abonnements verwalten

Erstellen und verwalten Sie wiederkehrende Abonnements:
POST /subscriptions (die subscriptions.create-Methode des SDK) ist veraltet. Sie funktioniert weiterhin für bestehende Integrationen, aber neue Integrationen sollten Subscriptions über eine Checkout Session erstellen.
billing erfordert mindestens den zweistelligen ISO-Ländercode. customer ist eine Union aus { customer_id } (zum Verknüpfen eines bestehenden Kunden) oder { email, name? } (zum Erstellen eines neuen Kunden). product_price wird in der kleinsten Währungseinheit angegeben.

Nutzungsbasierte Abrechnung

Nutzungsereignisse erfassen

Benutzerdefinierte Ereignisse für die nutzungsbasierte Abrechnung erfassen:
Ereignisse müssen eindeutige event_id-Werte für Idempotenz aufweisen. Doppelte IDs innerhalb derselben Anfrage werden abgelehnt, und nachfolgende Anfragen mit bereits vorhandenen IDs werden ignoriert.

Nutzungsereignisse abrufen

Detaillierte Informationen zu Nutzungsereignissen abrufen:

Proxy-Konfiguration

Proxy-Einstellungen für verschiedene Runtimes konfigurieren:

Node.js (mit undici)

Bun

Deno

Protokollierung

Die Ausführlichkeit der Protokollierung über Umgebungsvariablen oder Client-Optionen steuern:
Verfügbare Protokollierungsebenen:
  • 'debug' – Debug-Nachrichten, Info-Meldungen, Warnungen und Fehler anzeigen
  • 'info' – Info-Meldungen, Warnungen und Fehler anzeigen
  • 'warn' – Warnungen und Fehler anzeigen (Standard)
  • 'error' – Nur Fehler anzeigen
  • 'off' – Protokollierung deaktivieren
Auf der Debug-Ebene werden alle HTTP-Anfragen und -Antworten einschließlich Headern und Bodies protokolliert. Einige Authentifizierungs-Header werden ausgeblendet, aber vertrauliche Daten in Bodies können weiterhin sichtbar sein.

Migration vom Node.js SDK

Wenn Sie ein Upgrade vom älteren Node.js SDK durchführen, bietet das TypeScript SDK eine verbesserte Typsicherheit und zusätzliche Funktionen:

View Migration Guide

Erfahren Sie, wie Sie vom Node.js SDK zum TypeScript SDK migrieren

Automatische Seitennummerierung

Listenmethoden in der DodoPayments API sind paginiert. Sie können die for await … of-Syntax verwenden, um Elemente über alle Seiten hinweg zu durchlaufen:
Alternativ können Sie jeweils eine einzelne Seite anfordern:

Anforderungen

Die folgenden Runtimes werden unterstützt:
  • Webbrowser (aktuelle Versionen von Chrome, Firefox, Safari, Edge und weiteren Browsern)
  • Node.js 20 LTS oder höher (nicht EOL)
  • Deno v1.28.0 oder höher
  • Bun 1.0 oder höher
  • Cloudflare Workers
  • Vercel Edge Runtime
  • Jest 28 oder höher mit der "node"-Umgebung
  • Nitro v2.6 oder höher
TypeScript >= 4.9 wird unterstützt.

Ressourcen

GitHub Repository

Quellcode anzeigen und beitragen

API Reference

Vollständige API-Dokumentation

Discord Community

Hilfe erhalten und mit Entwicklern in Kontakt treten

Report Issues

Fehler melden oder Funktionen anfordern

Support

Benötigen Sie Hilfe mit dem TypeScript SDK?

Mitwirken

Wir freuen uns über Beiträge! Lesen Sie die Richtlinien zum Mitwirken, um zu beginnen.
Zuletzt geändert am 17. August 2026