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.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.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: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:
Anexar complementos
Os complementos estendem seu plano com recursos extras. Anexe-os via API: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 US 299. Consulte preços regionais de complementos para a tabela de níveis completa.
Monitorar uso
Acompanhe o consumo do seu ciclo de faturamento atual para se manter dentro dos limites do seu plano: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: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.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.

