Como funciona com cartão
- Crie o cliente com
POST /v2/customers. - Colete o cartão com Payment Element em
mode: "subscription". - Envie o token
pgct_de uso único para o seu back-end. - Crie a assinatura com
POST /v2/subscriptions. - Escute webhooks de assinatura para renovações, falhas, atualizações e cancelamento.
Como funciona com Pix Automático
- Crie o cliente com
POST /v2/customers, informando CPF ou CNPJ. - Crie a assinatura com
POST /v2/subscriptionsepayment_method: "pix_automatic". - Mostre o QR code retornado ao pagador, que autoriza o débito recorrente no app do banco.
- Escute webhooks de assinatura para a autorização, cada débito, falhas e cancelamento.
Superfícies principais
Regras operacionais
- Crie assinaturas apenas pelo seu back-end.
- Armazene o
idda assinatura, oiddo cliente e oidda última transação. - Use webhooks como fonte normal de verdade para mudanças de ciclo de vida.
- Reconcilie com
GET /v2/subscriptions/{id}quando uma renovação ou cancelamento ficar incerto. - Troque o plano de uma assinatura com cartão com
PATCH /v2/subscriptions/{id}; crie uma nova assinatura apenas para mudar a moeda ou o cartão. Assinaturas com Pix Automático não trocam de plano.
Leia a seguir
- Criar assinatura
- Assinaturas com Pix Automático
- Ciclo de vida da assinatura
- Webhooks de assinatura
- Referência API de assinaturas

