v1

latestOpenAPI 3.1.02026-07-245178279.0 KB

Suscripciones

Obtener una lista de suscripciones

Este endpoint permite consultar una lista de suscripciones existentes, aplicando filtros opcionales como estado, plan asociado, correo del usuario, entre otros. Es útil para administrar y supervisar suscripciones de forma eficiente.

get/api/v1/merchants/subscriptions

Query parameters

plan_codestring

Example:plan_basico

Código del plan asociado a las suscripciones.

status'pending' | 'active' | 'canceled' | 'expired'

Example:active

Estado de las suscripciones.

user_emailstring

Example:juan.perez@deuna.com

Correo electrónico del usuario asociado a las suscripciones.

pageinteger

Example:1

Número de página para la paginación.

sizeinteger

Example:10

Cantidad de elementos por página.

Headers

X-API-keystring required

Clave de autenticación para acceder a la API.

Response

Lista de suscripciones obtenida exitosamente.

pageinteger

Número de la página actual.

sizeinteger

Tamaño de la página.

Example response

{
  "data": [
    [
      {
        "activated_at": "2024-12-01T13:00:00Z",
        "auto_renew": true,
        "canceled_at": "2024-12-01T13:00:00Z",
        "created_at": "2024-12-01T13:00:00Z",
        "currency": "USD",
        "current_period_ends_at": "2024-12-01T13:00:00Z",
        "current_period_started_at": "2024-12-01T13:00:00Z",
        "expires_at": "2024-12-01T13:00:00Z",
        "payer_info": {
          "email": "juan.perez@deuna.com",
          "user_id": "isoososos"
        },
        "plan_code": "plan_basico",
        "remaining_billing_cycles": 1,
        "status": "active",
        "subscription_id": "97dd4a78-8fa2-4002-9ab0-b329dbf16acd",
        "total_billing_cycles": 12,
        "updated_at": "2024-12-01T13:00:00Z"
      }
    ]
  ],
  "page": 1,
  "size": 10
}