Search in subscriptions - Subscriptions - Mercado Pago Developers
Search subscriptions

GET

/preapproval/search
Search for subscriptions by using different parameters.
Request's parameters
q
string
Localization: pathFree search field.
payer_id
number
Localization: pathUnique customer ID to find related subscriptions.
payer_email
string
Localization: pathAllows you to search for subscriptions registered with this email.
preapproval_plan_id
string
Localization: pathSpecifies a plan ID for filtering results from the search.
Response parameters
paging
object
Localization: bodyInformation for pagination of search results.
results
array
Localization: bodyThe page of items. This will be an empty array if there are no results.
Request
curl
curl -X GET \
    'https://api.mercadopago.com/preapproval/search' \
    -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' 
Answer
json
{
  "paging": {
    "offset": 0,
    "limit": 20,
    "total": 100
  },
  "results": [
    {
      "id": "2c938084726fca480172750000000000",
      "version": 0,
      "application_id": 1234567812345678,
      "collector_id": 100200300,
      "preapproval_plan_id": "2c938084726fca480172750000000000",
      "reason": "Yoga classes.",
      "external_reference": 23546246234,
      "back_url": "https://www.mercadopago.com.ar",
      "init_point": "https://www.mercadopago.com.ar/subscriptions/checkout?preapproval_id=2c938084726fca480172750000000000",
      "auto_recurring": {
        "frequency": 1,
        "frequency_type": "months",
        "start_date": "2020-06-02T13:07:14.260Z",
        "end_date": "2022-07-20T15:59:52.581Z",
        "currency_id": "ARS",
        "transaction_amount": 10,
        "free_trial": {
          "frequency": 1,
          "frequency_type": "months"
        }
      },
      "first_invoice_offset": 7,
      "payer_id": 123123123,
      "payer_first_name": "Jorge",
      "payer_last_name": "Smith",
      "card_id": 123123123,
      "payment_method_id": "account_money",
      "next_payment_date": "2022-01-01T11:12:25.892-04:00",
      "date_created": "2022-01-01T11:12:25.892-04:00",
      "last_modified": "2022-01-01T11:12:25.892-04:00",
      "summarized": {
        "quotas": 6,
        "charged_quantity": 3,
        "charged_amount": 1000,
        "pending_charge_quantity": 1,
        "pending_charge_amount": 200,
        "last_charged_date": "2022-01-01T11:12:25.892-04:00",
        "last_charged_amount": 100,
        "semaphore": "green"
      },
      "status": "pending"
    }
  ]
}
Errors
400bad_request
400400--Bad-request--Search parameters are required
400400--Bad-request--Binding exception, parameters passed are invalid
401bad_request
401401--Unauthorized--Unauthorized access to resource
500bad_request
500500--Error--Internal server error