Billing SDK

​

概要

• React Components: React アプリケーション向けの、事前構築済みでカスタマイズ可能な billing コンポーネント。
• CLI Tooling: プロジェクトを初期化し、コンポーネントを追加する command-line interface。
• Framework Support: Next.js、Express.js、Hono、Fastify、NestJS、React 向けのテンプレート。
• Payment Provider: Dodo Payments との完全な統合。

​

クイックスタート

npx @billingsdk/cli --help

npm install -g @billingsdk/cli

npx @billingsdk/cli init

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

​

サポートされているフレームワーク

​

CLIコマンド

​

@billingsdk/cli init

1. Framework Selection: framework と payment provider を選択します。
2. Template Installation: CLI は Billing SDK registry から、選択した framework と provider 用のテンプレートをダウンロードし、そのファイルをインストールします。
3. Dependency Management: CLI は npm、pnpm、Yarn、または Bun を使用して、dodopayments、standardwebhooks、zod など、テンプレートの dependencies をインストールします。
4. File Generation: CLI は configuration files と boilerplate code を書き込みます。Express.js、Fastify、Hono、NestJS の場合は、src/ 配下に書き込みます。

npx @billingsdk/cli init

​

@billingsdk/cli add

# 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

1. shadcn CLI が registry からコンポーネント設定をダウンロードします。
2. コンポーネントファイルを components/billingsdk/ directory にインストールします。
3. 必要に応じてプロジェクト設定を更新します。
4. 追加の dependencies をインストールします。

​

生成されるファイル構成

• API Routes: checkout、customers、customer payments、products、subscriptions、webhooks 用の endpoints。React template には API routes はありません。
• Hooks: React と Next.js 向けの、billing 操作用の useBilling React hook。
• Library Files: lib/dodopayments.ts にある Dodo Payments client のセットアップと helper functions。
• Environment Configuration: 環境ファイルの例 .env.example。

​

Next.js の構成例

your-project/
├── app/api/
│   ├── 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

​

Environment Configuration

# 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

​

利用可能なコンポーネント

• Pricing Tables: product pricing を表示する 8 つの variant、pricing-table-one から pricing-table-eight まで。
• Subscription Management: subscription-management に加え、subscription の cancel や plan の update に使用する cards と dialogs。
• Usage Monitoring: usage-based billing 向けの円形および線形の使用量メーターと使用量テーブル。
• Checkout Components: payment method selector、payment details forms、payment failure card。
• Customer Portal: customer self-service 向けの billing settings、billing screen、invoice history、upcoming charges。

​

オープンソース

• 透明性: すべてのコンポーネントの仕組みを確認できます。
• コミュニティ: 開発者が他の開発者のために開発しています。
• セキュリティ: 誰でもコードを確認し、security issues を見つけられます。
• イノベーション: コミュニティからの contributions により開発が加速します。

​

サポートを受ける

• GitHub Issues: issue を作成
• Documentation: billingsdk.com/docs にアクセス
• LLMs Full Documentation: billingsdk.com/llms-full.txt

​

Contributing

• バグを報告する
• feature をリクエストする
• pull request を送信する
• 新しいコンポーネントを追加する
• Documentation を改善する

​

詳細を見る