Create a subscription plan
POST
Products that use it:
Request's parameters
BODY
reason
It is a short description that the subscriber will see during the checkout process and in the notifications.string
REQUIRED
auto_recurring
Configuration data for recurrence.object
payment_methods_allowed
Payment methods enabled at checkout.object
back_url
Successful return URL. Use this setting to redirect your customers to your site after our checkout.string
REQUIRED
Response parameters
id
Unique subscription plan identifier.string
application_id
Unique ID that identifies your application/integration. One of the keys in the pair that make up the credentials that identify an application/integration in your account.number
collector_id
Unique ID that identifies your user as a seller. This ID matches your User ID in our ecosystem.number
reason
It is a short description that the subscriber will see during the checkout process and in the notifications.string
Errors
400Error
400
Bad-Request
401Error
401
Unauthorized
404Error
404
Not-Found
500Error
500
Error
Request
curl -X POST \
'https://api.mercadopago.com/preapproval_plan'\
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer TEST-7719*********832-03141*********ec9309854*********f1e54b5-1*********' \
-d '{
"reason": "Yoga classes",
"auto_recurring": {
"frequency": 1,
"frequency_type": "months",
"repetitions": 12,
"billing_day": 10,
"billing_day_proportional": false,
"free_trial": {
"frequency": 1,
"frequency_type": "months"
},
"transaction_amount": 10,
"currency_id": "ARS"
},
"payment_methods_allowed": {
"payment_types": [
{
"id": "credit_card"
}
],
"payment_methods": [
{
"id": "bolbradesco"
}
]
},
"back_url": "https://www.yoursite.com"
}'Sample answer
{
"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": 1,
"frequency_type": "months"
},
"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-01T15:12:25.892Z",
"last_modified": "2022-01-01T15:12:25.892Z",
"status": "active"
}