PayZu GatewayRecorrência

Ciclo da assinatura


Nesta páginaOperaçõesStatus da assinaturaDatas de cobrançaFaturas da assinaturaRenovação no cartãoRenovação no PixCarênciaCancelamentoVolta de um cancelamento

Cada cobrança da assinatura é uma fatura, da adesão aos ciclos seguintes, e o pagamento de cada uma decide se a assinatura continua ativa.

Ciclo da assinatura: a adesão paga ativa a assinatura; cada fatura paga leva ao próximo ciclo; a fatura sem pagamento abre a carência, de 7 dias por padrão, e, sem pagamento até o fim dela, a assinatura é cancelada e pode ser reativada em até 30 dias

Operações

Status da assinatura

StatusO que significa
incompleteAguardando o pagamento da fatura da adesão.
activeAssinatura ativa. Na carência, segue active, com grace preenchido.
canceledAssinatura cancelada. O motivo vem em cancellation.reason.

Datas de cobrança

CampoTipoDescrição
billing.anchor_atstringData de referência dos ciclos: o dia da adesão.
billing.next_atstringData da próxima cobrança; nula na assinatura cancelada.
billing.canceled_atstringData do cancelamento; nula enquanto a assinatura não é cancelada.
billing.renewal_failuresintegerRecusas seguidas da cobrança do ciclo no cartão.

Faturas da assinatura

Faturabilling.cycle_numberbilling.due_atbilling.expires_at
Adesão0A criação da assinatura.1 hora depois de due_at.
Ciclo1 em diante, somando 1 a cada renovação.A data do ciclo.due_at mais o grace_days da conta na criação da fatura.

Sem pagamento até o billing.expires_at da adesão, a fatura passa a expired, e a assinatura, a canceled, com o motivo initial_payment_failure. Se a última tentativa no cartão segue sem resposta da adquirente nesse momento, a PayZu espera até 48 horas, contadas dessa tentativa, como em Criar uma assinatura. Na fatura do ciclo, o prazo entre due_at e expires_at é a carência.

O desconto da assinatura conta a adesão.

Ele vale nos primeiros discount.cycles ciclos: com cycles igual a 3, as faturas dos ciclos 0, 1 e 2 têm desconto.

Renovação no cartão

A adquirente cobra cada ciclo no cartão da assinatura, sem chamada sua. A primeira cobrança do ciclo cria a fatura dele, com invoice.created, e cada cobrança entra como tentativa em payments.

ResultadoFaturaAssinaturaEventos
AprovadapaidSegue active, e billing.next_at passa ao ciclo seguinte.invoice.paid e subscription.renewed
Recusadapending, com a tentativa failedEntra na carência.invoice.payment_failed e, na primeira recusa, subscription.grace_started
Sem desfechopending, com a tentativa processingSegue como está até a adquirente aprovar ou recusar.-

Na carência, a fatura recusada aceita nova tentativa, como em Pagar uma fatura.

Renovação no Pix

A PayZu cria a fatura do ciclo 5 dias antes de billing.next_at e leva billing.next_at para o ciclo seguinte. Esses 5 dias são o padrão da conta, que o painel altera.

MomentoFaturaAssinaturaEventos
5 dias antes do ciclopending, com billing.due_at na data do cicloSegue active.invoice.created
Pix pagopaidSegue active.invoice.paid e subscription.renewed
billing.due_at sem pagamentopendingEntra na carência.subscription.grace_started
billing.expires_at sem pagamentoexpiredcanceled, com o motivo renewal_failure.invoice.expired e subscription.canceled
  • Página de pagamento: a fatura traz em url a página em que o cliente paga o ciclo. Mande esse endereço a ele ou gere o QR Code com Pagar uma fatura.
  • Uma fatura por vez: a fatura do ciclo seguinte só sai quando a anterior não está mais em aberto.

Carência

Com a recusa no cartão ou o vencimento sem pagamento no Pix, a assinatura entra na carência e segue active, com grace preenchido. A carência vai até o billing.expires_at da fatura do ciclo, e a assinatura só é cancelada se o ciclo não for pago até lá. As regras estão em Carência, e a troca do prazo, em Alterar a carência.

Cancelamento

A assinatura cancelada traz o bloco cancellation.

CampoDescrição
cancellation.reasonMotivo.
cancellation.noteObservação enviada no cancelamento pela API.
MotivoO que significa
merchant_requestCancelada por você, pela API ou pelo painel.
initial_payment_failureA fatura da adesão venceu sem pagamento.
renewal_failureA carência terminou sem o pagamento do ciclo.
invoice_refundUma fatura da assinatura foi estornada.
invoice_chargebackUma fatura da assinatura foi contestada.
  • Faturas em aberto: as faturas pending da assinatura sem pagamento confirmado passam a canceled, com cancellation.reason igual a subscription_cancellation. A fatura que encerra a assinatura por falta de pagamento passa a expired.
  • Contestação: a contestação de uma fatura sempre cancela a assinatura.
  • Estorno: o estorno de uma fatura cancela a assinatura conforme cancel_subscription no pedido ou, sem o campo, a configuração da conta, que por padrão cancela, como em Estorno.

Volta de um cancelamento

A assinatura cancelada volta a active por dois caminhos.

CaminhoVale para
Pagamento confirmado depois do cancelamentoinitial_payment_failure, ou renewal_failure na assinatura no Pix.
ReativaçãoAssinatura cancelada há até 30 dias, nas condições da reativação.

Nos dois caminhos, sai subscription.reactivated, cancellation volta a null, grace volta a null e billing.renewal_failures, a 0. O cancelamento desfeito vai para previous_cancellations, com a data da volta em reactivated_at. A lista vem do cancelamento mais novo para o mais antigo e fica vazia enquanto a assinatura não voltou de nenhum cancelamento.

Os eventos estão listados em Webhooks.