Pular para o conteúdo principal
Billing SDK é uma solução abrangente de código aberto que fornece uma infraestrutura de cobrança completa para aplicações web modernas. Inclui componentes React, ferramentas de CLI e suporte à integração full-stack para múltiplos frameworks com Dodo Payments.

​
Visão Geral

Billing SDK oferece:
  • Componentes React: Componentes de cobrança pré-construídos e personalizáveis para aplicações React
  • Ferramentas de CLI: Interface de linha de comando para inicialização de projetos e gerenciamento de componentes
  • Suporte a Frameworks: Integração com Next.js, Express.js, Hono, Fastify e React
  • Provedor de Pagamento: Integração completa com Dodo Payments

​
Começo Rápido

Comece com Billing SDK em minutos:
1

Instalar a CLI

Use npx para executar a CLI sem instalação:
npx @billingsdk/cli --help
Ou instale globalmente para uso frequente:
npm install -g @billingsdk/cli
2

Inicializar um Projeto

Execute a configuração interativa para criar um novo projeto de cobrança:
npx @billingsdk/cli init
Você será solicitado a selecionar:
  • Seu framework preferido (Next.js, Express.js, Hono, Fastify, React)
  • Seu provedor de pagamento (Dodo Payments)
3

Adicionar Componentes

Adicione componentes de cobrança individuais ao seu projeto:
npx @billingsdk/cli add pricing-table-one
npx @billingsdk/cli add subscription-management

​
Frameworks Suportados

Billing SDK suporta múltiplos frameworks com integração abrangente ao Dodo Payments:
FrameworkDodo Payments
Next.js✅ Sim
Express.js✅ Sim
Hono✅ Sim
React✅ Sim
Fastify✅ Sim

​
Comandos da CLI

​
@billingsdk/cli init

Inicialize um novo projeto de cobrança com configuração completa, incluindo configuração de framework, integração com Dodo Payments e dependências essenciais. O que faz:
  1. Seleção de Framework: Escolha seu framework preferido
  2. Instalação de Template: Baixa e instala templates específicos do framework com integração ao Dodo Payments
  3. Gerenciamento de Dependências: Instala automaticamente as dependências necessárias
  4. Geração de Arquivos: Cria arquivos de configuração necessários e código boilerplate
Exemplo: 
npx @billingsdk/cli init

​
@billingsdk/cli add

Adicione componentes de cobrança individuais ao seu projeto existente usando o sistema de registro shadcn/ui. Exemplos: 
# 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
O que acontece:
  1. Baixa a configuração do componente do registro
  2. Instala os arquivos do componente no seu components/billingsdk/ diretório
  3. Atualiza a configuração do seu projeto se necessário
  4. Instala quaisquer dependências adicionais

​
Estrutura de Arquivos Gerados

Após executar init, você obterá uma estrutura de projeto completa com:
  • Rotas da API: Endpoints abrangentes para checkout, clientes, produtos, assinaturas e webhooks
  • Hooks: Hooks React para operações de cobrança (se estiver usando React/Next.js)
  • Arquivos de Biblioteca: Inicialização do cliente do provedor de pagamento e utilitários
  • Configuração de Ambiente: Arquivos de variáveis de ambiente de exemplo

​
Estrutura de Exemplo do 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

​
Configuração de Ambiente

Configure suas variáveis de ambiente após a inicialização: 
# 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
Sempre armazene suas chaves de API de forma segura usando variáveis de ambiente. Nunca as comite no controle de versão.

​
Componentes Disponíveis

Billing SDK fornece uma coleção abrangente de componentes React:
  • Tabelas de Preços: Múltiplas variantes para exibir preços de produtos
  • Gerenciamento de Assinaturas: Componentes para gerenciar assinaturas de clientes
  • Monitoramento de Uso: Componentes visuais para rastrear cobrança baseada em uso
  • Componentes de Checkout: Fluxos de checkout pré-construídos
  • Portal do Cliente: Componentes para autoatendimento do cliente

​
Código Aberto

Billing SDK é construído sobre princípios de código aberto:
  • 🔍 Transparência: Total visibilidade sobre como os componentes funcionam
  • 🤝 Comunidade: Construído por desenvolvedores, para desenvolvedores
  • 🔒 Segurança: Código aberto significa melhor segurança através de revisão por pares
  • 📈 Inovação: Iteração mais rápida através de contribuições da comunidade
Billing SDK é lançado sob a Licença Pública Geral GNU (GPL), garantindo que o projeto permaneça aberto e gratuito.

​
Obtendo Ajuda

Precisa de assistência com o Billing SDK?

​
Contribuindo

Agradecemos contribuições! Veja nosso guia de contribuição para detalhes sobre:
  • Relatar bugs
  • Solicitar recursos
  • Enviar pull requests
  • Adicionar novos componentes
  • Melhorar a documentação

​
Saiba Mais

Documentação Completa

Guia completo para Billing SDK com exemplos e melhores práticas

Referência da CLI

Documentação detalhada da CLI para todos os comandos e opções

Biblioteca de Componentes

Navegue por todos os componentes disponíveis com exemplos ao vivo