Inicio
Documentação
Recursos
Certificações
Comunidade

Comunidade

Fique por dentro das últimas novidades, peça ajuda a outros integradores e compartilhe seu conhecimento.

Criar plano de assinatura - Planos - Mercado Pago Developers

Busca inteligente powered by OpenAI 

Criar um plano de assinatura

POST

https://api.mercadopago.com/preapproval_plan
Um plano é um template para criar assinaturas que informa a frequência e valor que deverão ser cobrados dos seus clientes. Planos podem ser criados com testes grátis, ciclos de cobrança, entre outros. As assinaturas criadas a partir de um plano são relacioadas a ele e permitem sincronizar informações como reason e amount.
Parâmetros de requisição
BODY
reason
string

OBRIGATÓRIO

É uma breve descrição que o assinante verá durante o processo de checkout e nas notificações.
auto_recurring
object
Configuração da data para recorrência.
payment_methods_allowed
object
Meios de pagamento habilitados no checkout.
back_url
string

OBRIGATÓRIO

URL de retorno de sucesso. Use esta configuração para redirecionar seus clientes para o seu site após o checkout.
Parâmetros de resposta
id
string
Identificador único do plano de assinatura.
application_id
number
ID único que identifica sua aplicação/integração. Uma das chaves do par que compõe as credenciais que identifica uma aplicação/integração na sua conta.
collector_id
number
ID único que identifica seu usuário como vendedor. Este ID corresponde ao seu User ID em nosso ecossistema.
reason
string
É uma breve descrição que o assinante verá durante o processo de checkout e nas notificações.
Erros

400Erro

400

Bad-Request

401Erro

401

Unauthorized

404Erro

404

Not-Found

500Erro

500

Error

Requisição
curl -X POST \
    'https://api.mercadopago.com/preapproval_plan'\
    -H 'Content-Type: application/json' \
       -H 'Authorization: Bearer TEST-5599*********291-02171*********139a4791e*********f7f5835-1*********' \
    -d '{
  "reason": "Yoga classes",
  "auto_recurring": {
    "frequency": 1,
    "frequency_type": "months",
    "repetitions": 12,
    "billing_day": 10,
    "billing_day_proportional": false,
    "free_trial": {
      "frequency": 1,
      "frequency_type": "months"
    },
    "transaction_amount": 10,
    "currency_id": "ARS"
  },
  "payment_methods_allowed": {
    "payment_types": [
      {
        "id": "credit_card"
      }
    ],
    "payment_methods": [
      {
        "id": "bolbradesco"
      }
    ]
  },
  "back_url": "https://www.yoursite.com"
}'
Resposta de exemplo
{
  "id": "2c938084726fca480172750000000000",
  "application_id": 1234567812345678,
  "collector_id": 100200300,
  "reason": "Yoga classes",
  "auto_recurring": {
    "frequency": 1,
    "frequency_type": "months",
    "repetitions": 12,
    "billing_day": 10,
    "billing_day_proportional": true,
    "free_trial": {
      "frequency": 1,
      "frequency_type": "months"
    },
    "transaction_amount": 10,
    "currency_id": "ARS"
  },
  "payment_methods_allowed": {
    "payment_types": [
      {}
    ],
    "payment_methods": [
      {}
    ]
  },
  "back_url": "https://www.mercadopago.com.ar",
  "external_reference": 23546246234,
  "init_point": "https://www.mercadopago.com.ar/subscriptions/checkout?preapproval_plan_id=2c938084726fca480172750000000000",
  "date_created": "2022-01-01T15:12:25.892Z",
  "last_modified": "2022-01-01T15:12:25.892Z",
  "status": "active"
}