> ## Documentation Index
> Fetch the complete documentation index at: https://docs.onepay.la/llms.txt
> Use this file to discover all available pages before exploring further.
# Listado de suscripciones
> Obtiene las suscripciones creadas en tu cuenta con filtros y paginación.
### Parámetros de consulta
Página que deseas consultar.
Cantidad de registros por página (máx. 100).
Filtra por estados (`created`, `active`, `unpaid`, `pass_due`, `frozen`, `canceled`, `finished`).
Filtra por el ID de un cliente existente. [Crear cliente](/client/customers/create).
Filtra por el ID de un plan existente. [Crear plan](/client/plans/create).
```bash cURL theme={null}
curl https://api.onepay.la/v1/subscriptions?page=1&per_page=20&status=active \
-H "Authorization: Bearer sk_test_xxx"
```
```javascript JavaScript theme={null}
const response = await fetch('https://api.onepay.la/v1/subscriptions?page=1&per_page=20&status=active', {
method: 'GET',
headers: {
'Authorization': 'Bearer sk_test_xxx'
}
});
const data = await response.json();
console.log(data.data); // Array de suscripciones
console.log(data.current_page); // Página actual
```
```python Python theme={null}
import requests
url = "https://api.onepay.la/v1/subscriptions"
headers = {
"Authorization": "Bearer sk_test_xxx"
}
params = {
"page": 1,
"per_page": 20,
"status": "active"
}
response = requests.get(url, headers=headers, params=params)
data = response.json()
print(data["data"]) # Array de suscripciones
print(data["current_page"]) # Página actual
```
```php PHP theme={null}
1,
"per_page" => 20,
"status" => "active"
]);
curl_setopt_array($ch, [
CURLOPT_URL => $url,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer sk_test_xxx"
]
]);
$response = curl_exec($ch);
$data = json_decode($response, true);
print_r($data["data"]); // Array de suscripciones
echo $data["current_page"]; // Página actual
curl_close($ch);
?>
```
### Response
Colección de suscripciones.
Identificador único de la suscripción (UUID).
Nombre comercial de la suscripción.
Estado actual (`active`, `unpaid`, `pass_due`, `canceled`, `finished`, `frozen`).
Descripción enriquecida (puede contener HTML).
Identificador interno que usas en tu sistema.
ID del plan asociado, si aplica.
ID del cupón aplicado.
Precio de referencia en centavos como string.
Moneda en formato ISO-4217 (ej. `COP`).
Valor base cobrado en cada ciclo.
Frecuencia de cobro: `weekly`, `monthly`, `annual`, etc.
Cantidad máxima de ciclos; `null` para indefinido.
Ciclo actual procesado.
Configuración de métodos de pago permitidos para la suscripción.
Indica si se sugiere activar débito automático durante el onboarding del cliente.
Fecha programada de inicio.
Fecha de finalización si aplica.
Información de periodo de prueba (`has_trial`, `trial_days`, `start_trial_date`).
Modo de cobro (`request`, `auto_debit`, etc.).
Días de anticipación para recordatorios de pago.
Número de ciclos fallidos antes de cancelar automáticamente.
Pagos con valores diferenciados por ciclo.
Atributos personalizados que acompañan la suscripción.
Resumen del cliente asociado.
Información del plan enlazado, cuando existe.
Fecha de creación de la suscripción.
Fecha de última actualización.
Número de la página actual
URL para acceder a la primera página de resultados
Índice inicial del primer elemento en la página actual
URL para acceder a la siguiente página de resultados. Será `null` si es la última página
URL base de la API sin los parámetros de paginación
Cantidad de elementos por página
URL para acceder a la página anterior. Será `null` si es la primera página
Índice final del último elemento en la página actual
```json 200 theme={null}
{
"data": [
{
"id": "9ddfcfc1-7b5e-490c-9731-4aabd986908e",
"name": "SpectreSaaS",
"status": "active",
"description": "1 Free
2 COP 449.000
",
"internal_id": "SaaSSpectre",
"plan_id": null,
"coupon_id": null,
"reference_price_in_cents": "44900000",
"currency": "COP",
"amount_in_cents": 44900000,
"cicle_frequency": "monthly",
"cicles": null,
"current_cicle": 2,
"allows": {
"cards": true,
"accounts": true,
"card_extra": false,
"realtime": false,
"pse": true,
"transfiya": true
},
"start_date": "2025-01-05T00:00:00.000000Z",
"end_date": null,
"trial": {
"has_trial": false,
"start_trial_date": null,
"trial_days": 0
},
"complex_payments": [
{
"amount_in_cents": 134700000,
"apply_on_cicle": 1,
"for_cicles": 1,
"label": "Noviembre - Diciembre - Enero",
"target_price": "44900000"
}
],
"features": [],
"metadata": null,
"created_at": "2025-01-02T19:24:48.000000Z",
"updated_at": "2025-02-05T16:01:24.000000Z",
"customer": {
"id": "9dd4158b-0e45-42bc-b56f-a4c1f856814d",
"first_name": "Empresa",
"last_name": "SAS",
"email": "empresa@empresa.com",
"phone": "+573221234567",
"document": "1234567890",
"document_type": "RUT"
}
}
],
"current_page": 1,
"first_page_url": "https://api.onepay.la/v1/subscriptions?page=1",
"from": 1,
"next_page_url": null,
"path": "https://api.onepay.la/v1/subscriptions",
"per_page": 20,
"prev_page_url": null,
"to": 1
}
```