Dom Docs
Dom Pagamentos

Assinaturas

Atualizado em · 1 min de leitura

O objeto subscription é uma recorrência em si, que possibilita a cobrança do clientes com intervalos pré determinados.

O objeto subscription representa uma assinatura ativa que realiza cobranças automáticas em intervalos pré-definidos. Cada assinatura está vinculada a um cliente e a um plano (ou configurada com valores personalizados via auto_recurring).

Ciclo de vida de uma assinatura

  1. Criação — A assinatura é criada e a primeira fatura é gerada
  2. Cobrança automática — Novas faturas são criadas no intervalo do plano
  3. Cancelamento — A assinatura pode ser cancelada a qualquer momento

Formas de criar uma assinatura

Existem duas formas de definir o valor e frequência da cobrança:

  • Com plano (plan_id) — Usa as configurações de um plano existente
  • Com auto_recurring — Define valor, frequência e duração diretamente na assinatura, sem vínculo a um plano

Não é possível usar plan_id e auto_recurring ao mesmo tempo.

Operações disponíveis

  • Criar assinatura — Vincula um cliente a um plano ou configura recorrência personalizada
  • Editar assinatura — Atualiza dados da assinatura
  • Consultar faturas — Lista as faturas geradas pela assinatura
Esta página foi útil?