^{Ciclo de vida de uma assinatura}

Toda assinatura tem um período de cobrança atual, determinado por um início (current_period_start) e um fim (current_period_end).

Por exemplo:

Uma assinatura com um plano de 30 dias criada hoje, terá hoje como current_period_start, e daqui a 30 dias como current_period_end.

As cobranças são sempre realizadas na data do current_period_end. Ou seja, serão feitas ao fim de cada período, iniciando um novo período logo em seguida (se assim foi configurado pela quantidade de cobranças).

Cartão de crédito

Ao criar uma assinatura de cartão de crédito, é feita a primeira tentativa de cobrança do usuário e, sendo bem-sucedida, a assinatura terá o status “Pago”. Se o plano tiver um período de testes, o cartão é validado e seus dados armazenados. A primeira cobrança só será realizada ao fim desse período. Até lá, a assinatura estará como“Em trial”.

Ao fim do “período atual”, realizamos a próxima cobrança da assinatura que, sendo paga com sucesso, permanecerá como paga e seus períodos de início e fim serão atualizados. Se ela falhar por algum motivo (falta de saldo, transação negada pelo banco, etc), entrará no status “Pagamento Pendente”. Durante esse status, tentamos cobrar o assinante conforme configurado na conta (por padrão, 5 dias), notificando-o por e-mail a cada vez que o pagamento falhar ou não for detectado.

Se, após todas as tentativas de cobrança, a assinatura ainda não for paga, seu status passará para “Não pago”. Durante o período em que ela estiver com esse status, podem ser realizadas mais algumas tentativas de cobrança agora, com um intervalo de dias entre elas, conforme também configurado na conta (por padrão, 4 cobranças, com 3 dias de intervalo entre cada uma).

Por fim, caso a assinatura não seja paga, após todas as tentativas de cobrança, pode-se optar pelo cancelamento automático. Após cancelamento, nenhuma outra operação vinculada à assinatura é realizada e ela não pode mais ser utilizada, pois esse é um status final e definitivo.

Boleto

Ao criar uma assinatura de boleto bancário, será emitido um primeiro boleto com 7 dias de validade. Portanto essa assinatura estará com o status “Não pago” até seu pagamento ser detectado, quando mudará para “Pago”. Se o plano possuir um período de testes, o boleto será emitido com data de validade para o fim desse mesmo período e a assinatura terá status “Em trial”.

Ao fim desse período, se o boleto for pago, esse status será alterado para “Pago”. Mas caso o boleto não tenha sido liquidado até o fim do trial, a assinatura passará para “Não pago”.

Ao detectarmos o pagamento de um boleto referente ao "período atual", a assinatura continuará com o status “Pago” e o período será atualizado respeitando a data de pagamento. Dessa forma, se o assinante efetuar o pagamento 5 dias antes do final do período atual, o fim desse terá um acréscimo de 5 dias. Caso o boleto não seja pago até o fim do período ao qual se refere, a assinatura entrará no status “Pagamento Pendente”. Durante esse status, será feita uma tentativa de cobrança ao consumidor, conforme foi configurada na conta (por padrão 5 dias), notificando por e-mail todas as vezes que o pagamento falhar ou não for detectado.

Se, após todas as tentativas de cobrança, a assinatura ainda não for paga, seu status passará para “Não pago”. Durante o período em que ela possuir esse status, poderão ser realizadas mais algumas tentativas de cobrança, agora com um intervalo de dias entre elas, conforme também configurado por padrão, 4 cobranças, com 3 dias de intervalo entre elas).

Por fim, caso a assinatura não seja paga, após todas as tentativas de cobrança, pode-se optar pelo seu cancelamento automático. Após o cancelamento, nenhuma outra operação vinculada à assinatura é realizada e ela não poderá mais ser utilizada, pois esse é um status final e definitivo.

❗ Pontos de atenção

• Sempre que o usuário for notificado por e-mail, mandamos um link de gerenciamento de assinatura, no qual ele pode alterar a forma de pagamento ou o cartão de crédito utilizado.
• Sempre que um boleto de uma assinatura é pago, o próximo será emitido e ficará disponível para pagamento. Desta forma, após o último pagamento, o boleto correspondente ao período atual já poderá ser pago pelo cliente.
• Se a assinatura possuir o status "finalizado (ended)" ou "cancelado (canceled)", ela não poderá mais ser atualizada. Nesse caso, será necessário criar uma nova assinatura.
• Assinaturas com status unpaid ,que são pagas, terão seu novo ciclo com início no dia desse pagamento e duração de 'days' do plano.
• É possível passar o status de invoice_reminder para lembrar o cliente da cobrança de boleto. Essa ação só poderá ser enviado pela API.