Consultar Plan

Permite consultar la información de un plan existente a partir de su identificador visible. La respuesta incluye la configuración general del plan, sus condiciones de cobro y los campos definidos para la vinculación.

Endpoint

GET {{base_url}}/plan/{plan_id}

Headers

Name	Value
Content-Type*	application/json
x-auth-token*	{token}
child-id	{business_id}

El child-id es opcional y se usa para las cuentas administradas para conocer más puedes ingresa a este enlace.

Parámetros

Campo	Tipo	Obligatorio	Descripción
plan_id	String	Sí	Identificador visible del plan que se desea consultar. Ejemplo: A1A2A3A4

---

Response

200

{
  "plan_id": "A1A2A3A4",
  "name": "Plan Premium",
  "status": "active",
  "plan_url": "https://pay.trazo.co/s/abc123",
  "return_url": "https://comercio.com/pagos/resultado",
  "plan_details": {
    "currency": "COP",
    "amount": 150000,
    "description": "Cobro {{charge_number}} - {{month}}",
    "frequency": "monthly",
    "billing_day": 5,
    "total_charges": 6,
    "initial_charge": true,
    "trial_days": 7,
    "expires_at": "2026-09-12",
    "retry": {
      "max_attempts": 3,
      "interval_days": 2,
      "final_status": "OVERDUE"
    }
  },
  "form_fields": {
    "field_one": {
      "type": "list",
      "label": "Tipo de servicio",
      "is_visible": true,
      "is_required": true,
      "options": ["Básico", "Premium"],
      "default_value": "Premium"
    },
    "field_two": {
      "type": "text",
      "label": "Documento de identidad",
      "is_visible": true,
      "is_required": true,
      "default_value": ""
    }
  },
  "created_at": "2026-07-28T15:30:00Z"
}

400

{
  "error": {
    "type": "bad_request",
    "message": "The request contains invalid or incomplete data.",
    "details": [
      {
        "field": "payment_policy.total_charges",
        "message": "total_charges must be between 1 and 12."
      }
    ]
  }
}

401

{
  "error": {
    "type": "unauthorized",
    "message": "Authentication failed."
  }
}

---

Ejemplo

cURL

curl --request GET \
  --url https://{{base_url}}/plan/A1A2A3A4 \
  -H "x-auth-token: YOUR_SECRET_TOKEN"