Search subscriptions with the Mercado Pago API

Searches the subscriptions of the account's buyers. Each one in results has id, status, reason, preapproval_plan_id, payer_id and name, auto_recurring, next_payment_date and summarized, with charged and pending amounts. Page with offset and limit; paging has the total.

Identifier
mercado_pago_search_subscriptions

The request

POST https://connect.reportei.com/api/tools/mercado_pago_search_subscriptions/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "q": "<q>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
qstringNoFree text to search in the subscriptions.
payer_emailstringNoOnly the subscriptions of this subscriber email address.
preapproval_plan_idstringNoOnly the subscriptions of this plan: the id from Search subscription plans.
statusstringNoOnly the subscriptions in this status. authorized is active and charging.Values: pending, authorized, paused, canceled
semaphorestringNoOnly the subscriptions with this collection status summary.Values: green, yellow, red, blank
sortstringNoField and direction, as field_name:asc or field_name:desc, like date_created:desc.
offsetintegerNoSubscriptions to skip, for paging.
limitintegerNoSubscriptions per page.

Supported connections

Your customer connects their Mercado Pago account once, with one of the modes below. The same connection serves every tool of the toolkit.

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/mercado_pago_search_subscriptions. It becomes your agent's tool definition with no conversion.

Other Mercado Pago tools

See all 12 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.