Recursos para IA
Assinaturas
A API de Assinaturas permite criar e gerenciar cobranças recorrentes automáticas. Defina a frequência e o valor e o Mercado Pago cuidará das cobranças e das novas tentativas em caso de pagamento recusado. Esta referência descreve os endpoints disponíveis e como interagir com eles.
Está buscando o passo a passo desta integração? Ir à documentação de Assinaturas
Endpoints disponíveis
Todos os endpoints que compõem a integração com a API de Assinaturas.
Uma assinatura é o objeto central da integração. Pode ser criada diretamente com o meio de pagamento do assinante ou vinculada a um plano existente.
| Operação | Path | Descrição |
| Criar assinaturaPOST | /preapproval | Cria uma assinatura com valor, frequência e meio de pagamento do assinante, podendo ser vinculada a um plano ou configurada de forma independente. |
| Buscar em assinaturasGET | /preapproval/search | Pesquisa assinaturas por filtros como status, preapproval_plan_id ou pagador, retornando resultados paginados. |
| Obter assinaturaGET | /preapproval/{id} | Retorna o status e os detalhes de uma assinatura a partir do seu ID. |
| Atualizar assinaturaPUT | /preapproval/{id} | Atualiza os dados de uma assinatura, como o status, o valor ou o meio de pagamento. |
| Exportar assinaturasGET | /preapproval/export | Exporta um arquivo CSV com as assinaturas que correspondem aos parâmetros de pesquisa. |
Um plano define os parâmetros de cobrança compartilhados por um grupo de assinantes: valor, frequência e configuração do método de pagamento.
| Operação | Path | Descrição |
| Criar plano de assinaturaPOST | /preapproval_plan | Cria um modelo de assinatura com frequência e valor fixos para vincular múltiplos assinantes. |
| Pesquisar planosGET | /preapproval_plan/search | Pesquisa planos de assinatura por filtros como status ou nome, retornando resultados paginados. |
| Obter plano de assinaturaGET | /preapproval_plan/{id} | Retorna os detalhes de um plano de assinatura a partir do seu ID. |
| Atualizar plano de assinaturaPUT | /preapproval_plan/{id} | Atualiza os dados de um plano de assinatura existente. |
Uma fatura representa cada cobrança recorrente gerada pela assinatura, com o status e o resultado da tentativa de cobrança correspondente.
| Operação | Path | Descrição |
| Obter dados de faturaGET | /authorized_payments/{id} | Retorna os detalhes de uma fatura (cobrança autorizada) de uma assinatura a partir do seu ID. |
| Buscar em faturasGET | /authorized_payments/search | Pesquisa faturas por filtros como preapproval_id ou status, retornando resultados paginados. |
Os pagamentos são as transações vinculadas às faturas da assinatura. Use-os para verificar o status e os detalhes finais de cada cobrança processada.
| Operação | Path | Descrição |
| Buscar em pagamentosGET | /v1/payments/search | Pesquisa os pagamentos associados a uma assinatura por filtros como data ou status; cobre os últimos 12 meses. |
| Obter pagamentoGET | /v1/payments/{id} | Retorna o status e os detalhes de um pagamento a partir do seu ID. |
Tudo pronto para começar?
Acesse o primeiro endpoint e comece a criar suas primeiras assinaturas.