Buscar em plano de assinatura - Planos - Mercado Pago Developers
Buscar planos de assinatura

GET

/preapproval_plan/search
Buscar planos de assinatura a partir de diferentes parâmetros.
Parâmetros de requisição
status
string
Localização: pathEspecifica o status do plano que você deseja obter.
q
string
Localização: pathCampo de busca livre.
sort
string
Localização: pathEspecifica o nome do campo pelo qual os resultados devem ser classificados de acordo com um critério.
criteria
string
Localização: pathEspecifica o critério de ordem dos resultados.
Parâmetros de resposta
paging
object
Localização: bodyInformações para paginação dos resultados da pesquisa.
results
array
Localização: bodyPágina de ítens. Caso não retorne resultados, será um array vazio.
Solicitação
curl
curl -X GET \
      'https://api.mercadopago.com/preapproval_plan/search' \
      -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' 
Resposta
json
{
  "paging": {
    "offset": 0,
    "limit": 20,
    "total": 100
  },
  "results": [
    {
      "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": 7,
          "frequency_type": "months",
          "first_invoice_offset": 7
        },
        "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-01T11:12:25.892-04:00",
      "last_modified": "2022-01-01T11:12:25.892-04:00",
      "subscribed": 50,
      "status": "active"
    }
  ]
}
Erros
400bad_request
400Search parameters are required
400Binding exception, parameters passed are invalid
400Invalid status value. Valid status are active, cancelled
401bad_request
401Unauthorized access to resource
500bad_request
500Internal server error