mercadopago.subscriptions.create-subscription

Create a subscription

Overview

Property	Value
Workflow type	Atomic
Library	App-mercadopago
Version	1.0

Input Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Mercadopago API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
preapproval_plan_id	string	No	—	Reference a previously created plan (recommended)
reason	string	Yes	—	Subscription description shown to payer
payer_email	string	Yes	—	Payer's email address
card_token_id	string	No	—	Card token for credit card subscriptions
auto_recurring	json	Yes	—	—
back_url	string	No	—	—
external_reference	string	No	—	—
status	string	No	—	Initial status (default is pending until payer authorizes)

Output Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Mercadopago API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
preapproval_plan_id	string	No	—	Reference a previously created plan (recommended)
reason	string	Yes	—	Subscription description shown to payer
payer_email	string	Yes	—	Payer's email address
card_token_id	string	No	—	Card token for credit card subscriptions
auto_recurring	json	Yes	—	—
back_url	string	No	—	—
external_reference	string	No	—	—
status	string	No	—	Initial status (default is pending until payer authorizes)
status_code	integer	No	—	HTTP status code of the completed call
response	json	No	—	Parsed JSON response body
failure_reason	string	No	—	—
failure_type	string	No	—	—
failed_at	string	No	—	—
failed_step	string	No	—	—
failed_layer	string	No	—	—
failed_at_state	string	No	—	—
error	string	No	—	—
error_type	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	Waiting to call POST /preapproval
completed	No	Yes	Yes	—	HTTP call succeeded
failed	No	Yes	No	—	HTTP call failed

State Diagram

Transitions

From	Action	To	Description
pending	execute	completed	Perform POST /preapproval
* (any state)	fail	failed	Record the failure reason

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "mercadopago.subscriptions.create-subscription",
  "initial_data": {
    "base_url": "value",
    "reason": "value",
    "payer_email": "value",
    "auto_recurring": "value"
  }
}