Skip to content

Billing

Consulta de plano e faturamento do tenant. Este endpoint permite que o tenant visualize seu plano atual e limites. Requer papel de manager ou superior.

Importante

O gerenciamento de pagamentos e assinaturas e feito internamente pela equipe Avanter, que se integra com o gateway de pagamento Asaas. Tenants nao interagem diretamente com o gateway de pagamento.

Endpoints

MetodoEndpointDescricaoRole Minimo
GET/api/v1/billing/planInformacoes do plano atualmanager

Consultar Plano

Retorna as informacoes do plano atual, limites de recursos e uso corrente do tenant. Este e um endpoint somente leitura.

GET /api/v1/billing/plan

Exemplo de Request

bash
curl -X GET https://voki.avanter.com.br/api/v1/billing/plan \
  -H "Authorization: Bearer eyJhbGci..." \
  -H "X-Tenant: avanter"

Resposta de Sucesso (200)

json
{
  "data": {
    "plan": "professional",
    "status": "active",
    "max_concurrent_calls": 10,
    "max_users": 50,
    "max_departments": 20,
    "recording_enabled": true,
    "transcription_enabled": true,
    "analytics_enabled": true,
    "current_period_start": "2026-02-01T00:00:00Z",
    "current_period_end": "2026-03-01T00:00:00Z",
    "usage": {
      "active_users": 12,
      "active_departments": 5,
      "calls_this_month": 342,
      "recording_storage_mb": 2048
    }
  }
}

Planos Disponiveis

PlanoPreco (R$)Chamadas SimultaneasUsuariosDepartamentosGravacaoTranscricaoAnalytics
free0121NaoNaoBasico
basic993103SimNaoBasico
advanced39952510SimSimCompleto
professional699105020SimSimCompleto
enterpriseSob consultaIlimitadoIlimitadoIlimitadoSimSimCompleto

Fluxo de Faturamento

O faturamento no Voki e gerenciado internamente pela equipe Avanter:

  1. Cadastro do tenant: O tenant se registra via /api/signup/register selecionando um plano.
  2. Criacao do pagamento: A equipe Avanter cria o pagamento no Asaas atraves do painel interno.
  3. Confirmacao automatica: O Asaas envia um webhook para POST /api/webhooks/asaas quando o pagamento e confirmado.
  4. Ativacao da assinatura: O status da assinatura do tenant e atualizado automaticamente.

Webhook Asaas

O endpoint POST /api/webhooks/asaas e publico (sem autenticacao JWT) mas protegido por validacao de token do Asaas. Os eventos processados incluem:

  • PAYMENT_CONFIRMED - Pagamento confirmado
  • PAYMENT_RECEIVED - Pagamento recebido
  • PAYMENT_OVERDUE - Pagamento em atraso
  • PAYMENT_REFUNDED - Pagamento estornado

Signup

O fluxo de signup para novos tenants utiliza endpoints publicos:

Validar Documento

POST /api/signup/validate-document

Verifica se um CPF/CNPJ e valido e nao esta em uso.

bash
curl -X POST https://voki.avanter.com.br/api/signup/validate-document \
  -H "Content-Type: application/json" \
  -d '{
    "document": "12.345.678/0001-90",
    "document_type": "cnpj"
  }'

Registrar Tenant

POST /api/signup/register

Cria o tenant e o usuario administrador. O plano selecionado fica pendente ate que o pagamento seja confirmado pela equipe Avanter via Asaas.

bash
curl -X POST https://voki.avanter.com.br/api/signup/register \
  -H "Content-Type: application/json" \
  -d '{
    "company_name": "Nova Empresa",
    "document": "12.345.678/0001-90",
    "document_type": "cnpj",
    "admin_name": "Admin",
    "admin_email": "admin@novaempresa.com",
    "admin_password": "senhaSegura123",
    "plan": "professional"
  }'

Documentação da API Voki v4.0