Changelog da API

Mantenha-se atualizado com as mudanças e histórico de versões da API

Acompanhe as atualizações e o histórico de versões da API. Este changelog é atualizado continuamente com melhorias, correções e mudanças relevantes. Sugestões de features ou melhorias podem ser enviadas pela área de Roadmap no dashboard. Feedbacks também são bem-vindos no nosso Discord (#dev).

Atualizações Recentes

​

4 de Mai, 2026

Assinaturas: cancelar, alterar plano e registrar uso

Três novos endpoints de gerenciamento de assinaturas foram adicionados à API v2, completando o ciclo de vida de cobranças recorrentes.

O que mudou:

• POST /v2/subscriptions/cancel — cancela uma assinatura ativa imediatamente, interrompendo todas as cobranças futuras
• POST /v2/subscriptions/change-plan — troca o produto principal da assinatura (upgrade ou downgrade); o novo valor começa a ser cobrado no próximo ciclo
• POST /v2/subscriptions/record-usage — registra unidades de uso de produtos pay-as-you-go vinculados à assinatura; o total é incluído na próxima cobrança do ciclo

Permissões necessárias:

Endpoint	Permissão
POST /subscriptions/cancel	SUBSCRIPTION:DELETE
POST /subscriptions/change-plan	SUBSCRIPTION:CREATE
POST /subscriptions/record-usage	SUBSCRIPTION:CREATE

Consulte a documentação de assinaturas para exemplos completos e detalhes de cada endpoint.

---

​

29 de Abr, 2026

Webhooks de Assinatura: novos eventos subscription.plan_changed e subscription.payment_failed

Dois novos eventos de webhook foram adicionados ao fluxo de assinaturas, dando mais visibilidade sobre o ciclo de vida das cobranças recorrentes dos seus clientes.

O que mudou:

• subscription.plan_changed — disparado quando o cliente muda de plano dentro de uma assinatura ativa (upgrade ou downgrade). O payload inclui o objeto subscription atualizado com o novo valor e frequência.
• subscription.payment_failed — disparado quando uma tentativa de cobrança recorrente falha (ex: cartão recusado, saldo insuficiente). O payload inclui o objeto payment com o status FAILED e o campo reason indicando o motivo da falha.

Por que isso importa?

Antes, quando um pagamento falhava ou um plano era alterado, seu sistema dependia de consultas ativas à API para detectar a mudança. Agora você recebe a notificação automaticamente, podendo reagir em tempo real — enviar um e-mail de cobrança, pausar acesso, ou registrar a troca de plano sem nenhuma consulta adicional.

Eventos disponíveis em assinaturas:

Evento	Quando é disparado
subscription.completed	Assinatura criada e ativada
subscription.renewed	Cobrança recorrente paga com sucesso
subscription.cancelled	Assinatura cancelada
subscription.plan_changed	Plano da assinatura alterado
subscription.payment_failed	Tentativa de cobrança recorrente falhou

---

​

20 de Abr, 2026

API v2 disponível para todos

A API v2 está agora disponível publicamente para todos os integradores, encerrando a fase beta. Não é mais necessário entrar em contato com o suporte para obter acesso.

O que mudou:

• A API v2 deixa de ser exclusiva para clientes selecionados e passa a ser o padrão para todos
• Novos cadastros já têm acesso à v2 diretamente, sem nenhuma etapa adicional
• Toda a documentação oficial passa a referenciar a v2 como versão atual

Próximos passos recomendados:

Se você ainda utiliza a v1, recomendamos iniciar a migração para a v2. A v1 continuará funcionando até 1º de março de 2028.

---

​

17 de Abr, 2026

Checkout Transparente: rotas de Boleto e Boleto Transparente

Adicionadas as rotas de Boleto e Boleto Transparente ao Checkout Transparente, permitindo a criação de cobranças via boleto bancário diretamente pela API.

O que mudou:

• Adicionado suporte ao método BOLETO na rota POST /v2/transparents/create
• Boleto passa a ser uma opção de pagamento no fluxo de checkout transparente

Exemplo de uso:

// POST /v2/transparents/create
{
  "method": "BOLETO",
  "data": {
    "amount": 10000,
    "customer": {
      "name": "João Silva",
      "taxId": "123.456.789-00",
      "email": "[e-mail]"
    }
  }
}

---

​

26 de Mar, 2026

Checkouts e Assinaturas: suporte ao campo metadata na criação

As rotas de criação de cobrança passam a aceitar e persistir um campo metadata customizado enviado pelo integrador.

O que mudou:

• Adicionado campo metadata (objeto chave-valor) no body das rotas:
  • POST /v2/checkouts/create
  • POST /v2/subscriptions/create
• O metadata enviado é salvo e retornado no objeto de cobrança dentro do campo metadata

Exemplo de uso:

// POST /v2/checkouts/create
{
  "items": [{ "id": "prod_abc123", "quantity": 1 }],
  "metadata": {
    "orderId": "order_xyz",
    "source": "mobile"
  },
  ...
}

Resposta:

{
  "id": "bill_abc123",
  "metadata": {
    "orderId": "order_xyz",
    "source": "mobile"
  },
  ...
}

---

​

19 de Mar, 2026

Webhooks de Assinatura: novo campo checkout no payload

Os eventos de assinatura (subscription.completed, subscription.renewed, subscription.cancelled) passam a retornar um novo campo checkout dentro de data, contendo o objeto completo do checkout associado à cobrança.

O que mudou:

• Adicionado campo checkout em data com os detalhes do checkout associado à cobrança (id, url, amount, items, status, methods, etc.)
• Adicionado campo id no nível raiz do payload (identificador único do log do webhook)

Estrutura anterior:

{
  "event": "subscription.completed",
  "data": {
    "subscription": { ... },
    "customer": { ... },
    "payment": { ... },
    "payerInformation": { ... }
  }
}

Nova estrutura:

{
  "id": "log_abc123xyz",
  "event": "subscription.completed",
  "data": {
    "subscription": { ... },
    "customer": { ... },
    "payment": { ... },
    "payerInformation": { ... },
    "checkout": { ... }
  }
}

---

​

6 de Mar, 2026

Nova versão da API

A API v2 está em beta e passa a ser o novo padrão oficial. Tudo que é novo daqui pra frente roda nela.

O que isso significa na prática?

Todas as features novas — Checkout Transparente, Cartão de crédito, Assinatura ou qualquer novidade que vier — estarão disponíveis somente na API v2. Se você quiser usar o que há de mais recente, v2 é o caminho.

Como usar a API v2?

A API v2 está disponível para clientes selecionados até o fim da fase beta. Se você quiser participar do beta, entre em contato com o nosso suporte ao cliente.

Posso usar v1 e v2 ao mesmo tempo?

Pode, sim. As duas convivem em paralelo. Mas a gente recomenda migrar para a v2 o quanto antes: mais estabilidade e acesso a todas as funcionalidades novas.

E a API v1?

A API v1 segue funcionando e será mantida até 1º de março de 2028. Depois dessa data ela será descontinuada. Então vale ir se organizando e fazendo a migração com calma.

Se você ainda precisa consultar a documentação da v1 durante a migração:

• Em produção, selecione a versão v1 no seletor de versões no topo desta documentação ou acessar o link

---

​

Antes da API v2

Esquecemos os updates antes da v2. Prometemos que todo novo update aparecerá por aqui.