Pular para o conteúdo principal
A página Planos de tarifas lista os planos de tarifas de um ledger. Um plano é versionado conforme as tarifas dele mudam.
Habilite o Fees Engine nas configurações do Módulo Midaz antes de usar esta página. Com o Access Manager, a página precisa da permissão de leitura em account-plans.

​
A página Planos de tarifas

Selecione um ledger e abra Fees Engine > Planos de tarifas na barra lateral do Módulo Midaz. A tabela tem estas colunas: Uma chave na coluna Status liga ou desliga um plano. Desligar um plano pede confirmação. Um plano inativo deixa de ser oferecido para novas atribuições, e as contas já atribuídas a ele continuam sendo tarifadas por ele. A chave precisa da permissão de atualização em account-plans. Excluir precisa da permissão de exclusão em account-plans.

​
Crie um plano de tarifas

1

Abra o assistente

Clique em Novo plano. O assistente tem três etapas: Dados do plano, Tarifas e Revisão.
2

Preencha os dados do plano

Dê um nome ao plano, adicione uma descrição e escolha o fuso horário. O plano conta as franquias por mês civil nesse fuso horário.
3

Defina as tarifas

Adicione cada tarifa do plano. Uma tarifa tem um nome, um código de serviço ou schemes, um valor, uma franquia, a conta que recebe a tarifa. A franquia é o número de vezes por mês em que a tarifa não é cobrada. Com 0, ela é cobrada todas as vezes.
4

Revise e crie

Confira o plano e as tarifas dele e clique em Criar plano. Esta etapa precisa da permissão de criação em account-plans. O plano é criado como versão 1, vigente a partir do momento da criação.
O Console nunca cobra uma tarifa de serviço. Seu sistema envia o código de serviço da tarifa para a API de cobranças de tarifas.

​
Veja um plano e publique uma nova versão

Selecione Detalhes no menu da linha para abrir o plano. A página tem uma aba Visão Geral, uma aba Tarifas e uma aba Versões.
  • Visão Geral mostra os dados do plano, a versão vigente e a data a partir da qual essa versão vigora.
  • Tarifas mostra as tarifas da versão vigente.
  • Versões lista cada versão com a situação dela, Vigente, Agendada ou Anterior, e as tarifas.
Editar dados muda o nome, a descrição e o fuso horário do plano. Mudar o fuso horário muda o mês em que a franquia é contada, em todas as contas do plano. As tarifas não são editadas aqui. Editar dados e Nova versão precisam da permissão de atualização em account-plans. Uma versão publicada não pode ser alterada. Para mudar as tarifas, clique em Nova versão. O assistente parte das tarifas da última versão. Você muda, adiciona ou remove tarifas, revisa as mudanças em relação à última versão e escolhe quando a nova versão começa: Agora, ou Em uma data, no fuso horário do plano. Uma versão agendada passa a vigorar na data dela, e a versão vigente continua vigente antes disso.

​
Atribua um plano a uma conta

A página de uma conta tem uma aba Plano de Tarifas quando o Fees Engine está ligado e você tem a permissão de leitura em account-plans. Atribuir e alterar um plano precisam da permissão put em account-plans. Encerrar um plano precisa da permissão delete em account-plans. A aba mostra o plano da conta, a versão vigente e a data da atribuição. Para cada tarifa, mostra a franquia e quanto dela a conta usou no mês, e quantas cobranças excedentes foram feitas.
1

Abra a aba Plano de Tarifas

Na página da conta, abra a aba Plano de Tarifas. Uma conta sem plano segue os pacotes de tarifas do ledger.
2

Escolha o plano

Clique em Atribuir plano, ou em Alterar plano quando a conta já tem um. Escolha um dos planos habilitados do ledger e revise as tarifas dele.
3

Confirme

Confirme. Alterar um plano encerra o plano atual agora, e o novo plano passa a tarifar a conta.
Para encerrar o plano de uma conta, clique em Encerrar plano e confirme. A conta volta a seguir os pacotes de tarifas do ledger.