Recorrência
O plano é o catálogo do que você vende, e a assinatura guarda o nome, o valor e a periodicidade combinados com o cliente na adesão, por isso alterar o plano depois não muda quem já assinou.
O que os clientes assinam, com valor, periodicidade, meios de pagamento e desconto.
Ciclo da assinaturaA fatura de cada ciclo, a renovação no cartão e no Pix e o que acontece quando ela não é paga.
CarênciaAté quando a fatura do ciclo segue pagável depois do vencimento, com a assinatura ainda ativa.
Adesão
Toda cobrança da assinatura é uma fatura, e a fatura da adesão nasce na mesma chamada que cria a assinatura. Ela aceita só o meio escolhido em payment_method.
| Meio | Assinatura na resposta da criação | Passa a active |
|---|---|---|
credit_card | active, com o cartão aprovado, ou incomplete, com o cartão recusado. | Na própria resposta, ou quando uma nova tentativa na fatura da adesão é aprovada. |
pix | incomplete. | Quando o Pix da adesão é pago. |
A nova tentativa na fatura da adesão segue Pagar uma fatura e vale até o vencimento dela, 1 hora depois da criação. Sem pagamento, a assinatura é cancelada, como em Ciclo da assinatura. O cliente também pode assinar pela página do plano, como em Assinar um plano pelo checkout.
Operações
| Operação | Quando usar | Rota |
|---|---|---|
| Criar um plano | Você vende o mesmo serviço a vários clientes, com valor e periodicidade fixos. | POST /v1/plans |
| Criar uma assinatura | O cliente assina um plano, ou você combina com ele um valor recorrente sem plano. | POST /v1/subscriptions |
| Consultar assinaturas | Você confere o status e as datas de cobrança de uma assinatura. | GET /v1/subscriptions/:subscription_id |
| Alterar uma assinatura | O valor ou o metadata de quem já assina muda. | PATCH /v1/subscriptions/:subscription_id |
| Cancelar uma assinatura | O cliente desiste. | POST /v1/subscriptions/:subscription_id/cancel |
| Reativar uma assinatura | O cliente volta em até 30 dias depois do cancelamento. | POST /v1/subscriptions/:subscription_id/reactivate |
| Consultar faturas | Você confere o que cada ciclo cobrou e manda ao cliente a página de pagamento da fatura em aberto. | GET /v1/invoices e GET /v1/invoices/:invoice_id |
| Alterar a carência | Você define por quantos dias depois do vencimento a fatura do ciclo segue pagável. | GET /v1/settings e PATCH /v1/settings |
Os valores são em centavos: "amount": 15990 é R$ 159,90.
A Recorrência é ativada no painel do PayZu Gateway.
Sem ela, as rotas de planos, assinaturas e configurações e as de plano e assinatura do checkout respondem 404. As faturas não dependem da Recorrência.