Assinaturas

O objeto subscription é uma recorrência em si, que possibilita a cobrança do clientes com intervalos pré determinados, sem que seja necessário criar essa regra de negócio do seu lado. O objeto subscription contêm os seguintes atributos:

AtributosTipoDescrição
idstring
  • Código da assinatura_. Formato: sub_XXXXXXXXXXXXXXXX.
payment_methodstring
  • Meio de pagamento_. Valores possíveis: credit_card, boleto, cash ou debit_card.
currencystring
  • Moeda_. Valor possível: BRL.
start_atdatetime
  • Data de início da assinatura_.
    Observação: Por padrão, os ciclos se iniciam as 00:00:00, por isso, apenas a data deve ser levada em consideração na response.
intervalstring
  • Intervalo da recorrência_. Valores possíveis: day, week, month ou year.
interval_countstring
  • Repetições do intervalo da recorrência_. Ex: plano mensal = interval_count (1) e interval (month); plano trimestral = interval_count (3) e interval (month); plano semestral = interval_count (6) einterval (month).
billing_typestring
  • Tipo de cobrança_. Valores possíveis: prepaid, postpaid ou exact_day.
billing_dayintegerDia da cobrança. Obrigatório, caso o billing_type seja exact_day.
current_cycleobject
  • Período atual da assinatura_.
next_billing_atdatetime
  • Data da próxima cobrança_.
installmentsinteger
  • Quantidade de parcelas_. O número de parcelas deverá ser 1 em recorrências.
statement_descriptorinteger
  • Texto exibido na fatura do cartão_.
customerobject
cardobject
planobject
discountsarray of objects
  • Descontos_.
incrementsarray of objects
  • Incrementos_.
minimum_priceinteger
  • Valor mínimo, em centavos, da assinatura_.
itemsarray of objects
statusstring
  • Status da assinatura_. Valores possíveis: active, canceled ou future.
created_atdatetime
  • Data de criação da assinatura (UTC)_.
updated_atdatetime
  • Data de atualização da assinatura (UTC)_.
canceled_atdatetime
  • Data de cancelamento da assinatura (UTC)_.
metadataobject
splitobjectSplit na assinatura.
Saiba mais sobre split na recorrência.
🚧

Formas de Pagamento de Assinaturas

Podemos criar uma assinatura com os dois meios de pagamento distintos: credit_card ou boleto. Caso utilize credit_card será necessário o envio do card dentro da requisição juntamente do payment_method. Já no caso do boleto somente será necessário o payment_method.

🚧

Assinaturas e o Staus Chargeback

A partir do dia 12 de setembro de 2023, o status chargedback será acrescentado à API do Pagar.me como um novo status de cobrança.
Saiba mais sobre o fluxo de Assinaturas com cobranças em status Chargeback.

Quando umacharge de uma assinatura sofre chargeback, essa assinatura será cancelada de forma automática.