These docs are for v4. Click to read the latest docs for v5.

Criando assinaturas

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

A criação de uma subscription (assinatura) é parecida com a criação de uma transação. Se for uma assinatura paga com Cartão de crédito, é possível usar um card_id, card_hash ou todos os dados do cartão. Para pagamento por Boleto bancário, você precisa especificar apenas o payment_method.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
❗️

Atenção: Essa versão de API será descontinuada

Essa versão da API Pagar.me já não é mais atualizada e, em breve, deixará de funcionar. Para que sua loja possa vender sem problemas, você precisa realizar sua integração usando a versão mais recente da nossa API, a V5.

No canto superior esquerdo da tela é indicado qual versão da documentação você está vendo. Clique na seta onde indica a versão e altere para a V5 para acessar a documentação.

Se você já é cliente, precisa realizar obrigatoriamente a migração para a versão V5.

Em caso de dúvidas, basta entrar em contato com o nosso time de atendimento através do e-mail, enviando a sua dúvida para [email protected] e por telefone, ligando para 4004-1330. Se você já é cliente pode também entrar em contato através do chat dentro da sua Dashboard.

Dados necessários para uma assinatura

❗️

Produto descontinuado

A Pagar.me não permite nova integrações na API de recorrência v4 (esta página). Para nova integrações do produto de recorrência, utilizar a API v5.

📘

Dados obrigatórios

O e-mail do cliente é uma informação obrigatória, uma vez que utilizamos ele para enviar e-mails de assinatura.

🚧

Antifraude

A primeira transação criada em uma assinatura passa por antifraude, logo, é obrigatório enviar todos os dados de customer.

Valores de uma assinatura

🚧

Dando descontos na assinatura

Só é possível dar descontos na assinatura através de troca para um plano mais barato, mas vale ressaltar que isso gera uma nova periodicidade. Mais em: Fluxo de cobrança.

Observações

📘

ID do plano

Lembre-se de passar o ID de seu plano em todas as requests, para que não seja necessário recriar todas assinaturas que ficaram com plan_id = null.

Body Params
string
required

ID do plano a ser associado a uma assinatura

string

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

string
required

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

string
required
Defaults to !CARD_NUMBER!

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

string
required
Defaults to !CARD_CVV!

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

string
required
Defaults to !NAME!

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

string
required
Defaults to !CARD_EXPIRATION_DATE!

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

string
required

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

string

Descrição que aparecerá na fatura depois do nome de sua empresa. Máximo de 13 caracteres, sendo alfanuméricos e espaços

string

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

customer
object
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

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

Language
Credentials
Query
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json