Listar Suscriptions

GET /v3/suscriptions

Ambiente	URL base API	Portal de comercio
Sandbox	https://api.virtualpos-sandbox.com	comercios.virtualpos-sandbox.com
Producción	https://api.virtualpos.cl	comercios.virtualpos.cl

Headers

Nombre	Tipo	Requerido	Descripción
Authorization	string	Sí	API KEY del comercio
Signature	string	Sí	Firma del mensaje

Parámetros de consulta

Nombre	Tipo	Requerido	Descripción
status	string	No	Estado del objeto suscription Valores: SUSCRIBIENDO, SUSCRIPCION_FALLIDA, ACTIVA, CANCELADA, FINALIZADA.
created_from	string	No	Fecha de creacion, desde Por defecto: 2026-01-01.
created_to	string	No	Fecha de creacion, hasta Por defecto: 2026-01-01.
social_id	string	No	Rut del suscriptor Por defecto: 123123321-3.
email	string	No	Correo del suscriptor Por defecto: ejemplo@gmail.com.

Ejemplo de request

curl -X GET 'https://api.virtualpos-sandbox.com/v3/suscriptions' \
  -H 'Content-Type: application/json' \
  -H "Authorization: $API_KEY" \
  -H "Signature: $SIGNATURE"

Respuestas

200 OK

{
  "status": "OK",
  "code": 200,
  "pagination": {
    "limit": 1,
    "page": 1,
    "pages": 2,
    "total": 6
  },
  "suscriptions": [
    {
      "status": "ACTIVA",
      "id": "3a4d77f2e4",
      "plan_id": "fd53ead26f78b56113312609b668411b",
      "plan_name": "Plan mensual",
      "suscription_date": "2021-09-08 11:20:31",
      "payment_method": {
        "bin": "405188",
        "issuer": "Banco de Chile",
        "last4CardDigit": "6623",
        "brand": "VISA",
        "expiration_date": "12/27",
        "card_on_file": "F"
      },
      "currency": "CLP",
      "amount": 9990,
      "renewal": "F",
      "channel": "WEB",
      "service_id": "12312312-3",
      "charge_program": [
        {
          "id": "cid_2566645567e51ef2b7.76832273",
          "charge_date": "2023-05-01",
          "amount": "6990",
          "status": "pagado",
          "description": "Cargo 1 de 3"
        },
        {
          "id": "cid_2566645567e51ef2b7.76832274",
          "charge_date": "2023-06-01",
          "amount": "6990",
          "status": "pendiente",
          "description": "Cargo 2 de 3"
        },
        {
          "id": "cid_2566645567e51ef2b7.76832275",
          "charge_date": "2023-07-01",
          "amount": "6990",
          "status": "pendiente",
          "description": "Cargo 3 de 3"
        }
      ],
      "client": {
        "email": "user@example.com",
        "first_name": "John",
        "last_name": "Doe",
        "social_id": "12345678-9",
        "phone": "56961934502"
      }
    },
    {
      "status": "ACTIVA",
      "id": "3a4d77f3ws",
      "plan_id": "fd53ead26f78b56113312609b668411b",
      "plan_name": "Plan mensual",
      "suscription_date": "2021-10-09 11:20:31",
      "payment_method": {
        "bin": "405188",
        "issuer": "Banco de Chile",
        "last4CardDigit": "6623",
        "brand": "VISA",
        "expiration_date": "12/27",
        "card_on_file": "F"
      },
      "currency": "CLP",
      "amount": 9990,
      "renewal": "F",
      "channel": "WEB",
      "service_id": "12312312-3",
      "charge_program": [
        {
          "id": "cid_2566645567e51ef2b7.76832273",
          "charge_date": "2023-05-01",
          "amount": "6990",
          "status": "pagado",
          "description": "Cargo 1 de 3"
        },
        {
          "id": "cid_2566645567e51ef2b7.76832274",
          "charge_date": "2023-06-01",
          "amount": "6990",
          "status": "pendiente",
          "description": "Cargo 2 de 3"
        },
        {
          "id": "cid_2566645567e51ef2b7.76832275",
          "charge_date": "2023-07-01",
          "amount": "6990",
          "status": "pendiente",
          "description": "Cargo 3 de 3"
        }
      ],
      "client": {
        "email": "user@example.com",
        "first_name": "John",
        "last_name": "Doe",
        "social_id": "12345678-9",
        "phone": "56961934502",
        "gender": {
          "id": 1,
          "name": "Masculino"
        },
        "birth_date": "1992-10-20"
      }
    }
  ]
}

400 Bad Request

{}