Skip to main content
Vindicia Knowledge Center

Details

ID

Seu identificador exclusivo para a Assinatura.

Nome

Seu nome para a assinatura.

Observe que isso é para uso interno e não é igual à descrição que aparecerá nos demonstrativos de cartão de crédito de seus clientes.

Descrição da cobrança

Insira uma descrição informativa do plano de cobrança. 

Formato da fatura

Para o tipo de método de pagamento: Pagar por fatura, define o formato no qual as Faturas são geradas para seus clientes. Para todas as outras Assinaturas, define o formato no qual as declarações de cobrança são enviadas por e-mail para seus clientes.

  • Não enviar - nenhuma declaração é enviada
  • Anexo - envia os demonstrativos como anexos em PDF por e-mail
  • Em linha - envia os demonstrativos como texto simples em linha
Modelo de fatura

Para o tipo de método de pagamento: Pagar por fatura, define o modelo usado para as Faturas. Para todas as outras Assinaturas, define o modelo (carregado) usado para os e-mails de demonstrativos de cobrança.

ID do afiliado

Campo de texto personalizado, usado para rastrear afiliados.

ID do subafiliado

Campo de texto personalizado, usado para rastrear subafiliados.

Status 

O status atual do serviço da assinatura. O status da assinatura fornece um indicador claro e mutuamente exclusivo do status atual do serviço de uma assinatura e de seu lugar no ciclo de vida. O campo Status é somente leitura.

  • Ativo: A Assinatura está ativamente concedendo serviço e faturando de acordo com o Plano de cobrança atribuído e os Itens de assinatura associados.
  • Cancelado: A assinatura não está mais concedendo serviços ativamente. Ela foi cancelada por uma ação do usuário, do estabelecimento ou do sistema - por exemplo, o cliente cancelou a cobrança recorrente ou o serviço; chamadas da API para cancelar a assinatura ou interromper a cobrança do Cliente; ou se um estorno foi recebido para uma transação gerada pela Assinatura. Cancelado é um status final e permanente. A condição de Cobrança desta Assinatura é esclarecida pelo Estado de cobrança atual. Observe que o cliente que possui a Assinatura detém o direito até a data final da Assinatura. 
  • Excluído: A Assinatura foi removida administrativamente - o conteúdo desse status somente pode ser exibido em relatórios personalizados e especiais.
  • Teste simulado: A Assinatura foi criada temporariamente a serviço de um teste simulado - ela não estará disponível após a execução do teste.
  • Expirado: A Assinatura não está mais concedendo serviços ativamente - seu plano fixo ou não recorrente terminou e nenhuma cobrança adicional está agendada ou é possível.
  • Herdado suspenso: Esse status é usado em cenários limitados para Assinaturas herdadas que terminaram com um status de Falha persistente, mas que, de outra forma, não atendiam às condições dos novos valores de status.
  • Ativação pendente: A Assinatura foi totalmente criada, tem uma data de início que está no futuro e ainda não concedeu o serviço autorizado nem foi cobrada. A data de início da Assinatura ainda pode ser alterada.
  • Cancelamento pendente: A assinatura está Ativa, mas tem cancelamento agendado. A Assinatura deixará de estar ativa na data final atual.
  • Processando: A Assinatura foi recém-criada e ainda está sendo definida administrativamente. Não está fornecendo serviço autorizado nem foi cobrada. Normalmente, esse status será Ativação pendente: a Assinatura foi completamente criada, mas tem uma data de início no futuro. A Assinatura ainda não está concedendo o serviço autorizado nem foi cobrada. A data de início da Assinatura ainda pode ser alterada.
  • Desconhecido: Apenas para uso interno.
  • Atualizado: Um status final dado a uma versão mais antiga de uma Assinatura que foi explicitamente transferida usando o método de API AutoBill.upgrade().
Estado de cobrança

O estado de cobrança apresenta a condição financeira de cobrança da Assinatura. Esse membro de dados define a condição de cobrança atual da assinatura e, combinado ao campo de status, fornece uma representação definitiva da condição atual de uma Assinatura. O campo Estado de cobrança é somente leitura.

  • Desconhecido: Apenas para uso interno.
  • Boa categoria: A cobrança para o período de cobrança atual foi bem-sucedida
  • Gratuito/avaliação: A definição atual do Período de cobrança da assinatura (conforme especificado pelo Plano de cobrança atual) é totalmente gratuita. Esse pode ser um estado temporário ou enquanto o período de cobrança estiver configurado como gratuito, ou permanente se o Plano de cobrança for permanentemente gratuito. Este estado não se aplica quando a condição gratuita é alcançada devido a uma aplicação de Campanha.
  • Em repetição: A Assinatura ainda está ativa, mas em repetição, e tem pelo menos um período de cobrança em que houve uma tentativa fracassada de cobrança; a Assinatura ainda está dentro do período de repetição configurado e ainda pode ser salva pelos processos automatizados ou pela ação do cliente. Este estado corresponde ao status anterior de Erro aceitável. No novo esquema, ele somente será pareado com o status Ativo.
  • Método de pagamento não usável: A Assinatura ainda está ativa, mas em repetição, e tem pelo menos um período de cobrança em que houve uma tentativa fracassada de cobrança, além de ter recebido um código de erro designado como Falha persistente, que se espera que seja irrecuperável. A Assinatura permanecerá nesse estado, na expectativa de que um novo método de pagamento seja fornecido pelo cliente, até a expiração das repetições ou do período de cortesia. Esse estado corresponde ao status anterior de Erro persistente quando a data de término da Assinatura ainda não tiver passado.
  • Cobrança concluída: A Assinatura não está ativa; completou com sucesso toda a cobrança necessária e não tem cobranças adicionais agendadas.
  • Falha ao cobrar: A Assinatura não está mais ativa e o período de nova tentativa terminou sem uma atualização de método de pagamento bem-sucedida. Esse estado corresponde ao status anterior de Erro persistente, no qual a data de término da Assinatura já passou. Esse estado somente existirá para uma Assinatura com o status: Cancelado.
  • Vencido: A Assinatura recebe um Método de pagamento (fatura) aceito pelo estabelecimento (MAP) e tem pelo menos uma fatura vencida.
  • Aceitação pendente: A Assinatura usa um método de pagamento que exige a ação do estabelecimento ou do cliente antes que as cobranças possam ser processadas, e aguarda essa ação ou aprovação externa.
  • Período gratuito: A Assinatura está atualmente em um período de cobrança gratuito, ou de US$ 0, para qualquer período com exceção de uma condição Gratuito = Verdadeiro somente no período inicial de cobrança (que usa o estado Gratuito/avaliação).
  • Encerrado: A Assinatura foi forçada a entrar em um estado final pelo sistema ou pela ação do estabelecimento. Nenhuma cobrança adicional planejada.
  • Período de cortesia: A Assinatura tem um saldo não pago e está no período de repetição, mas já esgotou as tentativas de repetição agendadas - o único jeito de recuperar é uma atualização bem-sucedida do método de pagamento (geralmente com a intervenção do cliente). A Assinatura ainda está ativa e é concedida até o final do Período de cortesia.
Moeda

Obrigatório. O formato ISO-4217 de três letras para a moeda padrão associada à assinatura.

Observe que, para uma assinatura paga que usa tokens, a moeda é exibida como _VT.

Data inicial

Especifica quando a assinatura foi ativada

Dia de cobrança

O dia do mês em que a assinatura está definida para ser cobrada. Se você selecionar um número maior que o último dia de um determinado mês, a assinatura será cobrada no último dia do mês.

Termos líquidos

Para o tipo de método de pagamento: Pagar por fatura, define o número de dias após a data de cobrança em que a fatura vencerá.

Para todos os outros tipos de pagamento, define o número de dias antes do processo de um pagamento em que um demonstrativo da cobrança será enviado ao cliente

Compromisso mínimo

O número mínimo de ciclos de cobrança para esta assinatura.

Enviar e-mail antes da expiração

Com base nas regras dos planos de cobrança para o número de dias para envio antes da expiração, esse sinalizador indicará se uma notificação por e-mail deverá ser enviada antes da expiração. (ou seja, antes do próximo evento de cobrança do plano de cobrança ocorrer).