Assinaturas

Os endpoints de Assinaturas permitem criar e gerenciar cobranças recorrentes para um mesmo cliente. As novas cobranças são geradas ao longo da recorrência conforme a periodicidade configurada, e cada cobrança possui seu próprio ID, status e ciclo financeiro.

Operações disponíveis

  • Criação: crie assinaturas recorrentes com boleto, Pix ou cartão de crédito.
  • Consulta e gerenciamento: liste ou recupere assinaturas, altere suas configurações ou encerre a recorrência.
  • Cartão e cobranças geradas: atualize o cartão utilizado nas próximas cobranças, consulte as cobranças já geradas e obtenha o carnê da assinatura.
  • Notas fiscais: configure e gerencie a emissão automática de NFS-e para as cobranças da assinatura e consulte as notas fiscais geradas.
📘

Acompanhamento de mudanças

Utilize Webhooks para acompanhar o ciclo de vida da assinatura e das cobranças geradas, em vez de consultar os endpoints de recuperação e listagem repetidamente.

Consulte os eventos de Webhook para assinaturas.

Para entender a recorrência e escolher o fluxo de implementação, consulte Introdução - assinaturas.