Entidades básicas da plataforma de recorrência

Para operar a plataforma Vindi é essencial conhecer as entidades básicas do sistema. As definições a seguir serão úteis tanto para a operação através do painel de administração quanto para o desenvolvimento de integrações via API.

Plano

Um plano define como suas assinaturas serão vendidas, renovadas e faturadas. Por exemplo, uma academia pode possuir um "Plano mensal" que é renovado automaticamente todo mês. Todo plano deve possuir pelo menos um produto. A precificação de um plano é definida através de seus produtos associados.

Produto

O produto define exatamente o tipo de serviço prestado ou mercadoria vendida. Um clube de assinaturas de vinho pode ter um produto "Garrafa de vinho tinto 750ml". Uma escola de inglês pode configurar os seguintes produtos, por exemplo: "Mensalidade das aulas", "Taxa de matrícula", "Material", "Aula extra particular", etc.

A combinação de planos e produtos permite grande flexibilidade na criação de assinaturas e o entendimento deste conceito é essencial para a operação do sistema. Podemos dizer que um plano define quando a assinatura será renovada/faturada e seus produtos definem quanto a assinatura custará ao cliente.

No exemplo acima, configuramos o "Plano Básico" contendo 3 produtos e depois criamos uma assinatura para um cliente. Observe que também é possível aplicar produtos temporários na assinatura.

Após definir seu catálogo, você poderá cadastrar clientes e efetuar assinaturas. O gráfico abaixo exibe a relação das próximas entidades:

Cliente

Representa uma pessoa física ou jurídica que será o tomador dos seus serviços ou o comprador dos produtos da sua empresa. Deve possuir obrigatoriamente um nome.

Assinatura

É a relação entre um plano (com seus respectivos produtos) e um cliente. Possui uma data de início e representa um contrato de recorrência firmado entre você e seu cliente.

Período

Um período representa uma unidade de tempo da assinatura. Para planos mensais, cada período dura um mês. Planos semanais possuirão períodos que duram 7 dias. Normalmente um período possui uma única fatura. A data de emissão desta fatura é configurável no plano.

Fatura

A fatura totaliza, em valores financeiros, mercadorias ou serviços que serão cobrados do cliente. Uma conta telefônica é um exemplo de fatura que você pode relacionar com seu cotidiano. Uma fatura pode conter vários itens: "Assinatura mensal", "Suporte técnico adicional", "Mensagens enviadas", etc.

Cada linha da fatura está obrigatoriamente associada a um produto. Faturas podem existir independente de assinaturas e neste caso elas são chamadas de "faturas avulsas" e são ligadas diretamente ao cliente. Observe a diferença:

Fatura originada a partir de uma assinatura:

Fatura avulsa:

Normalmente uma fatura possui uma cobrança.

Cobrança

A cobrança informa exatamente o valor que será cobrado do cliente, qual será o método de pagamento utilizado e o número de tentativas restantes. Uma cobrança pode possuir uma ou mais transações.

Transação

Transação é a representação de uma tentativa de cobrança ou estorno. Por exemplo, uma cobrança pendente no cartão de crédito pode possuir diversas transações rejeitadas. A transação é o registro de toda comunicação entre a plataforma Vindi e a instituição financeira usada para processar suas cobranças. Um boleto emitido também é é considerado uma transação.

 

Tem mais dúvidas? Envie uma solicitação

Comentários

Powered by Zendesk