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
idstringCódigo da assinatura. Formato: sub_XXXXXXXXXXXXXXXX.
payment_methodstringMeio de pagamento. Valores possíveis: credit_card, boleto, cash ou debit_card.
currencystringMoeda. Valor possível: BRL.
start_atdatetimeData de início da assinatura.
intervalstringIntervalo da recorrência. Valores possíveis: day, week, month ou year.
interval_countstringRepetiçõ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) e interval (month).
billing_typestringTipo 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_periodobjectPeríodo atual da assinatura.
next_billing_atdatetimeData da próxima cobrança.
installmentsintegerQuantidade de parcelas. Será aplicada caso o método de pagamento da assinatura seja cartão de crédito .
statement_descriptorintegerTexto exibido na fatura do cartão.
customerobjectDados do cliente. Saiba mais sobre clientes.
cardobjectDados do cartão de crédito. Saiba mais sobre cartões.
planobjectDados do plano. Saiba mais sobre planos.
discountsarray of objectsDescontos.
incrementsarray of objectsIncrementos.
minimum_priceintegerValor mínimo, em centavos, da assinatura.
itemsarray of objectsItens da assinatura. Saiba mais sobre itens da assinatura.
statusstringStatus da assinatura. Valores possíveis: active, canceled ou future.
created_atdatetimeData de criação da assinatura.
updated_atdatetimeData de atualização da assinatura.
canceled_atdatetimeData de cancelamento da assinatura.
metadataobjectObjeto chave/valor utilizado para armazenar informações adicionais sobre o assinatura. Saiba mais sobre metadata.
gateway_affiliation_idstringCódigo da afiliação no gateway.
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, 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 uma charge de uma assinatura sofre chargeback, essa assinatura será cancelada de forma automática.