Saltar para o conteúdo principal
Você pode gerenciar todo o seu ciclo de vida de cobrança através da API ou do console. Este guia aborda como listar planos, estimar custos, criar uma sessão de checkout, verificar sua assinatura, anexar complementos e cancelar quando necessário.

Pré-requisitos

  • Uma conta Truthlocks com um inquilino ativo.
  • Uma chave de API com permissões de faturamento. Consulte Chaves de API para criar uma.

Escolha um plano

Truthlocks oferece cinco níveis de plano. Use o endpoint de planos para buscar o catálogo completo — este é um endpoint público e não requer autenticação.
Consulte visão geral de faturamento para uma comparação de todos os planos.

Estimar seus custos

Antes de assinar, use o endpoint de estimativa para obter uma recomendação de plano com base no seu uso esperado. Este também é um endpoint público.
A resposta inclui um plano recomendado e o total mensal estimado. Para um detalhamento de custos por item, use o endpoint fatura projetada em vez disso.

Verifique suas taxas atuais

As taxas efetivas por uso do seu locatário dependem da sua tabela de preços e região. Obtenha-as com:
A resposta inclui taxas básicas e quaisquer ajustes de preços regionais:
Se sua organização tiver um cartão de tarifas personalizado atribuído por um administrador da plataforma, essas tarifas aparecerão aqui em vez das padrão.

Assinar um plano

Crie uma sessão de checkout para iniciar ou atualizar sua assinatura. O serviço de faturamento seleciona automaticamente o provedor de pagamento correto para sua região.
1

Criar uma sessão de checkout

Chame o endpoint de checkout com o plano desejado e URLs de redirecionamento:
A resposta contém um checkout_url hospedado pelo provedor de pagamento.
2

Redirecionar para o checkout

Envie o usuário para o checkout_url para concluir o pagamento.
3

Confirmar a assinatura

Após o pagamento, verifique se a assinatura está ativa:
Opcionalmente, você pode passar um parâmetro provider (stripe, paystack ou flutterwave) para substituir o roteamento automático baseado em região. Consulte roteamento do provedor para detalhes.

Anexar complementos

Os complementos estendem seu plano com recursos extras. Anexe-os via API:
Se o complemento tiver um preço, a resposta inclui um checkout_url para concluir o pagamento. Complementos gratuitos são ativados imediatamente.
Os preços dos complementos são ajustados automaticamente com base no país de faturamento da sua organização. Locatários em regiões de menor custo pagam uma taxa reduzida — por exemplo, o Pacote de Conformidade custa US149,50/me^snaNigeˊria(multiplicadorde0,5x)emvezdoprec\cobasedeUS 149,50/mês na Nigéria (multiplicador de 0,5x) em vez do preço base de US 299. Consulte preços regionais de complementos para a tabela de níveis completa.
Para remover um complemento:
Consulte gerenciar complementos para o catálogo completo de complementos e detalhes de resposta.

Monitorar uso

Acompanhe o consumo do seu ciclo de faturamento atual para se manter dentro dos limites do seu plano:
Para verificar se uma operação específica está dentro da cota antes de executá-la:

Abrir o portal de faturamento

Redirecione os usuários para o portal de autoatendimento de seu provedor de pagamento para atualizar métodos de pagamento, visualizar faturas ou gerenciar sua assinatura:
A resposta inclui um portal_url. Redirecione o usuário para essa URL. As sessões do portal expiram rapidamente, então gere uma nova URL a cada vez.

Cancelar uma assinatura

Para cancelar, chame o endpoint de cancelamento. O cancelamento entra em vigor no final do período de faturamento atual — você mantém acesso total até então.
Após o término do período, sua conta será rebaixada para o plano Desenvolvedor (gratuito). Para assinar novamente, crie uma nova sessão de checkout.
Você não pode desfazer um cancelamento via API. Para retomar sua assinatura, você precisa passar pelo processo de checkout novamente.

Relacionado

Visão geral do faturamento

Planeje níveis, taxas, direitos e complementos.

Roteamento do provedor

Como os pagamentos são roteados por região.

Referência da API de faturamento

Referência completa do endpoint da API de faturamento.

Direitos

Verifique seus recursos e cotas ativos.