Skip to main content
GET
Listar suscripciones

Autorizaciones

x-api-key
string
header
requerido

API key del API Gateway de Tapi. Requerida en todas las operaciones. Distinta por ambiente (desarrollo, homologación, producción).

x-authorization-token
string
header
requerido

Token TAPI JWT. Requerido en todas las operaciones. Se envía sin prefijo "Bearer". Ej: x-authorization-token: eyJhbGci...

Parámetros de consulta

status
enum<string>

Filtrar por estado (case-sensitive). Valor inválido devuelve 400 (Invalid status filter ...); vacío se ignora.

Opciones disponibles:
PROCESSING,
ACTIVE,
PAUSED,
CANCELLED,
ENDED
externalClientId
string

Filtrar por deudor (match exacto), combinable con status (AND). Vacío o en blanco devuelve 400 INVALID_REQUEST. Sin resultados devuelve 200 con data: [].

page
integer
predeterminado:1
Rango requerido: x >= 1
limit
integer
predeterminado:50
Rango requerido: 1 <= x <= 500

Respuesta

Lista de suscripciones

data
object[]
meta
object

Metadatos de paginación. page default 1; limit default 50, máximo 500. Valores inválidos de page o limit toman el default (no dan 400) y un limit mayor a 500 se recorta a 500; meta.limit refleja el valor aplicado.

requestId
string