Skip to content
Proud to collaborate with Microsoft for Startups

mercadopago.plans.update-subscription-plan ​

Update a subscription plan

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-mercadopago
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
base_urlstringYes—Mercadopago API root, e.g. https://<host>/api
api_tokenstringNo—Bearer token; omit to use the workflow's token env var
idstringYes——
reasonstringYes—Plan description shown to the payer
auto_recurringjsonYes——
payment_methods_allowedjsonNo——
back_urlstringNo—Redirect URL after subscription setup

Output Schema ​

FieldTypeRequiredDefaultDescription
base_urlstringYes—Mercadopago API root, e.g. https://<host>/api
api_tokenstringNo—Bearer token; omit to use the workflow's token env var
idstringYes——
reasonstringYes—Plan description shown to the payer
auto_recurringjsonYes——
payment_methods_allowedjsonNo——
back_urlstringNo—Redirect URL after subscription setup
status_codeintegerNo—HTTP status code of the completed call
responsejsonNo—Parsed JSON response body
failure_reasonstringNo——
failure_typestringNo——
failed_atstringNo——
failed_stepstringNo——
failed_layerstringNo——
failed_at_statestringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—executeWaiting to call PUT /preapproval_plan/
completedNoYesYes—HTTP call succeeded
failedNoYesNo—HTTP call failed

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompletedPerform PUT /preapproval_plan/
* (any state)failfailedRecord the failure reason

API Usage ​

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

{
  "workflow_type": "mercadopago.plans.update-subscription-plan",
  "initial_data": {
    "base_url": "value",
    "id": "value",
    "reason": "value",
    "auto_recurring": "value"
  }
}