OpenAPI Specification
openapi: 3.1.0
info:
title: Mercado Pago REST Authentication Plans API
description: 'Mercado Pago REST API covering payments, Checkout Pro preferences,
subscriptions (preapprovals), customers, cards, merchant orders, Orders
API, refunds, chargebacks, claims, reports, Point (POS), QR, and OAuth.
All requests authenticate with a Bearer access token in the
`Authorization` header. Webhook deliveries are signed via the
`x-signature` and `x-request-id` headers.
'
version: v1
contact:
name: Mercado Pago Developers
url: https://www.mercadopago.com.br/developers/en/reference
license:
name: Mercado Pago Terms of Service
url: https://www.mercadopago.com.br/ayuda/terminos-y-politicas_299
servers:
- url: https://api.mercadopago.com
description: Mercado Pago Production API
security:
- bearerAuth: []
tags:
- name: Plans
description: Subscription plans
paths:
/preapproval_plan:
post:
tags:
- Plans
summary: Create A Subscription Plan
operationId: createPlan
requestBody:
required: true
content:
application/json:
schema:
type: object
responses:
'201':
description: Plan created
/preapproval_plan/search:
get:
tags:
- Plans
summary: Search Subscription Plans
operationId: searchPlans
responses:
'200':
description: Search results
/preapproval_plan/{id}:
parameters:
- name: id
in: path
required: true
schema:
type: string
get:
tags:
- Plans
summary: Get A Subscription Plan
operationId: getPlan
responses:
'200':
description: Plan
put:
tags:
- Plans
summary: Update A Subscription Plan
operationId: updatePlan
responses:
'200':
description: Updated plan
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: access_token
description: 'Mercado Pago access token. Send as `Authorization: Bearer {ACCESS_TOKEN}`.
HTTPS is required. Idempotency is supported via the `X-Idempotency-Key`
header on POST/PUT operations.
'
oauth2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://auth.mercadopago.com/authorization
tokenUrl: https://api.mercadopago.com/oauth/token
scopes:
offline_access: Persistent refresh token
read: Read merchant data
write: Write merchant data