Billing SDK

Billing SDK är en omfattande öppen källkods-lösning som tillhandahåller komplett faktureringsinfrastruktur för moderna webbapplikationer. Den inkluderar React-komponenter, CLI-verktyg och fullstackintegrationsstöd för flera ramverk med Dodo Payments.

Översikt

Billing SDK erbjuder:

React-komponenter: Förbyggda, anpassningsbara faktureringskomponenter för React-applikationer
CLI-verktyg: Kommandoradsgränssnitt för projektinitiering och komponenthantering
Ramverksstöd: Integration med Next.js, Express.js, Hono, Fastify och React
Betalningsleverantör: Full integration med Dodo Payments

Snabbstart

Kom igång med Billing SDK på några minuter:

Install the CLI

Använd npx för att köra CLI utan installation:

npx @billingsdk/cli --help

Eller installera det globalt för frekvent användning:

npm install -g @billingsdk/cli

Initialize a Project

Kör den interaktiva konfigurationen för att skapa ett nytt faktureringsprojekt:

npx @billingsdk/cli init

Du ombeds välja:

Ditt föredragna ramverk (Next.js, Express.js, Hono, Fastify, React)
Din betalningsleverantör (Dodo Payments)

Add Components

Lägg till enskilda faktureringskomponenter i ditt projekt:

npx @billingsdk/cli add pricing-table-one
npx @billingsdk/cli add subscription-management

Stödda ramverk

Billing SDK stöder flera ramverk med omfattande Dodo Payments-integration:

Ramverk	Dodo Payments
Next.js	✅ Ja
Express.js	✅ Ja
Hono	✅ Ja
React	✅ Ja
Fastify	✅ Ja

CLI-kommandon

`@billingsdk/cli init`

Initiera ett nytt faktureringsprojekt med komplett installation inklusive ramverkskonfiguration, Dodo Payments-integration och nödvändiga beroenden. Vad det gör:

Ramverksval: Välj ditt föredragna ramverk
Mallinstallation: Laddar ner och installerar ramverkspecifika mallar med Dodo Payments-integration
Beroendehantering: Installerar automatiskt nödvändiga beroenden
Filgenerering: Skapar nödvändiga konfigurationsfiler och grundkod

Exempel:

npx @billingsdk/cli init

`@billingsdk/cli add`

Lägg till individuella faktureringskomponenter i ditt befintliga projekt med hjälp av shadcn/ui-registersystemet. Exempel:

# 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

Vad som händer:

Hämtar komponentkonfigurationen från registret
Installerar komponentfilerna i din components/billingsdk/-katalog
Uppdaterar din projektkonfiguration vid behov
Installerar eventuella ytterligare beroenden

Genererad filstruktur

Efter att ha kört init får du en komplett projektstruktur med:

API-rutter: Omfattande slutpunkter för kassa, kunder, produkter, prenumerationer och webhooks
Hooks: React-hooks för faktureringsoperationer (om du använder React/Next.js)
Biblioteksfiler: Betalningsleverantörens klientinitialisering och verktyg
Miljökonfiguration: Exempel på miljövariabelfiler

Next.js exempelstruktur

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

Miljökonfiguration

Konfigurera dina miljövariabler efter initiering:

# 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

Spara alltid dina API-nycklar säkert med hjälp av miljövariabler. Låt dem aldrig ingå i versionskontrollen.

Tillgängliga komponenter

Billing SDK tillhandahåller en omfattande samling av React-komponenter:

Prissättningsbord: Flera varianter för att visa produktpriser
Prenumerationshantering: Komponenter för att hantera kundprenumerationer
Användningsövervakning: Visuella komponenter för att spåra användningsbaserad fakturering
Kassakomponenter: Förbyggda kassaflöden
Kundportal: Komponenter för kundsjälvbetjäning

Öppen källkod

Billing SDK är byggt på principer för öppen källkod:

🔍 Transparens: Full insyn i hur komponenter fungerar
🤝 Gemenskap: Byggt av utvecklare, för utvecklare
🔒 Säkerhet: Öppen kod innebär bättre säkerhet genom peer review
📈 Innovation: Snabbare iteration genom gemenskapsbidrag

Billing SDK släpps under GNU General Public License (GPL) för att säkerställa att projektet förblir öppet och kostnadsfritt.

Få hjälp

Behöver du hjälp med Billing SDK?

GitHub Issues: Öppna ett ärende
Dokumentation: Besök billingsdk.com/docs
LLMs Full Documentation: billingsdk.com/llms-full.txt

Bidra

Vi välkomnar bidrag! Se vår bidragsguide för detaljer om:

Rapportera buggar
Begära funktioner
Skicka pull requests
Lägga till nya komponenter
Förbättra dokumentationen

Lär dig mer

Full Documentation

Komplett guide till Billing SDK med exempel och bästa praxis

CLI Reference

Detaljerad CLI-dokumentation för alla kommandon och alternativ

Component Library

Bläddra bland alla tillgängliga komponenter med liveexempel

Getting Started

Features

Integrate

Merchant of Record

Miscellaneous

Översikt

Snabbstart

Stödda ramverk

CLI-kommandon

`@billingsdk/cli init`

`@billingsdk/cli add`

Genererad filstruktur

Next.js exempelstruktur

Miljökonfiguration

Tillgängliga komponenter

Öppen källkod

Få hjälp

Bidra

Lär dig mer

Full Documentation

CLI Reference

Component Library

​Översikt

​Snabbstart

​Stödda ramverk

​CLI-kommandon

​@billingsdk/cli init

​@billingsdk/cli add

​Genererad filstruktur

​Next.js exempelstruktur

​Miljökonfiguration

​Tillgängliga komponenter

​Öppen källkod

​Få hjälp

​Bidra

​Lär dig mer

Full Documentation

CLI Reference

Component Library

Översikt

Snabbstart

Stödda ramverk

CLI-kommandon

`@billingsdk/cli init`

`@billingsdk/cli add`

Genererad filstruktur

Next.js exempelstruktur

Miljökonfiguration

Tillgängliga komponenter

Öppen källkod

Få hjälp

Bidra

Lär dig mer