Uma assinatura permite a cobrança recorrente de um cliente (assinante) de forma automática e simples. Para criar uma assinatura, basta informar o plano, o cliente da assinatura e um identificador para ela. Se quiser, é possível criar o cliente e seus dados de pagamento junto com a assinatura.
Uma assinatura só pode ser criada quando o plano informado estiver ativo.
Status de Assinaturas
ATIVO (ACTIVE) ‣ assinatura com fatura paga e pagamento aprovado dentro do ciclo vigente do plano
ATRASADA (OVERDUE) ‣ quando a fatura está atrasada e o pagamento está negado (no caso do cartão). No momento em que o pagamento foi negado (pelo cartão), o status da assinatura se altera para atrasado. No caso de assinaturas com boleto, esse cenário não se aplica.
CANCELADA (CANCELED) ‣ quando o estabelecimento cancela uma assinatura (por motivo de relacionamento, não pagamento ou qualquer outro problema) ou quando o pagamento foi negado depois de todas as retentativas feitas (caso o estabelecimento tenha configurado o cancelamento no final do fluxo). Este é um status final, não se altera mais. Uma vez cancelado a assinatura não pode ser reativada.
EXPIRADA (EXPIRED) ‣ quando o ciclo da assinatura termina. Para isso, todas as faturas e pagamentos precisam estar com status pago. Este é um status final.
PENDENTE (PENDING) ‣ quando o estabelecimento cria uma assinatura, o status inicial fica pendente até que o pagamento via cartão seja autorizado ou boleto seja compensado pela instituição financeira.
SUSPENSA (SUSPENDED) ‣ quando o estabelecimento suspende uma assinatura ou não há o pagamento de uma assinatura com boleto após 7 dias ou quando o pagamento foi negado depois de todas as retentativas feitas (default). Esse status permite alteração para status ativo no futuro. Só é possível suspender uma assinatura caso ela não esteja no último ciclo.
TRIAL ‣ quando o estabelecimento criou uma assinatura a partir de um plano com período de trial.