Criando assinaturas

post

https://api.pagar.me/1/subscriptions

Para efetivamente cobrar seu cliente de forma recorrente, você deve criar uma assinatura atrelada a um plano que conterá os dados de cobrança.

Sendo que a criação de uma subscription (assinatura), é parecida com a criação de uma transação. Se for uma assinatura paga com cartão, é possível usar um card_id, card_hash ou todos os dados do cartão. Enquanto para boleto, você precisa especificar apenas o payment_method.

Body Params

plan_id

string

required

id do plano a ser associado a uma assinatura

payment_method

string

Método de pagamento da assinatura. Aceita dois tipos: credit_card e boleto

card_hash

string

required

Dados encriptados do cartão do cliente. Você também pode usar o card_id ao invés do card_hash

card_number

string

required

Defaults to !CARD_NUMBER!

Número do cartão, se for uma assinatura de cartão

card_cvv

string

required

Defaults to !CARD_CVV!

Cvv do cartão, se for uma assinatura paga com cartão

card_holder_name

string

required

Defaults to !NAME!

Nome do detentor do cartão se for uma assinatura paga com cartão

card_expiration_date

string

required

Defaults to !CARD_EXPIRATION_DATE!

Data de expiração do cartão, se for uma assinatura paga com cartão

card_id

string

required

Id do cartão a ser cobrado, se for uma assinatura paga com cartão

postback_url

string

URL onde nossa API irá enviar requisições informando alterações de status da assinatura em questão

customer

object

metadata

json

Você pode passar dados adicionais na criação da transação para facilitar uma futura análise de dados tanto em nossa dashboard, quanto por seus sistemas. Ex: metadata[ idProduto ]=13933139

reference_key

string

Valor único que identifica a transação para permitir uma nova tentativa de requisição com a segurança de que a mesma operação não será executada duas vezes acidentalmente. OBS: Não pode ser igual a um valor já usado em uma criação de transação

boleto_fine

object

boleto_interest

object

Responses

200200

400400