Search in subscription plan - Plans - Mercado Pago Developers

Search subscription plans

GET

/preapproval_plan/search

Search for subscription plans by different parameters.

Localization: pathSpecifies the status of the plan you want to get.

Localization: pathFree search field.

Localization: pathSpecifies the name of the field by which the results are to be sorted according to a criteria.

Localization: pathSpecifies the order criteria of the results.

Localization: bodyInformation for pagination of search results.

Localization: bodyThe page of items. This will be an empty array if there are no results.

curl -X GET \
      'https://api.mercadopago.com/preapproval_plan/search' \
       -H 'Authorization: Bearer YOUR_ACCESS_TOKEN \

{
  "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"
    }
  ]
}

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