Docs Pagar.me v5 (legado)

Planos

Modelos predefinidos para assinaturas — simplifica a criação de recorrências.

Documentação legada do Pagar.me v5

Esta página descreve um conceito da Pagar.me v5 (versão clássica). Para projetos novos, explore o API Catalog.

Os planos funcionam como modelos predefinidos para assinaturas, simplificando a criação de novas assinaturas para clientes.

Dados obrigatórios

A criação de um plano requer os seguintes campos:

  • Name — nome do plano
  • Description — descrição do plano
  • Itens — itens do plano
  • Interval — tipo de intervalo (ano, mês ou semana)
  • Interval_Count — espaçamento entre os intervalos
  • Payment_Methods — meios de pagamento aceitos
  • Start_At — data de início
  • Billing_Type — tipo de cobrança (pré-paga, pós-paga ou dia exato)
  • Installments — parcelamento
  • Cycles — número de ciclos (duração do plano)

Identificador do plano

Todo plano possui um identificador como este: plan_l0y1gJpfwSr0K8gL. Ao criar uma assinatura com este ID, ela recebe automaticamente todas as configurações do plano.

Importante

Mudanças não retroativas

Modificar um plano não altera as assinaturas já vinculadas a ele. Para atualizar essas assinaturas, é necessário listar e atualizá-las individualmente.

Jornada: Cobrar de forma recorrente
Etapa 3 de 7

Etapa anteriorAssinaturasPróxima etapaEsquemas de precificação