Zum Hauptinhalt springen
Billing SDK ist eine umfassende Open-Source-Lösung, die eine vollständige Abrechnungsinfrastruktur für moderne Webanwendungen bereitstellt. Es umfasst React-Komponenten, CLI-Tools und Unterstützung für die Full-Stack-Integration mit mehreren Frameworks von Dodo Payments.

​
Übersicht

Billing SDK bietet:
  • React-Komponenten: Vorgefertigte, anpassbare Abrechnungskomponenten für React-Anwendungen
  • CLI-Tools: Befehlszeilenschnittstelle zur Projektinitialisierung und Komponentenverwaltung
  • Framework-Unterstützung: Integration mit Next.js, Express.js, Hono, Fastify und React
  • Zahlungsanbieter: Vollständige Integration mit Dodo Payments

​
Schnellstart

Starten Sie mit Billing SDK in wenigen Minuten:
1

Installieren Sie die CLI

Verwenden Sie npx, um die CLI ohne Installation auszuführen:
npx @billingsdk/cli --help
Oder installieren Sie sie global für häufige Nutzung:
npm install -g @billingsdk/cli
2

Projekt initialisieren

Führen Sie das interaktive Setup aus, um ein neues Abrechnungsprojekt zu erstellen:
npx @billingsdk/cli init
Sie werden aufgefordert, Folgendes auszuwählen:
  • Ihr bevorzugtes Framework (Next.js, Express.js, Hono, Fastify, React)
  • Ihren Zahlungsanbieter (Dodo Payments)
3

Komponenten hinzufügen

Fügen Sie einzelne Abrechnungskomponenten zu Ihrem Projekt hinzu:
npx @billingsdk/cli add pricing-table-one
npx @billingsdk/cli add subscription-management

​
Unterstützte Frameworks

Billing SDK unterstützt mehrere Frameworks mit umfassender Dodo Payments-Integration:
FrameworkDodo Payments
Next.js✅ Ja
Express.js✅ Ja
Hono✅ Ja
React✅ Ja
Fastify✅ Ja

​
CLI-Befehle

​
@billingsdk/cli init

Initialisieren Sie ein neues Abrechnungsprojekt mit vollständiger Einrichtung, einschließlich Framework-Konfiguration, Dodo Payments-Integration und wesentlichen Abhängigkeiten. Was es tut:
  1. Framework-Auswahl: Wählen Sie Ihr bevorzugtes Framework
  2. Template-Installation: Lädt und installiert frameworkspezifische Templates mit Dodo Payments-Integration
  3. Abhängigkeitsmanagement: Installiert automatisch erforderliche Abhängigkeiten
  4. Dateigenerierung: Erstellt notwendige Konfigurationsdateien und Boilerplate-Code
Beispiel: 
npx @billingsdk/cli init

​
@billingsdk/cli add

Fügen Sie einzelne Abrechnungskomponenten zu Ihrem bestehenden Projekt mit dem shadcn/ui-Registrierungssystem hinzu. Beispiele: 
# Add a pricing table
npx @billingsdk/cli add pricing-table-one

# Add subscription management
npx @billingsdk/cli add subscription-management

# Add usage monitoring
npx @billingsdk/cli add usage-meter-circle
Was passiert:
  1. Lädt die Komponenten-Konfiguration aus dem Register
  2. Installiert die Komponenten-Dateien in Ihrem components/billingsdk/ Verzeichnis
  3. Aktualisiert Ihre Projektkonfiguration, falls erforderlich
  4. Installiert zusätzliche Abhängigkeiten

​
Struktur der generierten Dateien

Nach dem Ausführen von init erhalten Sie eine vollständige Projektstruktur mit:
  • API-Routen: Umfassende Endpunkte für Checkout, Kunden, Produkte, Abonnements und Webhooks
  • Hooks: React-Hooks für Abrechnungsoperationen (bei Verwendung von React/Next.js)
  • Bibliotheksdateien: Initialisierung des Zahlungsanbieter-Clients und Dienstprogramme
  • Umgebungs-Konfiguration: Beispiel-Umgebungsvariablen-Dateien

​
Next.js Beispielstruktur

your-project/
├── app/api/
│   └── (dodopayments)/
│       ├── checkout/route.ts
│       ├── customer/route.ts
│       ├── customer/payments/route.ts
│       ├── customer/subscriptions/route.ts
│       ├── product/route.ts
│       ├── products/route.ts
│       └── webhook/route.ts
├── hooks/
│   └── useBilling.ts
├── lib/
│   └── dodopayments.ts
└── .env.example

​
Umgebungs-Konfiguration

Konfigurieren Sie Ihre Umgebungsvariablen nach der Initialisierung: 
# DodoPayments
DODO_PAYMENTS_API_KEY=your_api_key_here
DODO_PAYMENTS_ENVIRONMENT=test_mode
DODO_PAYMENTS_WEBHOOK_KEY=your_webhook_key_here

# App URL
NEXT_PUBLIC_APP_URL=http://localhost:3000
Bewahren Sie Ihre API-Schlüssel immer sicher mit Umgebungsvariablen auf. Fügen Sie sie niemals der Versionskontrolle hinzu.

​
Verfügbare Komponenten

Billing SDK bietet eine umfassende Sammlung von React-Komponenten:
  • Preistabellen: Mehrere Varianten zur Anzeige von Produktpreisen
  • Abonnementverwaltung: Komponenten zur Verwaltung von Kundenabonnements
  • Nutzungsüberwachung: Visuelle Komponenten zur Verfolgung der nutzungsbasierten Abrechnung
  • Checkout-Komponenten: Vorgefertigte Checkout-Flows
  • Kundenportal: Komponenten für den Selbstservice der Kunden

​
Open Source

Billing SDK basiert auf Open-Source-Prinzipien:
  • 🔍 Transparenz: Volle Sichtbarkeit, wie Komponenten funktionieren
  • 🤝 Gemeinschaft: Entwickelt von Entwicklern für Entwickler
  • 🔒 Sicherheit: Offener Code bedeutet bessere Sicherheit durch Peer-Review
  • 📈 Innovation: Schnellere Iteration durch Beiträge der Gemeinschaft
Billing SDK wird unter der GNU General Public License (GPL) veröffentlicht, die sicherstellt, dass das Projekt offen und kostenlos bleibt.

​
Hilfe erhalten

Benötigen Sie Unterstützung mit Billing SDK?

​
Mitwirken

Wir freuen uns über Beiträge! Siehe unseren Beitragsleitfaden für Details zu:
  • Fehlerberichten
  • Funktionsanfragen
  • Einreichung von Pull-Requests
  • Hinzufügen neuer Komponenten
  • Verbesserung der Dokumentation

​
Mehr erfahren

Vollständige Dokumentation

Vollständiger Leitfaden zu Billing SDK mit Beispielen und Best Practices

CLI-Referenz

Detaillierte CLI-Dokumentation für alle Befehle und Optionen

Komponentenbibliothek

Durchsuchen Sie alle verfügbaren Komponenten mit Live-Beispielen