Listado de suscripciones

Obtiene las suscripciones creadas en tu cuenta con filtros y paginación.

Parámetros de consulta

page · number · default: 1

Página que deseas consultar.

per_page · number · default: 20

Cantidad de registros por página (máx. 100).

status · string

Filtra por estados (created, active, unpaid, pass_due, frozen, canceled, finished).

customer_id · string

Filtra por el ID de un cliente existente. Crear cliente.

plan_id · string

Filtra por el ID de un plan existente. Crear plan.

Response

data · array

Colección de suscripciones.

id · string

Identificador único de la suscripción (UUID).

name · string

Nombre comercial de la suscripción.

status · string

Estado actual (active, unpaid, pass_due, canceled, finished, frozen).

description · string

Descripción enriquecida (puede contener HTML).

internal_id · string

Identificador interno que usas en tu sistema.

plan_id · string

ID del plan asociado, si aplica.

coupon_id · string

ID del cupón aplicado.

reference_price_in_cents · string

Precio de referencia en centavos como string.

currency · string

Moneda en formato ISO-4217 (ej. COP).

amount_in_cents · number

Valor base cobrado en cada ciclo.

cicle_frequency · string

Frecuencia de cobro: weekly, monthly, annual, etc.

cicles · number

Cantidad máxima de ciclos; null para indefinido.

current_cicle · number

Ciclo actual procesado.

allows · object

Configuración de métodos de pago permitidos para la suscripción.

suggest_auto_debit · boolean

Indica si se sugiere activar débito automático durante el onboarding del cliente.

start_date · date

Fecha programada de inicio.

end_date · date

Fecha de finalización si aplica.

trial · object

Información de periodo de prueba (has_trial, trial_days, start_trial_date).

payment_mode · string

Modo de cobro (request, auto_debit, etc.).

remember_to_pay_before · number

Días de anticipación para recordatorios de pago.

cancel_after_no_payment_before · number

Número de ciclos fallidos antes de cancelar automáticamente.

complex_payments · array

Pagos con valores diferenciados por ciclo.

metadata · object

Atributos personalizados que acompañan la suscripción.

customer · object

Resumen del cliente asociado.

plan · object

Información del plan enlazado, cuando existe.

created_at · date

Fecha de creación de la suscripción.

updated_at · date

Fecha de última actualización.

current_page · number

Número de la página actual

first_page_url · string

URL para acceder a la primera página de resultados

from · number

Índice inicial del primer elemento en la página actual

next_page_url · string

URL para acceder a la siguiente página de resultados. Será null si es la última página

path · string

URL base de la API sin los parámetros de paginación

per_page · number

Cantidad de elementos por página

prev_page_url · string

URL para acceder a la página anterior. Será null si es la primera página

to · number

Índice final del último elemento en la página actual

200

{
  "data": [
    {
      "id": "9ddfcfc1-7b5e-490c-9731-4aabd986908e",
      "name": "SpectreSaaS",
      "status": "active",
      "description": "<p>1 Free</p><p>2 COP 449.000</p>",
      "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": "[e-mail]",
        "phone": "[phone]",
        "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
}