Planos
Monte o catálogo que os clientes assinam pela API ou pela página de adesão de cada plano.
Defina o valor de cada ciclo, a periodicidade, os meios aceitos e o desconto.
Consultar planosLeia um plano pelo id ou liste os planos da conta.
Alterar um planoMude o valor, os meios, o desconto ou tire o plano de venda.
Excluir um planoTire o plano de venda de vez, sem mexer nas assinaturas dele.
O que o plano define
| Campo | O que define |
|---|---|
amount | O valor de cada ciclo, em centavos. |
recurrence | A periodicidade, monthly ou annual. Não muda depois da criação. |
payment_settings | Os meios aceitos na adesão, em accepted_methods, entre credit_card e pix. |
checkout | O slug da página de adesão, com logo_url e redirect_url. |
discount | O desconto dos primeiros ciclos, contando a adesão. |
Alterar o plano não muda quem já assinou.
A alteração vale para as assinaturas criadas depois dela: quem já assinou continua com o nome, o valor e a periodicidade da adesão. Para mudar o valor de quem já assina, veja Alterar uma assinatura.
A página de adesão
Cada plano tem uma página de adesão, onde o cliente assina o plano. O endereço dela vem em url, no formato https://invoice.payzu.com.br/checkout/<chave de checkout>/<slug>. Sem checkout.slug, o id do plano entra no lugar do slug. A url muda quando a chave de checkout é trocada.
Status do plano
| Status | O que significa |
|---|---|
active | Plano à venda, que aceita novas assinaturas. |
inactive | Plano fora de venda. As novas assinaturas dele são recusadas, e as que já existem continuam. |