Importante: Todos os valores na API são representados em centavos.Exemplo: R$ 100,00 =
10000O que são Assinaturas?
Assinaturas são cobranças recorrentes automáticas que permitem você cobrar seus clientes de forma periódica (semanal, mensal, trimestral, etc.) sem precisar criar uma nova transação manualmente a cada ciclo.Cobranças Automáticas
Cobranças processadas automaticamente no ciclo definido
Múltiplos Ciclos
Semanal, quinzenal, mensal, trimestral, semestral ou anual
Período de Trial
Ofereça períodos de teste gratuitos de até 90 dias
Métricas SaaS
MRR, ARR, Churn Rate e outras métricas em tempo real
Ciclos de Cobrança Disponíveis
| Ciclo | Código | Intervalo |
|---|---|---|
| Semanal | WEEKLY | 7 dias |
| Quinzenal | BIWEEKLY | 14 dias |
| Mensal | MONTHLY | 30 dias |
| Trimestral | QUARTERLY | 90 dias |
| Semestral | SEMIANNUAL | 180 dias |
| Anual | YEARLY | 365 dias |
Status de Assinatura
As assinaturas podem ter os seguintes status:| Status | Descrição | Quando Ocorre |
|---|---|---|
PENDING | Aguardando primeiro pagamento | Status inicial após criação |
ACTIVE | Assinatura ativa | Após confirmação do primeiro pagamento |
TRIALING | Em período de trial | Quando há período de teste configurado |
PAUSED | Assinatura pausada | Pausada manualmente pelo vendedor |
CANCELLED | Assinatura cancelada | Cancelada pelo vendedor ou cliente |
PAST_DUE | Pagamento em atraso | Após falhas consecutivas de cobrança |
EXPIRED | Assinatura expirada | Período de assinatura encerrado |
Fluxo de uma Assinatura
Criar Transação com Assinatura
Você cria uma transação via API incluindo o bloco
subscription com enabled: trueMétodos de Pagamento Suportados
PIX
Pagamento recorrente via PIX
Cartão de Crédito
Cobrança automática no cartão tokenizado
Período de Trial
Você pode oferecer um período de teste gratuito para seus clientes:- Mínimo: 0 dias (sem trial)
- Máximo: 90 dias
- Durante o trial, a assinatura fica com status
TRIALING - A primeira cobrança ocorre após o término do período de trial
- O cliente pode cancelar durante o trial sem ser cobrado
Métricas Disponíveis
O sistema calcula automaticamente métricas SaaS importantes:| Métrica | Descrição |
|---|---|
| MRR | Monthly Recurring Revenue - Receita mensal recorrente |
| ARR | Annual Recurring Revenue - Receita anual recorrente |
| Churn Rate | Taxa de cancelamento de assinaturas |
| Total | Total de assinaturas criadas |
| Ativas | Quantidade de assinaturas ativas |
| Canceladas | Quantidade de assinaturas canceladas |