Passer au contenu principal
Le SDK de Facturation est une solution open-source complète qui fournit une infrastructure de facturation intégrale pour les applications web modernes. Il comprend des composants React, des outils CLI et un support d’intégration full-stack pour plusieurs frameworks avec Dodo Payments.

​
Aperçu

Le SDK de Facturation offre :
  • Composants React : Composants de facturation préconstruits et personnalisables pour les applications React
  • Outils CLI : Interface en ligne de commande pour l’initialisation de projet et la gestion des composants
  • Support de Framework : Intégration avec Next.js, Express.js, Hono, Fastify et React
  • Fournisseur de Paiement : Intégration complète avec Dodo Payments

​
Démarrage Rapide

Commencez avec le SDK de Facturation en quelques minutes :
1

Installer le CLI

Utilisez npx pour exécuter le CLI sans installation :
npx @billingsdk/cli --help
Ou installez-le globalement pour une utilisation fréquente :
npm install -g @billingsdk/cli
2

Initialiser un Projet

Exécutez la configuration interactive pour créer un nouveau projet de facturation :
npx @billingsdk/cli init
Vous serez invité à sélectionner :
  • Votre framework préféré (Next.js, Express.js, Hono, Fastify, React)
  • Votre fournisseur de paiement (Dodo Payments)
3

Ajouter des Composants

Ajoutez des composants de facturation individuels à votre projet :
npx @billingsdk/cli add pricing-table-one
npx @billingsdk/cli add subscription-management

​
Frameworks Supportés

Le SDK de Facturation prend en charge plusieurs frameworks avec une intégration complète de Dodo Payments :
FrameworkDodo Payments
Next.js✅ Oui
Express.js✅ Oui
Hono✅ Oui
React✅ Oui
Fastify✅ Oui

​
Commandes CLI

​
@billingsdk/cli init

Initialisez un nouveau projet de facturation avec une configuration complète incluant la configuration du framework, l’intégration de Dodo Payments et les dépendances essentielles. Ce que cela fait :
  1. Sélection de Framework : Choisissez votre framework préféré
  2. Installation de Modèle : Télécharge et installe les modèles spécifiques au framework avec l’intégration de Dodo Payments
  3. Gestion des Dépendances : Installe automatiquement les dépendances requises
  4. Génération de Fichiers : Crée les fichiers de configuration nécessaires et le code de base
Exemple : 
npx @billingsdk/cli init

​
@billingsdk/cli add

Ajoutez des composants de facturation individuels à votre projet existant en utilisant le système de registre shadcn/ui. Exemples : 
# 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
Ce qui se passe :
  1. Télécharge la configuration du composant depuis le registre
  2. Installe les fichiers de composant dans votre components/billingsdk/ répertoire
  3. Met à jour la configuration de votre projet si nécessaire
  4. Installe toutes les dépendances supplémentaires

​
Structure des Fichiers Générés

Après avoir exécuté init, vous obtiendrez une structure de projet complète avec :
  • Routes API : Points de terminaison complets pour le paiement, les clients, les produits, les abonnements et les webhooks
  • Hooks : Hooks React pour les opérations de facturation (si vous utilisez React/Next.js)
  • Fichiers de Bibliothèque : Initialisation du client du fournisseur de paiement et utilitaires
  • Configuration de l’Environnement : Fichiers d’exemple de variables d’environnement

​
Exemple de Structure Next.js

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

​
Configuration de l’Environnement

Configurez vos variables d’environnement après l’initialisation : 
# 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
Conservez toujours vos clés API en toute sécurité en utilisant des variables d’environnement. Ne les engagez jamais dans le contrôle de version.

​
Composants Disponibles

Le SDK de Facturation fournit une collection complète de composants React :
  • Tables de Tarification : Plusieurs variantes pour afficher les prix des produits
  • Gestion des Abonnements : Composants pour gérer les abonnements des clients
  • Suivi de l’Utilisation : Composants visuels pour suivre la facturation basée sur l’utilisation
  • Composants de Paiement : Flux de paiement préconstruits
  • Portail Client : Composants pour l’auto-service des clients

​
Open Source

Le SDK de Facturation est construit sur des principes open-source :
  • 🔍 Transparence : Visibilité complète sur le fonctionnement des composants
  • 🤝 Communauté : Construit par des développeurs, pour des développeurs
  • 🔒 Sécurité : Code ouvert signifie meilleure sécurité grâce à la révision par les pairs
  • 📈 Innovation : Itération plus rapide grâce aux contributions de la communauté
Le SDK de Facturation est publié sous la Licence Publique Générale GNU (GPL), garantissant que le projet reste ouvert et gratuit.

​
Obtenir de l’Aide

Besoin d’assistance avec le SDK de Facturation ?

​
Contribuer

Nous accueillons les contributions ! Consultez notre guide de contribution pour plus de détails sur :
  • Signaler des bogues
  • Demander des fonctionnalités
  • Soumettre des demandes de tirage
  • Ajouter de nouveaux composants
  • Améliorer la documentation

​
En Savoir Plus

Documentation Complète

Guide complet du SDK de Facturation avec des exemples et des meilleures pratiques

Référence CLI

Documentation détaillée du CLI pour toutes les commandes et options

Bibliothèque de Composants

Parcourez tous les composants disponibles avec des exemples en direct