Listado de suscripciones
Obtiene las suscripciones creadas en tu cuenta con filtros y paginación.
GET
Parámetros de consulta
number
default:1
Página que deseas consultar.
number
default:20
Cantidad de registros por página (máx. 100).
string
Filtra por estados (
created, active, unpaid, pass_due, frozen, canceled, finished).string
Filtra por el ID de un cliente existente. Crear cliente.
string
Filtra por el ID de un plan existente. Crear plan.
Response
array
Colección de suscripciones.
string
Identificador único de la suscripción (UUID).
string
Nombre comercial de la suscripción.
string
Estado actual (
active, unpaid, pass_due, canceled, finished, frozen).string
Descripción enriquecida (puede contener HTML).
string
Identificador interno que usas en tu sistema.
string
ID del plan asociado, si aplica.
string
ID del cupón aplicado.
string
Precio de referencia en centavos como string.
string
Moneda en formato ISO-4217 (ej.
COP).number
Valor base cobrado en cada ciclo.
string
Frecuencia de cobro:
weekly, monthly, annual, etc.number
Cantidad máxima de ciclos;
null para indefinido.number
Ciclo actual procesado.
object
Configuración de métodos de pago permitidos para la suscripción.
boolean
Indica si se sugiere activar débito automático durante el onboarding del cliente.
date
Fecha programada de inicio.
date
Fecha de finalización si aplica.
object
Información de periodo de prueba (
has_trial, trial_days, start_trial_date).string
Modo de cobro (
request, auto_debit, etc.).number
Días de anticipación para recordatorios de pago.
number
Número de ciclos fallidos antes de cancelar automáticamente.
array
Pagos con valores diferenciados por ciclo.
object
Atributos personalizados que acompañan la suscripción.
object
Resumen del cliente asociado.
object
Información del plan enlazado, cuando existe.
date
Fecha de creación de la suscripción.
date
Fecha de última actualización.
number
Número de la página actual
string
URL para acceder a la primera página de resultados
number
Índice inicial del primer elemento en la página actual
string
URL para acceder a la siguiente página de resultados. Será
null si es la última páginastring
URL base de la API sin los parámetros de paginación
number
Cantidad de elementos por página
string
URL para acceder a la página anterior. Será
null si es la primera páginanumber
Índice final del último elemento en la página actual