Assinaturas

Recorrência configurável por intervalo, meio de pagamento e modelo de cobrança.

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.

A Assinatura é a recorrência em si. Ela possibilita que você cobre os seus clientes com intervalos pré-determinados, sem que seja necessário criar essa regra de negócio do seu lado.

Desenvolvemos essa funcionalidade pensando nos mais diversos estilos de recorrência do mercado, desde academias até clubes de assinatura.

É possível criar assinaturas com os seguintes meios de pagamento:

  • Cartão de crédito
  • Cartão de débito (Pinless)
  • Boleto

Para realizar a criação de uma assinatura (subscription) são obrigatórios os dados abaixo:

  • Itens — itens da assinatura
  • Customer — dados do comprador
  • Interval — tipo de intervalo (ano, mês ou semana)
  • Interval_Count — espaçamento entre os intervalos
  • Payment_Method — meio de pagamento
  • Card ou Boleto — dados do pagamento
  • Start_At — data de início
  • Billing_Type — tipo de cobrança (pré-paga, pós-paga ou dia exato)
  • Installments — parcelamento
Duração do ciclo

A duração de um ciclo compreende o tipo da cobrança e o intervalo que será cobrada.

Ex.: Interval: semana, mês, ano. Interval_Count: 1, 2, 3… Se for selecionado mês e 3, a cobrança será feita a cada 3 meses (trimestral).

Atenção

Se não for selecionado o número de ciclos, automaticamente será entendido como uma assinatura com duração infinita.

Funcionalidades relacionadas a assinatura

  • Assinaturas pré-pagas — valor da assinatura não varia com o consumo (academias, planos de saúde).
  • Assinaturas pós-pagas — valor varia com o consumo (telefonia pós-paga).
  • Cobrança em dia específico do mês — assinatura cobrada em dias pré-definidos (ex.: todo dia 10).
  • Descontos por período — descontos em determinados períodos (ex.: desconto nos três primeiros meses).
  • Setup que gera pedido na criação — pedido avulso no momento em que a assinatura é gerada (ex.: taxa de matrícula).
  • Itens temporários — itens incluídos na assinatura que durarão apenas um período específico (ex.: programa pay-per-view).

Jornada: Cobrar de forma recorrente
Etapa 2 de 7