Consultar Suscripción

Permite consultar la información de una suscripción existente a partir de su identificador visible. La respuesta incluye el estado actual de la suscripción, la información del cliente y el enlace para completar la vinculación del medio de pago cuando corresponda.

Endpoint

GET {{base_url}}/subscription/{subscription_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
subscription_id	String	Sí	Identificador visible de la suscripción que se desea consultar. Ejemplo: B1B2B3B4

---

Response

200

{
  "subscription_id": "B1B2B3B4",
  "plan_id": "A1A2A3A4",
  "status": "active",
  "subscription_url": "https://{host}/s/abc123",
  "customer": {
    "name": "Juan Pérez",
    "email": "[e-mail]",
    "phone": "3001234567",
    "id_type": "CC",
    "id_number": "1020304050"
  },
  "form_values": {
    "field_one": "Juan Pérez",
    "field_two": "[e-mail]",
    "field_three": "3001234567",
    "field_four": "1020304050"
  },
  "created_at": "2026-06-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}}/subscription/B1B2B3B4 \
  -H "x-auth-token: YOUR_SECRET_TOKEN"