# Introducción
#### **Descripción general del Módulo de Suscripciones de Plexo**
El **Módulo de Suscripciones de Plexo** está diseñado para que puedas **delegar la gestión de pagos recurrentes de tus suscriptores** de manera simple y segura. Forma parte de la **pasarela de pagos de Plexo**, lo que garantiza que los cobros se realicen de forma confiable y cumpliendo con las normativas vigentes.
**¿Qué incluye el módulo?**
* **Backoffice Web**: una herramienta intuitiva para administrar suscripciones, configurar tipos de suscripción y consultar información detallada de tus clientes y sus pagos.
* **Dashboard de Plexo**: una vista centralizada para monitorear la actividad de pagos y métricas clave.
**¿Cómo empezar a usarlo?**
Existen dos modalidades principales para comenzar:
1. **Autogestión desde el Backoffice**
* Crea y administra links de suscripciones.
* Configura tipos de suscripción y gestiona débitos automáticos.
* Monitorea y administra suscriptores desde una interfaz amigable.
2. **Integración mediante API**
* Conecta el módulo con tu ecommerce o plataforma web/app.
* Controla la experiencia de usuario y la lógica de negocio.
* Accede a servicios seguros y documentados para una integración ágil.
**Requisitos iniciales**
Antes de comenzar:
* Solicita a Plexo la **creación de tu empresa en el módulo**.
* Firma el contrato con el equipo comercial.
Comercial Plexo
Teléfono: 095 737 732
Correo: [comercial@plexo.com.uy](https://mail.google.com/mail/u/1/#search/comercial%40plexo.com.uy)
\\
# Manual
# 📊 Dashboard
### ✅ ¿Qué es el Dashboard?
El **Dashboard** es la página de inicio del **Módulo de Suscripciones**, y está diseñado para ofrecer una **visión clara, rápida y actualizada** del estado de las suscripciones en tu empresa.
Su objetivo principal es **facilitar la toma de decisiones** estratégicas mediante una vista consolidada de indicadores clave del negocio relacionados con la suscripción de clientes.
***
### 🔍 ¿Qué información muestra?
Actualmente, el Dashboard presenta dos métricas fundamentales:
#### 1. Total de suscripciones activas
* **¿Qué es?**\
Número total de suscripciones actualmente activas en tu empresa.
* **¿Por qué es importante?**\
Representa a los clientes con servicios vigentes, y permite medir la **salud del negocio** y el volumen de ingresos recurrentes.
* **¿Cómo se actualiza?**\
Se actualiza en tiempo real o con la frecuencia definida por el sistema.
***
### 2. 📅 Suscripciones canceladas con vigencia
#### 🧾 ¿Qué es?
Son suscripciones que ya han sido **canceladas por el cliente o manualmente**, pero que **continúan activas** porque el cliente **ya pagó el período actual**, el cual todavía no ha finalizado.
> ⚠️ Aunque la suscripción está **en estado "Cancelada"**, la implementación del sistema permite que siga funcionando **hasta la fecha de vencimiento ya abonada**.
***
#### 📌 Ejemplo práctico
> Si un cliente **cancela su suscripción el 10 de agosto**, pero el período de facturación actual termina el **31 de agosto**:
>
> * La suscripción pasa a estado **Cancelada**.
> * **Sigue activa hasta el 31 de agosto**, ya que ese período está pago.
> * Después de esa fecha, **se desactiva definitivamente** y no se emiten más cobros.
***
#### 🎯 ¿Por qué es importante?
* Permite prever la **salida futura de clientes**, lo cual es clave para reportes y métricas de tasa de abandono de clientes.
* Brinda la oportunidad de **ejecutar estrategias de retención o recuperación** antes de que la suscripción se desactive por completo.
* Ayuda a coordinar acciones del equipo de soporte o comercial, sabiendo que aún hay tiempo para intervenir.
***
### 💡 ¿Cómo usar esta información?
* **Monitoreo diario**: Consulta el Dashboard al inicio de cada jornada para conocer el estado actual de tus suscripciones.
* **Toma de decisiones**: Úsalo como punto de partida para decidir si se deben lanzar campañas de retención o reactivación.
* **Detección de tendencias**: Al observar aumentos o disminuciones, puedes identificar comportamientos clave de los usuarios.
***
### 📌 Recomendaciones
| Acción | Descripción |
| ------------------------ | ---------------------------------------------------------------------------------------- |
| 📈 Revisión constante | Mantén un hábito de consulta diaria del Dashboard. |
| 🤝 Planes de retención | Actúa sobre las cancelaciones con vigencia: hay tiempo para recuperar al cliente. |
| 📊 Complemento analítico | Usa esta vista como resumen, y complementa con reportes específicos según sea necesario. |
***
# Configuraciones
En este panel se puede:
[Gestionar los CallBack](/suscripciones/manual/configuraciones/callbacks)
[Cambiar el Esquema de Reintentos](/suscripciones/manual/configuraciones/politicas-de-reintentos)
[Cambiar el Secret Client](/suscripciones/manual/configuraciones/manual-de-informacion-de-credenciales)
# 📘Callbacks
### Introducción
Los **callbacks** (también conocidos como *webhooks*) son mensajes automáticos que el sistema de suscripciones de Plexo envía a tu sistema cada vez que ocurre un evento importante. Estos mensajes llegan en formato **JSON** mediante una solicitud HTTP de tipo **POST**.
Para recibirlos, tu sistema debe exponer una URL pública (por ejemplo, `https://tusistema.com/callback`) y configurarla desde el **Backoffice** en la sección **Configuraciones → Gestión de Notificación**.
***
### ✅ Requisitos para recibir callbacks
* La URL debe aceptar **POST**.
* Debe estar protegida por **HTTPS**.
* Debe responder con un **código HTTP 2xx** (por ejemplo, 200 OK) para confirmar recepción.
***
### 🧩 Estructura común de todos los callbacks
Todos los callbacks contienen un conjunto básico de datos bajo el objeto `NotificationDto`, que incluye:
```json
{
"NotificationType": "TipoDeNotificación",
"SubscriptionId": "ID de la suscripción",
"TransactionID": "ID de la transacción",
"Result": true o false
}
```
***
## 📂 Tipos de Callbacks
A continuación, se detallan los distintos tipos de callbacks que el sistema puede enviar:
***
### 🔄 1. Renovación Automática (`RecurringPayment`)
Se envía cuando se realiza un cobro exitoso por una renovación automática.
#### Datos incluidos:
* `BillId`: ID del cobro.
* `Instrument`: Medio de pago usado.
* `SubscriberName`: Nombre del cliente.
* `Amount`: Monto pagado.
* `PercentageTax`: Porcentaje de impuestos.
* `Currency`: Moneda utilizada.
* `PaymentDate`: Fecha del pago.
* `ExternalId`: ID externo (si aplica).
* `SubscriptionTypeId` y `SubscriptionTypeName`: Detalles del plan.
* `Authorization`, `Ticket`: Autorizaciones del procesador.
* `Success`: Resultado del pago.
* `ErrorString`: Motivo del fallo (si `Success` es false).
***
### ❌ 2. Pago Fallido (`PaymentFailure`)
Se envía cuando un cobro automático falla.
#### Datos incluidos:
* `TimesAttempted`: Cantidad de intentos fallidos.
* `ExternalId`: ID externo del suscriptor.
* `SubscriptionTypeId` y `SubscriptionTypeName`: Tipo de suscripción.
***
### 🚫 3. Cancelación de Transacción (`TransactionCancellation`)
Se envía cuando una transacción se cancela.
#### Datos incluidos:
* `PlexoReferenceId`: ID de referencia de la transacción.
* `ClientId`, `ClientName`: Información del cliente.
* `SubscriptorId`, `SubscriptorExternalId`: Datos del suscriptor.
* `SubscriptionName`, `SubscriptionTypeId`, `SubscriptionStatus`, `SubscriptionToken`.
* `TransactionAmount`, `Currency`, `TransactionDate`.
* `InstrumentId`, `InstrumentToken`, `IssuerName`, `Name`.
* `Status`: Estado final.
* `IssuerAuthCode`, `Ticket`.
* `ErrorText`, `ErrorCode`.
* `CancellationDate`.
***
### 🧾 4. Otros tipos disponibles
| Tipo (`NotificationType`) | Descripción |
| -------------------------- | -------------------------------------------- |
| `SubscriptionCancellation` | Se envía cuando una suscripción es cancelada |
| `SubscriptorData` | Datos del suscriptor creados o modificados |
| `InstrumentRegistration` | Se registra un nuevo medio de pago |
***
### 🧠 Buenas prácticas
* Configurá entornos separados para **Testing** y **Producción**.
* Registrá todos los callbacks que recibís (logs).
* Usá una verificación adicional de seguridad (tokens, headers, etc.).
* Validá los campos recibidos antes de procesarlos.
* Siempre respondé con `200 OK` al recibirlos, incluso si luego procesás en segundo plano.
***
# Políticas de Reintentos
### 📌 ¿Qué son las Políticas de Reintentos?
Cuando un pago automático falla (por ejemplo, por falta de fondos o un problema con la tarjeta), el sistema **no se rinde al primer intento**. En su lugar, aplica una **política de reintentos**, es decir, vuelve a intentar cobrar al cliente después de ciertos intervalos.
Actualmente existen **dos esquemas de reintento** que podés configurar:
***
### 📊 Esquemas disponibles
| Evento | Tradicional | Semanal |
| ----------------- | ----------- | --------- |
| **Pago inicial** | 0 minutos | 0 minutos |
| **1ᵉʳ reintento** | 1 minuto | 1 hora |
| **2ᵈᵒ reintento** | 1 hora | 24 horas |
| **3ᵉʳ reintento** | 12 horas | 7 días |
✅ **"0 minutos"** en el Pago inicial indica que el intento se realiza **inmediatamente** cuando se genera la orden de cobro.
⏳ **Hasta 3 reintentos** se ejecutan automáticamente si el pago sigue fallando.
***
### 🧠 ¿Por qué es útil?
* Aumentás las chances de cobrar aunque el primer intento falle.
* Evitás que una suscripción se cancele por un problema puntual.
* Podés elegir el esquema que mejor se adapte a tu modelo de negocio.
***
### 💼 ¿Cuándo usar cada esquema?
| Esquema | Ideal para... |
| --------------- | ---------------------------------------------------------------------------------------- |
| **Tradicional** | Servicios con acceso inmediato, donde se requiere validación rápida. |
| **Semanal** | Servicios con ciclos más largos o flexibles, donde no es necesario cobrar en el momento. |
***
### 🖥️ Visualización
***
### 🧭 Cómo configurar el esquema
1. Accede al Backoffice.
2. Selecciona el tipo de suscripción.
3. Elegí entre el esquema **Tradicional** o **Semanal** según tu estrategia.
4. Guarda los cambios.
> ⚠️ Importante: los reintentos se ejecutan automáticamente y no requieren intervención manual.
***
### 📝 Recomendaciones
* Proba primero con el esquema **Tradicional** si necesitas aprobación inmediata.
* Monitorea los resultados para ajustar tu estrategia.
* Combina esto con las **notificaciones de Pago Fallido** para informar al usuario y evitar cancelaciones.
***
# Manual de Información de Credenciales
### 📌 ¿Qué son las credenciales?
Las **credenciales de acceso** son datos confidenciales que te permiten integrar tu sistema con la **API de Plexo**. Son necesarias para autenticar tu aplicación y garantizar que las comunicaciones sean seguras y verificadas.
Estas credenciales están disponibles en el **Backoffice**, en la sección de configuración de integración.
***
### 🔑 Tipos de credenciales
| Credencial | Descripción |
| ----------- | ------------------------------------------------------------------------------- |
| `clientId` | Identificador único para tu aplicación. Es obligatorio para conectarse. |
| `secretKey` | Funciona como una contraseña. Nunca debe compartirse ni exponerse públicamente. |
***
### ⚠️ Seguridad
* **No compartas el `secretKey`** con nadie fuera de tu equipo técnico autorizado.
* Si creés que el `secretKey` ha sido comprometido, **reinicialo inmediatamente** desde el Backoffice.
* Al regenerar la clave, **la anterior dejará de funcionar automáticamente**, por lo que deberás actualizarla en tu sistema.
***
### 🛠️ ¿Dónde encuentro estas credenciales?
1. Ingresa al **Backoffice** de Plexo.
2. Navega hasta la sección de **Configuraciones → Información de Credenciales**.
3. Allí verás tu `clientId` y `secretKey`, y la opción para reiniciar la clave si lo necesitas.
***
### 🖼️ Vista de ejemplo
***
### ✅ Buenas prácticas
* Guardá las credenciales en un entorno seguro (como un gestor de secretos o variables de entorno).
* No incluyas el `secretKey` en tu código fuente.
* Limitá el acceso a quienes realmente lo necesiten.
* Documentá internamente su uso y el procedimiento en caso de regeneración.
***
# Panel de Transacciones
### 📌 ¿Qué es el Panel de Transacciones?
El **Panel de Transacciones** es una herramienta visual dentro del Backoffice de Plexo que te permite **ver y analizar todas las transacciones** realizadas en tu sistema de suscripciones.
Este panel está pensado para facilitar la gestión diaria, brindando filtros, estados y opciones de exportación para que tengas el control total sobre los pagos procesados.
***
### 🔍 Funcionalidades del panel
#### 🔎 Filtrado de transacciones
Podés buscar y filtrar transacciones según:
* **Fecha**
* **Estado del pago** (fallido o exitoso)
* **Monto**
* **Nombre del suscriptor**
* **Tipo de suscripción**
Esto te permite encontrar información específica en pocos segundos.
***
#### 📤 Exportación a Excel (XLS)
Si necesitás analizar los datos fuera del sistema, el panel permite **exportar todas las transacciones visibles a un archivo XLS** compatible con Excel, Google Sheets y otras herramientas.
Ideal para:
* Reportes financieros
* Análisis de tendencias de pago
* Auditorías internas
***
### 🎨 Estados de las transacciones
El sistema usa **colores** para ayudarte a identificar rápidamente el estado de cada transacción:
| Estado | Color | Significado |
| ------------------------ | ------- | ----------------------------------------------- |
| **Transacción Fallida** | 🔴 Rojo | El pago no se pudo procesar. Requiere revisión. |
| **Transacción Correcta** | ⚪ Gris | El pago fue exitoso. No necesita intervención. |
***
### 🖼️ Vista de ejemplo
***
### ✅ Recomendaciones
* Revisá las **transacciones fallidas** todos los días para tomar acción a tiempo.
* Usá los filtros para encontrar rápidamente casos puntuales.
* Exportá los datos semanal o mensualmente para respaldos y análisis.
* Si detectás errores repetidos, revisá la configuración de medios de pago o contactá a soporte.
***
# ¿Cómo Crear un Tipo de Suscripción?
### 📌 Pasos para crear un nuevo tipo de suscripción
1. Ingresá a la sección **Tipos de Suscripciones** desde el menú principal del Backoffice.
2. Hacé clic en el botón **Nuevo Tipo de Suscripción**.
3. Se abrirá una ventana donde deberás completar los campos necesarios.
***
### 🖼️ Pantalla de acceso
***
### 📝 Campos disponibles
#### 🏷️ Nombre del tipo de suscripción
Nombre identificador del plan.
> Ejemplo: `Suscripción Platino Mensual`
***
#### 🖊️ Descripción de la suscripción
Breve texto explicando qué incluye o a quién está dirigida la suscripción.
***
#### 🔁 Frecuencia de cobro
Seleccioná cada cuánto se realiza el cobro automático.
Opciones:
* Diaria
* Semanal
* Mensual
* Bimensual
* Trimestral
* Anual
***
#### 📆 Fin de la suscripción
Permite establecer cuándo termina la suscripción (si no es indefinida).
> Este campo se mide con la misma unidad que la frecuencia.
> Ejemplo: 1 semana, 1 mes, 1 año
***
#### 💲 Moneda
Seleccioná si se cobrará en:
* Pesos
* Dólares
***
#### 💰 Monto a cobrar
Ingresá el **monto total**, incluyendo IVA si corresponde.
***
#### 🧾 IVA
Indica el valor de IVA aplicable. Es útil si:
* Se manejan distintos tipos de IVA.
* Se trata de donaciones o servicios exentos.
***
### 🖼️ Vista del formulario
***
### ✅ Recomendaciones
* Usá nombres claros y descriptivos.
* Definí bien la frecuencia según tu modelo de negocio.
* Asegurate de que el monto y el IVA estén correctamente configurados.
***
# ¿Cómo Crear una Suscripción?
Para poder crear una suscripción, primero debe existir al menos un **Tipo de Suscripción** ya configurado.\
Ver cómo crear un tipo de suscripción [¿Cómo Crear un Tipo de Suscripción?](/suscripciones/manual/como-crear-un-tipo-de-suscripcion)
***
### 🧭 Pasos para crear una suscripción
#### 1. Ingresar a Suscriptores y Links
1. Accedé al apartado **Suscriptores y Links**.
2. Hacé clic en **Generar Link de Suscriptor**.
***
#### 2. Completar los campos del suscriptor
* **ID Externo**: Identificador único del suscriptor dentro de tu negocio.
* Si no tenés uno, podés hacer clic en **Generar ID Externo** y el sistema generará uno automáticamente.
* **Nombre, Apellido y Correo electrónico** del suscriptor.
* **Plan (Tipo de Suscripción)**: Seleccioná el plan que querés asignarle.
> Si el cliente agrega su medio de pago, la suscripción se activa automáticamente.
***
#### 3. Continuar y generar link
Presioná **Continuar**.\
El sistema generará un **link único** para que el cliente ingrese su instrumento de pago.
***
#### 4. ¿Qué puede pasar después?
Una vez enviado el link, pueden ocurrir 3 escenarios:
1. ✅ El cliente **ingresa el instrumento de pago** y queda suscripto automáticamente.
2. 🕗 El cliente ingresa el instrumento **sin un plan asignado**, queda registrado pero sin suscripción activa.
3. ⏳ El cliente **no completa el proceso**, el link queda pendiente.
***
### 🔗 Formas de asociar una suscripción
#### 1. Asociar mediante API
Se realiza usando el endpoint `subscriptors`, donde podés vincular un tipo de suscripción directamente desde tu sistema.
***
#### 2. Asociar desde el Backoffice
También podés hacerlo manualmente desde la interfaz administrativa.
1. Entrá a **Suscriptores y Links**.
2. Hacé clic en **Nueva Suscripción**.
3. Completá:
* `ExternalID` del suscriptor.
* `Tipo de suscripción` que querés asignar.
4. Hacé clic en **Crear**.
El sistema intentará realizar el cobro inicial automáticamente.
***
#### 3. Asociar mediante el Link
Si al generar el link se asigna un plan, **la suscripción se activa automáticamente** cuando el cliente introduce su medio de pago.
***
# ¿Cómo Eliminar Suscripciones?
### ❌ Cancelación de suscripciones
Las suscripciones **no pueden eliminarse definitivamente** del sistema, pero sí **cancelarse**.\
Una vez cancelada, la suscripción **deja de generar cobros futuros**, lo que la vuelve inactiva a nivel operativo.
***
### 🔄 Estados de una suscripción
Cada suscripción puede tener distintos estados.\
El estado **Cancelado** indica que la suscripción ya no está activa.
> Más información sobre los estados: Ver estados de suscripción
***
### 🧭 ¿Cómo cancelar una suscripción?
1. Ingresá a **Buscar Suscripciones** desde el menú del sistema.
2. Localizá la suscripción que querés cancelar.
3. Hacé clic en **Acciones**.
4. Seleccioná la opción **Cancelar Renovación**.
5. Confirmá la acción.
Una vez hecho esto, la suscripción cambiará su estado a **Cancelado** y **no se generarán más cobros** a partir del siguiente ciclo.
***
### 🖼️ Ejemplos visuales
***
***
### ✅ Resultado
Después de cancelar la suscripción:
* Se mantendrá activa hasta el fin del período vigente.
* No se generarán nuevos cobros después de esa fecha.
* El cliente dejará de formar parte del ciclo de facturación automática.
***
# Links de Suscripciones
### 📌 ¿Qué son los Links de Suscripción?
Los **links de suscripción** son enlaces generados desde el Backoffice que se envían al cliente para que registre su **instrumento de pago** (por ejemplo, tarjeta o medio bancario).
***
### ⚙️ ¿Cómo funciona?
1. Se genera un link desde el apartado de **Suscriptores y Links**.
2. El cliente recibe ese link por el medio que elijas (correo, mensaje, etc.).
3. El cliente ingresa al link y completa el registro de su medio de pago.
4. Hasta que no lo haga, el link permanece en estado **Sin Instrumento de pago**.
5. Una vez que el instrumento es ingresado correctamente, el estado del link cambia a **Completado**.
***
### 🖼️ Vista del panel
***
### 🔗 Asociación con un plan (Tipo de Suscripción)
* Una vez que el link está en estado **Completado**, ya se puede asociar un **Tipo de Suscripción**.
* Antes de ese momento **no es posible** asignar un plan porque el sistema necesita un método de pago válido para generar el cobro.
***
### ✅ Consideraciones
* Siempre verificá que el estado del link sea **Completado** antes de intentar asociar una suscripción.
* Si el cliente no completa el registro, el link puede reusarse hasta que lo haga.
* Este método es ideal cuando querés que el cliente cargue su medio de pago de forma autónoma y segura.
***
# Detalles de la Suscripción
### 📌 ¿Dónde ver el detalle de una suscripción?
Desde el apartado **Suscriptores y Links**, podés seleccionar cualquier suscripción y acceder al **panel de detalle** usando el botón **Acciones**.
***
### 🖼️ Vista general
***
### 📋 Información disponible
En este panel podés consultar los principales datos de una suscripción activa o cancelada:
* **Método de pago**: información del instrumento registrado (tarjeta, cuenta, etc.).
* **Estado de la suscripción**: se muestra con un botón de color.
* 🟢 Verde: Activa
* 🔴 Rojo: Cancelada
* **Opción de cancelación**: botón para finalizar la suscripción.
* **Fecha de validez**: hasta cuándo sigue vigente.
* **Fecha del último pago**: muestra el cobro más reciente realizado con éxito.
***
### 🧾 Historial de pagos
En la parte inferior del panel se encuentra el historial completo de pagos relacionados con esa suscripción.
* Muestra todos los **intentos de cobro**.
* Indica si fueron **exitosos o fallidos**.
* Incluye fechas, montos y resultados.
***
### 📚 Suscripciones múltiples
Si un suscriptor tiene **más de una suscripción asociada al mismo External ID**, el sistema mostrará una pestaña por cada suscripción.\
Esto te permite navegar entre sus distintos planes de forma organizada.
***
### 🖼️ Ejemplo del historial
***
# 2FA Autenticacion
### Activación Obligatoria de Doble Autenticación (2FA)
Con el objetivo de reforzar la seguridad del sistema, se ha habilitado de forma **obligatoria** la funcionalidad de **autenticación en dos pasos (2FA)** para todos los usuarios.
#### ¿Qué es 2FA?
2FA (Two-Factor Authentication) es un sistema de seguridad que requiere dos factores para verificar la identidad del usuario:
1. **Credenciales de acceso** (usuario y contraseña).
2. **Código de autenticación temporal** generado por una aplicación externa (Microsoft Authenticator, Google Authenticator, Authy, entre otras).
***
#### ⚙️ Proceso de Activación Inicial
Al intentar iniciar sesión por primera vez tras la activación del 2FA, deberás seguir estos pasos:
1. **Ingresa tu usuario y contraseña.**
* Deja el campo **"Código 2FA" vacío.**
2. Al enviar las credenciales, el sistema detectará que no tienes el 2FA configurado y generará un **código QR**.
3. **Escanea el código QR** utilizando una app de autenticación como:
* Microsoft Authenticator
* Google Authenticator
* Authy
4. Una vez escaneado, la app generará un **código temporal de 6 dígitos**.
5. **Introduce ese código en el campo "Código 2FA"** para completar la activación.
***
#### 🔐 Inicios de sesión posteriores
A partir de ese momento, el inicio de sesión requerirá siempre los siguientes datos:
1. Usuario
2. Contraseña
3. Código 2FA generado por tu app de autenticación
> ⚠️ El código cambia cada 30 segundos. Asegúrate de usar uno válido al momento de iniciar sesión.
# Integración Por Api
## 1 - Registrar al usuario en la plataforma
## Registrar suscriptor
> Registra un nuevo suscriptor para el cliente especificado. Requiere credenciales válidas del cliente.
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Subscriptors","description":"Endpoints para gestionar suscriptores, suscripciones y operaciones relacionadas."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Subscriptors":{"post":{"tags":["Subscriptors"],"summary":"Registrar suscriptor","description":"Registra un nuevo suscriptor para el cliente especificado. Requiere credenciales válidas del cliente.","operationId":"RegisterSubscriptor","parameters":[{"name":"clientSecret","in":"header","schema":{"type":"string","nullable":true}},{"name":"clientId","in":"header","schema":{"type":"string","nullable":true}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddSubscriptorRequest"}}},"required":true},"responses":{"200":{"description":"Éxito","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscriptor"}}}},"400":{"description":"Solicitud incorrecta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"ClientSecret inválido"}}}}},"components":{"schemas":{"AddSubscriptorRequest":{"type":"object","additionalProperties":false,"properties":{"externalId":{"type":"string","description":"El externalId es el Id del suscriptor dentro del sistema del cliente.","maxLength":100,"nullable":true},"email":{"type":"string","format":"email","maxLength":50,"nullable":true},"name":{"type":"string","maxLength":50,"nullable":true},"fullName":{"type":"string","maxLength":150,"nullable":true},"linkId":{"type":"string","format":"guid","nullable":true}}},"Subscriptor":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["externalId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","maxLength":100,"minLength":0},"email":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"name":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"fullName":{"type":"string","maxLength":150,"minLength":0,"nullable":true},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"instruments":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Instrument"}},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscription"}},"links":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Link"}}}}]},"BaseEntity":{"type":"object","additionalProperties":false},"Client":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","legalName","legalId","clientSecret","plexoCommerceId","admin","taxPercentage"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"legalName":{"type":"string","maxLength":150,"minLength":1},"legalId":{"type":"string","maxLength":12,"minLength":1},"clientSecret":{"type":"string","maxLength":50,"minLength":1},"plexoCommerceId":{"type":"integer","format":"int32"},"recurringPaymentUrl":{"type":"string","maxLength":100,"nullable":true},"admin":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationUser"}},"taxPercentage":{"type":"number","format":"decimal","default":22},"subscriptionTypes":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionType"}},"clientIssuers":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ClientIssuer"}},"subscriptors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscriptor"}},"historicData":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/HistoricData"}},"retriesConfiguration":{"$ref":"#/components/schemas/RetriesConfigurationEnum"},"notificationPermissionsId":{"type":"integer","format":"int32"},"notificationPermissions":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NotificationPermissions"}]}}}]},"ApplicationUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUser"},{"type":"object","additionalProperties":false,"properties":{"userType":{"$ref":"#/components/schemas/UserType"},"clientID":{"type":"string","format":"guid"}}}]},"IdentityUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUserOfString"},{"type":"object","description":"The default implementation of IdentityUser`1 which uses a string as a primary key.","additionalProperties":false}]},"IdentityUserOfString":{"type":"object","description":"Represents a user in the identity system","additionalProperties":false,"properties":{"id":{"type":"string","description":"Gets or sets the primary key for this user.","nullable":true},"userName":{"type":"string","description":"Gets or sets the user name for this user.","nullable":true},"normalizedUserName":{"type":"string","description":"Gets or sets the normalized user name for this user.","nullable":true},"email":{"type":"string","description":"Gets or sets the email address for this user.","nullable":true},"normalizedEmail":{"type":"string","description":"Gets or sets the normalized email address for this user.","nullable":true},"emailConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their email address."},"passwordHash":{"type":"string","description":"Gets or sets a salted and hashed representation of the password for this user.","nullable":true},"securityStamp":{"type":"string","description":"A random value that must change whenever a users credentials change (password changed, login removed)","nullable":true},"concurrencyStamp":{"type":"string","description":"A random value that must change whenever a user is persisted to the store","nullable":true},"phoneNumber":{"type":"string","description":"Gets or sets a telephone number for the user.","nullable":true},"phoneNumberConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their telephone address."},"twoFactorEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if two factor authentication is enabled for this user."},"lockoutEnd":{"type":"string","description":"Gets or sets the date and time, in UTC, when any user lockout ends.","format":"date-time","nullable":true},"lockoutEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if the user could be locked out."},"accessFailedCount":{"type":"integer","description":"Gets or sets the number of failed login attempts for the current user.","format":"int32"}}},"UserType":{"type":"integer","description":"","enum":[0,1,2]},"SubscriptionType":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","description","frequence","cost","currency","status","recurrence"],"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","maxLength":50,"minLength":0},"description":{"type":"string","maxLength":120,"minLength":0},"frequence":{"$ref":"#/components/schemas/Frequence"},"cost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"status":{"$ref":"#/components/schemas/SubscriptionTypeStatus"},"recurrence":{"type":"integer","format":"int32","default":0},"taxPercentage":{"type":"number","format":"decimal","nullable":true}}}]},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"SubscriptionTypeStatus":{"type":"integer","description":"","enum":[0,99]},"ClientIssuer":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["issuerId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"issuerId":{"type":"integer","format":"int32"},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]}}}]},"HistoricData":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"date":{"type":"string","format":"date"},"totalSubscriptors":{"type":"integer","format":"int32"}}},"RetriesConfigurationEnum":{"type":"integer","description":"","enum":[0,1]},"NotificationPermissions":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["id"],"properties":{"id":{"type":"integer","format":"int32"},"transactionCancellation":{"type":"boolean"},"subscriptionCancellation":{"type":"boolean"},"subscriptorFields":{"type":"boolean"},"paymentSuccess":{"type":"boolean"},"paymentFailed":{"type":"boolean"},"subcriptioninactiveByPaymentFailure":{"type":"boolean"}}}]},"Instrument":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["subscriptorId","instrumentToken","name","issuerName","issuerImageUrl","expiration","status"],"properties":{"id":{"type":"string","format":"guid"},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"instrumentToken":{"type":"string","format":"guid","minLength":1},"name":{"type":"string","maxLength":50,"minLength":1},"issuerName":{"type":"string","maxLength":50,"minLength":1},"issuerImageUrl":{"type":"string","maxLength":200,"minLength":1},"expiration":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/InstrumentStatus"},"uniqueID":{"type":"string","maxLength":200,"nullable":true},"plexoExtendedResponse":{"type":"string","nullable":true}}}]},"InstrumentStatus":{"type":"integer","description":"","enum":[0,99]},"Subscription":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["token","subscriptionTypeId","date","status","lastPaymentDate","validToDate","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"token":{"type":"string","minLength":1},"subscriptionTypeId":{"type":"integer","format":"int32"},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionType"}]},"date":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/SubscriptionStatus"},"lastPaymentDate":{"type":"string","format":"date","minLength":1},"validToDate":{"type":"string","format":"date","minLength":1},"backgroundJobId":{"type":"string","nullable":true},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"suspendedBy":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SuspendedByEnum"}]},"suspendedDate":{"type":"string","format":"date","nullable":true},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"remainingRecurrences":{"type":"integer","format":"int32","nullable":true}}}]},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"SuspendedByEnum":{"type":"integer","description":"","enum":[0,1]},"Transaction":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["currency","amount","taxedAmount","taxAmount","date","status","retryAttempt","type","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"currency":{"$ref":"#/components/schemas/Currency"},"amount":{"type":"number","format":"decimal"},"taxedAmount":{"type":"number","format":"decimal"},"taxAmount":{"type":"number","format":"decimal"},"date":{"type":"string","format":"date-time","minLength":1},"status":{"$ref":"#/components/schemas/TransactionStatus"},"authorization":{"type":"string","nullable":true},"plexoReferenceId":{"type":"string","nullable":true},"errorText":{"type":"string","nullable":true},"retryAttempt":{"type":"integer","format":"int32","default":1},"plexoClientReference":{"type":"string","nullable":true},"ticket":{"type":"string","nullable":true},"type":{"default":1,"oneOf":[{"$ref":"#/components/schemas/TransactionType"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItemId":{"type":"string","format":"guid","nullable":true},"transactionRequestItem":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestItem"}]},"subscriptionId":{"type":"string","format":"guid","nullable":true},"subscription":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscription"}]},"instrumentId":{"type":"string","format":"guid","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Instrument"}]},"electronicBillingId":{"type":"integer","format":"int32","nullable":true},"electronicBilling":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ElectronicBill"}]}}}]},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionType":{"type":"integer","description":"","enum":[1,2]},"TransactionRequestItem":{"type":"object","additionalProperties":false,"required":["amount","currency","paymentRequestItemStatus","transactionRequestFileId","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"amount":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"paymentRequestItemStatus":{"$ref":"#/components/schemas/PaymentRequestItemStatus"},"transactionRequestFileId":{"type":"string","format":"guid","minLength":1},"transactionRequestFile":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestFile"}]},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"jobId":{"type":"string","nullable":true}}},"PaymentRequestItemStatus":{"type":"integer","description":"","enum":[1,2,3]},"TransactionRequestFile":{"type":"object","additionalProperties":false,"required":["name","url","clientId"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"url":{"type":"string","maxLength":200,"minLength":1},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItems":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionRequestItem"}},"date":{"type":"string","format":"date-time"}}},"ElectronicBill":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["internalId","caeNumber","series","number"],"properties":{"id":{"type":"integer","format":"int32"},"internalId":{"type":"integer","format":"int32"},"caeNumber":{"type":"string","minLength":1},"series":{"type":"string","minLength":1},"number":{"type":"integer","format":"int32"}}}]},"Link":{"type":"object","additionalProperties":false,"required":["externalId","status","clientId","canUpdateSubscriptorData"],"properties":{"id":{"type":"string","format":"guid"},"externalId":{"type":"string","maxLength":150,"minLength":1},"firstName":{"type":"string","maxLength":50,"nullable":true},"lastName":{"type":"string","maxLength":50,"nullable":true},"email":{"type":"string","maxLength":150,"nullable":true},"status":{"default":1,"oneOf":[{"$ref":"#/components/schemas/LinkStatusEnum"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"subscriptorId":{"type":"integer","format":"int32","nullable":true},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"canUpdateSubscriptorData":{"type":"boolean","default":true},"subscriptionTypeId":{"type":"string","nullable":true}}},"LinkStatusEnum":{"type":"integer","description":"","enum":[1,2,3]},"ErrorResponse":{"type":"object","additionalProperties":false,"properties":{"code":{"$ref":"#/components/schemas/HttpStatusCode"},"message":{"type":"string","nullable":true},"subCode":{"type":"integer","format":"int32"}}},"HttpStatusCode":{"type":"integer","description":"包含針對 HTTP 所定義的狀態碼值。","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,300,301,301,302,302,303,303,304,305,306,307,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511]}}}}
```
## 2. Generar Enlaces para Añadir el Instrumento
## Iniciar registro instrumento
> Obtiene la URL de Plexo para registrar un instrumento de pago.
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Instrumentos","description":"Endpoints para registrar, consultar y eliminar instrumentos de pago."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Instruments":{"post":{"tags":["Instrumentos"],"summary":"Iniciar registro instrumento","description":"Obtiene la URL de Plexo para registrar un instrumento de pago.","operationId":"Instrumentos_IniciarRegistro","parameters":[{"name":"clientSecret","in":"header","schema":{"type":"string","nullable":true}},{"name":"clientId","in":"header","schema":{"type":"string","nullable":true}},{"name":"externalId","in":"header","schema":{"type":"string","nullable":true}},{"name":"redirectUrl","in":"header","schema":{"type":"string","nullable":true}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterInstrumentRequest"}}},"required":true},"responses":{"200":{"description":"Éxito","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterInstrumentResponse"}}}},"400":{"description":"Solicitud incorrecta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Credenciales inválidas"}}}}},"components":{"schemas":{"RegisterInstrumentRequest":{"type":"object","additionalProperties":false,"properties":{"callbackUrl":{"type":"string","nullable":true},"populateData":{"type":"boolean"}}},"RegisterInstrumentResponse":{"type":"object","additionalProperties":false,"properties":{"url":{"type":"string","nullable":true}}},"ErrorResponse":{"type":"object","additionalProperties":false,"properties":{"code":{"$ref":"#/components/schemas/HttpStatusCode"},"message":{"type":"string","nullable":true},"subCode":{"type":"integer","format":"int32"}}},"HttpStatusCode":{"type":"integer","description":"包含針對 HTTP 所定義的狀態碼值。","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,300,301,301,302,302,303,303,304,305,306,307,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511]}}}}
```
### Callback: Nuevo Instrumento
#### Descripción
Se genera un llamado post
#### Objetivo
Notificar que un suscriptor ingreso un nuevo instrumento asociado
#### Modelo
```
public bool RegisterSuccess { get; set; }
public string ErrorString { get; set; }
public string ExternalId { get; set; }
public InstrumentDto Instrument { get; set; }
public bool Result { get; set; }
public string NotificationTypeDisplayName { get; } = Enumerables.NotificationType.InstrumentRegistration.ToString();
```
## Crear Suscripcion
## Crear suscripción
> Crea una suscripción para el suscriptor y tipo indicado. Puede requerir un pago exitoso para activarse.
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Subscriptors","description":"Endpoints para gestionar suscriptores, suscripciones y operaciones relacionadas."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Subscriptors/subscribe":{"post":{"tags":["Subscriptors"],"summary":"Crear suscripción","description":"Crea una suscripción para el suscriptor y tipo indicado. Puede requerir un pago exitoso para activarse.","operationId":"SubscribeUser","parameters":[{"name":"clientSecret","in":"header","schema":{"type":"string","nullable":true}},{"name":"clientId","in":"header","schema":{"type":"string","nullable":true}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscribeRequest"}}},"required":true},"responses":{"200":{"description":"Éxito","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"400":{"description":"Solicitud incorrecta. La suscripción puede crearse sin pago exitoso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"ClientSecret inválido"}}}}},"components":{"schemas":{"SubscribeRequest":{"type":"object","additionalProperties":false,"properties":{"clientId":{"type":"string","format":"guid"},"externalId":{"type":"string","nullable":true},"subscriptionTypeId":{"type":"integer","format":"int32"},"subscriptionCreationStrategy":{"$ref":"#/components/schemas/SubscriptionCreationStrategy"},"requireSuccessfulTransaction":{"type":"boolean"},"dayOfRenewal":{"type":"integer","format":"int32","nullable":true}}},"SubscriptionCreationStrategy":{"type":"integer","description":"","enum":[0,1,2]},"Subscription":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["token","subscriptionTypeId","date","status","lastPaymentDate","validToDate","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"token":{"type":"string","minLength":1},"subscriptionTypeId":{"type":"integer","format":"int32"},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionType"}]},"date":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/SubscriptionStatus"},"lastPaymentDate":{"type":"string","format":"date","minLength":1},"validToDate":{"type":"string","format":"date","minLength":1},"backgroundJobId":{"type":"string","nullable":true},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"suspendedBy":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SuspendedByEnum"}]},"suspendedDate":{"type":"string","format":"date","nullable":true},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"remainingRecurrences":{"type":"integer","format":"int32","nullable":true}}}]},"BaseEntity":{"type":"object","additionalProperties":false},"SubscriptionType":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","description","frequence","cost","currency","status","recurrence"],"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","maxLength":50,"minLength":0},"description":{"type":"string","maxLength":120,"minLength":0},"frequence":{"$ref":"#/components/schemas/Frequence"},"cost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"status":{"$ref":"#/components/schemas/SubscriptionTypeStatus"},"recurrence":{"type":"integer","format":"int32","default":0},"taxPercentage":{"type":"number","format":"decimal","nullable":true}}}]},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"SubscriptionTypeStatus":{"type":"integer","description":"","enum":[0,99]},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"Subscriptor":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["externalId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","maxLength":100,"minLength":0},"email":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"name":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"fullName":{"type":"string","maxLength":150,"minLength":0,"nullable":true},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"instruments":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Instrument"}},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscription"}},"links":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Link"}}}}]},"Client":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","legalName","legalId","clientSecret","plexoCommerceId","admin","taxPercentage"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"legalName":{"type":"string","maxLength":150,"minLength":1},"legalId":{"type":"string","maxLength":12,"minLength":1},"clientSecret":{"type":"string","maxLength":50,"minLength":1},"plexoCommerceId":{"type":"integer","format":"int32"},"recurringPaymentUrl":{"type":"string","maxLength":100,"nullable":true},"admin":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationUser"}},"taxPercentage":{"type":"number","format":"decimal","default":22},"subscriptionTypes":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionType"}},"clientIssuers":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ClientIssuer"}},"subscriptors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscriptor"}},"historicData":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/HistoricData"}},"retriesConfiguration":{"$ref":"#/components/schemas/RetriesConfigurationEnum"},"notificationPermissionsId":{"type":"integer","format":"int32"},"notificationPermissions":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NotificationPermissions"}]}}}]},"ApplicationUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUser"},{"type":"object","additionalProperties":false,"properties":{"userType":{"$ref":"#/components/schemas/UserType"},"clientID":{"type":"string","format":"guid"}}}]},"IdentityUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUserOfString"},{"type":"object","description":"The default implementation of IdentityUser`1 which uses a string as a primary key.","additionalProperties":false}]},"IdentityUserOfString":{"type":"object","description":"Represents a user in the identity system","additionalProperties":false,"properties":{"id":{"type":"string","description":"Gets or sets the primary key for this user.","nullable":true},"userName":{"type":"string","description":"Gets or sets the user name for this user.","nullable":true},"normalizedUserName":{"type":"string","description":"Gets or sets the normalized user name for this user.","nullable":true},"email":{"type":"string","description":"Gets or sets the email address for this user.","nullable":true},"normalizedEmail":{"type":"string","description":"Gets or sets the normalized email address for this user.","nullable":true},"emailConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their email address."},"passwordHash":{"type":"string","description":"Gets or sets a salted and hashed representation of the password for this user.","nullable":true},"securityStamp":{"type":"string","description":"A random value that must change whenever a users credentials change (password changed, login removed)","nullable":true},"concurrencyStamp":{"type":"string","description":"A random value that must change whenever a user is persisted to the store","nullable":true},"phoneNumber":{"type":"string","description":"Gets or sets a telephone number for the user.","nullable":true},"phoneNumberConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their telephone address."},"twoFactorEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if two factor authentication is enabled for this user."},"lockoutEnd":{"type":"string","description":"Gets or sets the date and time, in UTC, when any user lockout ends.","format":"date-time","nullable":true},"lockoutEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if the user could be locked out."},"accessFailedCount":{"type":"integer","description":"Gets or sets the number of failed login attempts for the current user.","format":"int32"}}},"UserType":{"type":"integer","description":"","enum":[0,1,2]},"ClientIssuer":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["issuerId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"issuerId":{"type":"integer","format":"int32"},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]}}}]},"HistoricData":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"date":{"type":"string","format":"date"},"totalSubscriptors":{"type":"integer","format":"int32"}}},"RetriesConfigurationEnum":{"type":"integer","description":"","enum":[0,1]},"NotificationPermissions":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["id"],"properties":{"id":{"type":"integer","format":"int32"},"transactionCancellation":{"type":"boolean"},"subscriptionCancellation":{"type":"boolean"},"subscriptorFields":{"type":"boolean"},"paymentSuccess":{"type":"boolean"},"paymentFailed":{"type":"boolean"},"subcriptioninactiveByPaymentFailure":{"type":"boolean"}}}]},"Instrument":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["subscriptorId","instrumentToken","name","issuerName","issuerImageUrl","expiration","status"],"properties":{"id":{"type":"string","format":"guid"},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"instrumentToken":{"type":"string","format":"guid","minLength":1},"name":{"type":"string","maxLength":50,"minLength":1},"issuerName":{"type":"string","maxLength":50,"minLength":1},"issuerImageUrl":{"type":"string","maxLength":200,"minLength":1},"expiration":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/InstrumentStatus"},"uniqueID":{"type":"string","maxLength":200,"nullable":true},"plexoExtendedResponse":{"type":"string","nullable":true}}}]},"InstrumentStatus":{"type":"integer","description":"","enum":[0,99]},"Link":{"type":"object","additionalProperties":false,"required":["externalId","status","clientId","canUpdateSubscriptorData"],"properties":{"id":{"type":"string","format":"guid"},"externalId":{"type":"string","maxLength":150,"minLength":1},"firstName":{"type":"string","maxLength":50,"nullable":true},"lastName":{"type":"string","maxLength":50,"nullable":true},"email":{"type":"string","maxLength":150,"nullable":true},"status":{"default":1,"oneOf":[{"$ref":"#/components/schemas/LinkStatusEnum"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"subscriptorId":{"type":"integer","format":"int32","nullable":true},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"canUpdateSubscriptorData":{"type":"boolean","default":true},"subscriptionTypeId":{"type":"string","nullable":true}}},"LinkStatusEnum":{"type":"integer","description":"","enum":[1,2,3]},"SuspendedByEnum":{"type":"integer","description":"","enum":[0,1]},"Transaction":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["currency","amount","taxedAmount","taxAmount","date","status","retryAttempt","type","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"currency":{"$ref":"#/components/schemas/Currency"},"amount":{"type":"number","format":"decimal"},"taxedAmount":{"type":"number","format":"decimal"},"taxAmount":{"type":"number","format":"decimal"},"date":{"type":"string","format":"date-time","minLength":1},"status":{"$ref":"#/components/schemas/TransactionStatus"},"authorization":{"type":"string","nullable":true},"plexoReferenceId":{"type":"string","nullable":true},"errorText":{"type":"string","nullable":true},"retryAttempt":{"type":"integer","format":"int32","default":1},"plexoClientReference":{"type":"string","nullable":true},"ticket":{"type":"string","nullable":true},"type":{"default":1,"oneOf":[{"$ref":"#/components/schemas/TransactionType"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItemId":{"type":"string","format":"guid","nullable":true},"transactionRequestItem":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestItem"}]},"subscriptionId":{"type":"string","format":"guid","nullable":true},"subscription":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscription"}]},"instrumentId":{"type":"string","format":"guid","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Instrument"}]},"electronicBillingId":{"type":"integer","format":"int32","nullable":true},"electronicBilling":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ElectronicBill"}]}}}]},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionType":{"type":"integer","description":"","enum":[1,2]},"TransactionRequestItem":{"type":"object","additionalProperties":false,"required":["amount","currency","paymentRequestItemStatus","transactionRequestFileId","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"amount":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"paymentRequestItemStatus":{"$ref":"#/components/schemas/PaymentRequestItemStatus"},"transactionRequestFileId":{"type":"string","format":"guid","minLength":1},"transactionRequestFile":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestFile"}]},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"jobId":{"type":"string","nullable":true}}},"PaymentRequestItemStatus":{"type":"integer","description":"","enum":[1,2,3]},"TransactionRequestFile":{"type":"object","additionalProperties":false,"required":["name","url","clientId"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"url":{"type":"string","maxLength":200,"minLength":1},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItems":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionRequestItem"}},"date":{"type":"string","format":"date-time"}}},"ElectronicBill":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["internalId","caeNumber","series","number"],"properties":{"id":{"type":"integer","format":"int32"},"internalId":{"type":"integer","format":"int32"},"caeNumber":{"type":"string","minLength":1},"series":{"type":"string","minLength":1},"number":{"type":"integer","format":"int32"}}}]},"ErrorResponse":{"type":"object","additionalProperties":false,"properties":{"code":{"$ref":"#/components/schemas/HttpStatusCode"},"message":{"type":"string","nullable":true},"subCode":{"type":"integer","format":"int32"}}},"HttpStatusCode":{"type":"integer","description":"包含針對 HTTP 所定義的狀態碼值。","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,300,301,301,302,302,303,303,304,305,306,307,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511]}}}}
```
# Principales Conceptos de la Plataforma
A lo largo de este documento se utilizan una serie de términos clave. Esta sección los explica para que puedas comprender mejor el funcionamiento general del sistema.
***
### 👤 Cliente
[Cliente](/suscripciones/introduccion-1/principales-conceptos-de-la-plataforma/cliente)
***
### 🏦 Issuer
Un **issuer** es un proveedor de medios de pago, como por ejemplo:
* VISA
* OCA
* MasterCard
Es la entidad que autoriza los pagos realizados con tarjetas u otros instrumentos financieros.
***
### 💳 Débitos Automáticos
Permiten realizar **cobros puntuales** cargando un archivo `.csv` que contiene:
* El monto a cobrar
* El `ExternalId` del suscriptor
> ⚠️ Este tipo de cobro **no está asociado a ninguna suscripción** ni crea una nueva suscripción.
#### 💡 Uso combinado con links de suscriptor
Cuando se usa junto con los **links de suscriptor**, es posible:
* Registrar clientes
* Cobrarles con la periodicidad que desees
* Sin necesidad de una integración directa vía API
***
### 🏬 Comercios
Es la relación que existe entre un **cliente** y los diferentes **issuers** con los que desea operar.
* Cada cliente debe **crear un comercio** en el sistema para cada issuer que quiera ofrecer.
* Para crear un comercio, se deben ingresar datos proporcionados por el issuer, como:
* Código de comercio
* Número de terminal
***
### 💰 Medios de Pago
Para poder pagar una suscripción, el suscriptor debe tener registrado un **medio de pago** a su nombre en un issuer vinculado al comercio del cliente.
* Ejemplos: tarjeta de crédito, débito, cuenta bancaria
* El medio de pago puede ser actualizado o cambiado.
***
### 🔁 Transacción
Cada vez que el sistema realiza un cobro, se genera una **transacción**.
* Las transacciones se crean mientras la suscripción esté activa.
* También se generan transacciones para los **débitos automáticos**.
* El cliente puede acceder a un **historial de transacciones** desde el panel correspondiente.
***
### 🔄 RedirectUrl
Por seguridad, algunos datos sensibles (como números de tarjeta) se deben ingresar en una página segura de Plexo.
* Después de ingresar los datos, esa página redirige al usuario a una URL definida por el cliente, llamada **RedirectUrl**.
* Esto permite mantener la privacidad y cumplir con estándares de seguridad.
***
# Cliente
### ¿Qué es un Cliente?
Un **Cliente** es una empresa que se integra al sistema con el objetivo de ofrecer a sus propios usuarios la posibilidad de **suscribirse** y realizar **pagos automáticos** a través del módulo de suscripciones.
***
### 🔧 ¿Quién crea al cliente?
La creación del cliente en el sistema es realizada por el equipo de **Plexo**.\
Una vez configurado, se le proporciona toda la información necesaria para comenzar a operar.
***
### 🆔 Identificación del Cliente
Para que el sistema pueda reconocer y validar a un cliente, se utilizan **dos credenciales clave**:
| Credencial | Descripción |
| -------------- | ------------------------------------------------------------------------------- |
| `ClientId` | Identificador único y **fijo** que distingue al cliente dentro del sistema. |
| `ClientSecret` | Clave secreta que puede ser **regenerada en cualquier momento** por el cliente. |
> 🔒 El `ClientSecret` funciona como una contraseña y debe mantenerse en un entorno seguro.
***
### ✅ Resumen
* Un cliente es quien utiliza el módulo para ofrecer suscripciones.
* Plexo configura al cliente en el sistema y le proporciona sus credenciales.
* El `ClientId` no cambia; el `ClientSecret` puede regenerarse cuando sea necesario.
***
# Tipos de Suscripción
### ¿Qué son los Tipos de Suscripción?
Los **Tipos de Suscripción** son configuraciones que el cliente crea para definir cómo funcionarán los planes de pago que ofrecerá a sus usuarios.
Cada tipo de suscripción incluye información esencial como:
* Frecuencia de cobro
* Costo
* Moneda
* Duración del plan
***
### 🔧 ¿Qué se puede personalizar?
El cliente puede definir distintos tipos de suscripción que varían en los siguientes aspectos:
| Atributo | Descripción |
| ---------------------- | --------------------------------------------------------------------------- |
| **Frecuencia de pago** | Diaria, semanal, mensual, bimensual, trimestral, anual, etc. |
| **Costo** | Monto total a cobrar al suscriptor. |
| **Nombre** | Ejemplo: `Suscripción Platino Mensual`. |
| **Moneda** | Puede ser en **Pesos** o **Dólares**. |
| **Cantidad de ciclos** | Cuántas veces debe cobrarse antes de finalizar la suscripción. Ej: 6 meses. |
***
### ⚠️ Importante
> Para operar en el sistema es **obligatorio** contar con al menos **un tipo de suscripción creado**.\
> Sin esto, no se podrán generar links, suscriptores ni iniciar cobros.
***
### 📝 Ejemplo
Un cliente podría crear los siguientes tipos:
* `Plan Básico Mensual` → frecuencia mensual, $500, sin límite de ciclos.
* `Plan Anual` → frecuencia anual, $5000, duración: 1 ciclo.
* `Suscripción Premium Trimestral` → frecuencia trimestral, USD 75, duración: 4 ciclos.
***
# Suscriptores
##
### ¿Qué es un Suscriptor?
Un **suscriptor** es un usuario que se registra y se asocia a uno de los **Tipos de Suscripción** configurados por el cliente.\
Estos usuarios son quienes efectivamente acceden a los servicios mediante pagos recurrentes.
***
### 🆔 Identificación del suscriptor
Cada suscriptor debe contar con un **identificador único**, llamado `ExternalId`, que lo distingue dentro del sistema del cliente.
* Este `ExternalId` es proporcionado por el sistema del cliente al momento de registrar al usuario.
* Es clave para gestionar, buscar y mantener actualizada la relación entre el cliente y el suscriptor.
***
### 🔗 Link de suscriptor
El **link de suscriptor** es una herramienta que permite:
* Registrar un nuevo suscriptor cargando datos básicos.
* Solicitar al usuario que ingrese su método de pago (ejemplo: tarjeta).
* Activar la suscripción si se seleccionó un plan durante la generación del link.
> ✅ También puede ser utilizado para **reemplazar el medio de pago** de un suscriptor existente.
***
### 🔄 ¿Qué pasa si el link no se completa?
Si el usuario no termina el proceso (por ejemplo, no agrega su medio de pago), el suscriptor queda registrado en estado **pendiente** y el link puede reutilizarse hasta que se complete.
***
### ✅ Resumen
* Los suscriptores son los usuarios finales que pagan por el servicio.
* Deben tener un `ExternalId` único.
* Se registran a través de un link de suscriptor que asocia su identidad y método de pago.
***
# Suscripción
## 🧾 Suscripción
### ¿Qué es una Suscripción?
Una **suscripción** se genera cuando un usuario (suscriptor) se une a uno de los **Tipos de Suscripción** configurados por el cliente.\
Es el vínculo que activa la relación comercial entre el usuario y el servicio ofrecido.
***
### 🔍 Características de una suscripción
Cada suscripción tiene los siguientes elementos clave:
| Atributo | Descripción |
| ----------------------- | -------------------------------------------------------------------- |
| **Identificador** | Código único que permite distinguirla en el sistema. |
| **Tipo de Suscripción** | Define la frecuencia, costo y moneda del plan seleccionado. |
| **Estado (status)** | Puede ser Activa, Cancelada,Inactivo. |
| **Período de validez** | Intervalo de tiempo durante el cual la suscripción permanece activa. |
***
### 📆 ¿Cómo se activa?
Una suscripción puede activarse:
* Automáticamente, cuando el cliente completa el link de suscriptor e ingresa un método de pago.
* Manualmente, desde el Backoffice, asignándola a un suscriptor registrado.
* Mediante integración por API, si el cliente lo gestiona desde su sistema.
***
### 🔄 Relación con pagos
Mientras una suscripción esté activa y vigente, el sistema generará **transacciones automáticas** en función de su configuración.
***
### ✅ Resumen
* Una suscripción une a un suscriptor con un tipo de plan.
* Tiene identificador, estado y fechas de vigencia.
* Genera cobros automáticos según su configuración.
***
# Estados
### 📘 ¿Qué son los **estados** de una suscripción?
Los **estados** representan el **ciclo de vida y situación actual** de una suscripción dentro del sistema. Cada estado indica si la suscripción está activa, en inactivo, con UserDeactivated o cancelada, y permite que el sistema y los operadores tomen decisiones correctas sobre qué acciones permitir o restringir.
***
#### ¿Por qué existen los estados?
* Para reflejar el **resultado de procesos automáticos** (como pagos, renovaciones o cancelaciones).
* Para que el sistema sepa **qué hacer con una suscripción** en su estado actual (ej.: ¿puede renovarse? ¿debe detenerse?).
* Para que los equipos técnicos y comerciales puedan **interpretar claramente la situación de cada cliente**.
***
#### ⚠️ Advertencia importante
> El estado de una suscripción **no es un simple indicador visual**, sino una condición lógica que **determina el comportamiento automático del sistema**: si puede renovarse, facturarse, reactivarse o si ya no puede utilizarse.
***
#### Estados disponibles
| **Estado** | **Descripción funcional** |
| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 🟢 `Activo` | La suscripción está operativa y con pagos al día. Es válida y funcional. |
| ⚪ `Inactivo` | No tiene pagos vigentes, falló el cobro inicial o se agotaron los intentos de renovación. Se encuentra "en pausa" con posibilidad a reactivarse al cambiar el instrumento. |
| 🟠 `RenovationFailing` | Falló un intento de renovación, pero aún quedan reintentos programados (1m, 1h, 12h). |
| 🔴 `UserDeactivated` | El sistema no puede continuar porque la suscripción fue cancelada o hay una condición inválida (tipo inexistente, etc.). |
| 🚫 `Cancelado` | La suscripción fue finalizada manual o vía API. No se permiten más acciones sobre ella excepto reactivarla. |
# Cancelado
(StateSubcription =3)
### 🚫 Estado: **Cancelado**
El estado **Cancelado** indica que la suscripción fue **finalizada de forma explícita**, ya sea por acción del usuario, del sistema vía API, o por una lógica de reemplazo.\
Una vez en este estado, la suscripción **no puede volver a ser utilizada ni reactivada**.
***
#### ¿Cuándo una suscripción pasa a estado Cancelado?
Una suscripción se marca como **Cancelado** en los siguientes casos:
* El cliente o el sistema realiza una **cancelación manual** usando el endpoint:
```
swiftCopiarEditarPOST /api/subscriptors/cancel/{subscriptionToken}
```
* Se utiliza la estrategia **CancelAndReplace**, que elimina suscripciones existentes de un mismo tipo al crear una nueva.
* Se cancela una suscripción sin revertir el último pago (usando el parámetro `CancelLastPayment: false`).
* Se marca explícitamente desde el panel o backend como finalizada.
***
#### ⚠️ Advertencia importante
> Una suscripción en estado **Cancelado no puede ser reactivada**, ni siquiera mediante `/force` o cambio de tarjeta.\
> En su lugar, debe **crearse una nueva suscripción** si se desea continuar el servicio.
***
#### Comportamiento en estado Cancelado
* El sistema **no intentará más cobros ni renovaciones**.
* No se pueden realizar acciones sobre ella, como cambios de instrumento o reintentos.
* Se considera un estado **terminal**.
* Sirve para **auditoría o historial**, pero no para uso operativo.
***
#### Posibles transiciones hacia Cancelado
| Evento | Notas |
| ---------------------------------------------------------- | --------------------------------------------------------------- |
| Cancelación manual vía API (`/cancel/{subscriptionToken}`) | Puede o no revertir el último pago, según el parámetro recibido |
| Reemplazo de suscripción (`CancelAndReplace`) | Se eliminan suscripciones activas o existentes del mismo tipo |
| Cancelación desde el backend o panel | Marcada explícitamente como cancelada por operador o sistema |
***
#### Relación con otros estados
| Desde → Cancelado | Cómo llegó |
| ------------------- | -------------------------------------------------------------------------- |
| `Activo` | Cancelación manual vía API o desde sistema |
| `Inactivo` | Cancelación directa posterior a fallos o falta de uso |
| `RenovationFailing` | Cancelación mientras está en proceso de reintento |
| `UserDeactivated` | Puede marcarse como cancelada luego de un fallo estructural no recuperable |
\| Cancelado → (Ninguno) | **Estado final**. No hay retorno posible. |
# Activo
(StateSubcription =0)
### 🟢 Estado: **Activo**
Una suscripción se encuentra en estado **Activo** cuando está operativa, con pagos al día y en condiciones de recibir los servicios o productos correspondientes. Es el estado principal de una suscripción vigente.
***
#### ¿Cuándo entra una suscripción en estado Activo?
La suscripción pasa a **Activo** cuando ocurre un **pago exitoso**, ya sea:
* **Inicial**, al momento de crear la suscripción.
* **Forzado**, usando el endpoint `POST /api/subscriptors/force/{subscriptionToken}`.
* **De renovación automática**, siempre que se logre ejecutar correctamente el cobro.
* **Por reactivación**, como resultado de una actualización del medio de pago (por ejemplo, cambio de tarjeta).
Al activarse, el sistema actualiza automáticamente la **fecha del último pago** y genera el **schedule** para la siguiente renovación (si aplica).
***
#### ¿Qué ocurre mientras está en estado Activo?
* La suscripción está **funcionando correctamente** y se considera **vigente**.
* Permanece en este estado **hasta que llegue el momento de la próxima renovación**.
* En ese momento, el sistema intentará un nuevo cobro:
* Si el cobro **es exitoso**, la suscripción **permanece en Activo**.
#### 📌 Posibles transiciones desde el estado **Activo**
| **Evento** | **Nuevo Estado** | **Notas** |
| ------------------------------------------------- | ------------------- | ---------------------------------------------------------------------------- |
| Cancelación manual vía API | `Cancelado` | Utilizando el endpoint `/cancel/{subscriptionToken}` |
| Fallo en la renovación con reintentos disponibles | `RenovationFailing` | Se programan nuevos intentos: 1 min, 1 h, 12 h |
| Fin del ciclo de recurrencias configuradas | `Inactivo` | La suscripción alcanzó el límite de pagos definidos en el campo `Recurrence` |
| Desactivación del tipo de suscripción asociado | `Inactivo` | El `SubscriptionType` fue marcado como inactivo o no disponible |
# Renovación Fallida
(StateSubcription =1)
### 🟠 Estado: **RenovationFailing**
El estado **RenovationFailing** indica que el sistema **intentó renovar una suscripción activa**, pero **el intento de cobro falló**. Sin embargo, la suscripción aún **tiene reintentos pendientes programados**, por lo que **no se considera Inactiva**.
***
#### ¿Cuándo una suscripción pasa a estado RenovationFailing?
Una suscripción cambia a **RenovationFailing** cuando:
* El sistema intenta realizar un cobro de renovación automática.
* El intento de pago falla (por ejemplo, rechazo de la tarjeta o problema con el instrumento de pago).
* Existen **reintentos de cobro pendientes**, definidos por la lógica del sistema (1 minuto, 1 hora, 12 horas, etc.).
***
#### ⚠️ Advertencia importante
> Durante el estado **RenovationFailing**, la suscripción **sigue siendo técnicamente válida**, pero su continuidad está pendiente de que **alguno de los reintentos programados resulte exitoso**.\
> Si todos los reintentos fallan, la suscripción pasará automáticamente a **Inactivo**.
***
#### Comportamiento en estado RenovationFailing
* El sistema **programa múltiples intentos automáticos de cobro**.
* La suscripción **no se renueva todavía**, pero **tampoco se corta el acceso de inmediato**.
* Se considera una **fase de gracia temporal** hasta que se resuelva el pago o se agoten los reintentos.
***
#### Posibles transiciones desde RenovationFailing
| Evento | Nuevo Estado | Notas |
| --------------------------------------------------- | -------------- | --------------------------------------------------------------------------- |
| Reintento exitoso de cobro | `Activo` | Se completa la renovación y se restablece el ciclo |
| Se agotan todos los reintentos sin éxito | `Inactivo` | El sistema marca la suscripción como no renovada |
| La suscripción fue cancelada manualmente | `Cancelado` | Se invoca `/cancel/{subscriptionToken}` durante la fase de reintentos |
| El tipo de suscripción queda inválido o desactivado | — (sin cambio) | No se renueva; permanece en el estado hasta agotar intentos o ser cancelada |
***
#### Relación con otros estados
| Desde → RenovationFailing | Cómo llegó |
| ------------------------- | ------------------------------------------------------- |
| `Activo` | Fallo de cobro en la renovación con intentos pendientes |
| RenovationFailing → Hacia | Condición |
| ------------------------- | --------------------------------------------- |
| `Activo` | Reintento exitoso |
| `Inactivo` | Se agotan reintentos sin éxito |
| `Cancelado` | Cancelación manual mientras está en reintento |
# Inactivo
(StateSubcription =2)
### ⚪ Estado: **Inactivo**
El estado **Inactivo** indica que la suscripción no está operativa actualmente, ya sea porque **no logró completarse un pago**, **se agotaron los intentos automáticos**, o **finalizó su ciclo de pagos**.
***
#### ¿Cuándo una suscripción pasa a estado Inactivo?
Una suscripción cambia a **Inactivo** en los siguientes escenarios:
* **Fallo en el pago inicial al crear la suscripción**, sin éxito ni medios válidos para cobrar.
* **Fallo en la renovación automática** y **se agotaron todos los reintentos configurados**.
* Se alcanzó el **límite de recurrencias** definido (por ejemplo, una suscripción con 12 ciclos mensuales).
* Si el tipo de suscripción (`SubscriptionType`) está desactivado o no disponible, la renovación no puede completarse y la suscripción **mantiene el estado que tenía** (no se reactiva).
***
#### ⚠️ Advertencia importante
> Una suscripción en estado **Inactivo puede reactivarse automáticamente** si el cliente **actualiza su medio de pago** y se logra procesar correctamente la transacción pendiente.\
> Esta reactivación no requiere intervención manual si el sistema detecta condiciones válidas para cobrar.
***
#### Comportamiento en estado Inactivo
* La suscripción **no realiza renovaciones ni cobros automáticos**.
* Permanece en este estado **hasta que se cumpla alguna condición para reactivarse**.
* No se considera una suscripción cancelada, sino **en pausa o sin condiciones activas de facturación**.
***
#### Posibles transiciones desde Inactivo
| Evento | Nuevo Estado | Notas |
| ------------------------------------------------------------------- | -------------- | ------------------------------------------------------------------ |
| Se realiza un pago exitoso mediante `/force` | `Activo` | Reactivación manual; también puede lograrse tras cambio de tarjeta |
| Cobro exitoso luego de actualizar medio de pago | `Activo` | Se revive automáticamente si la transacción pendiente se resuelve |
| Intento de renovación pero el `SubscriptionType` no está disponible | — (sin cambio) | La suscripción conserva su estado |
| No hay reintentos ni recurrencias restantes | — (sin cambio) | La suscripción permanece inactiva sin posibilidad de recuperación |
***
#### Relación con otros estados
| Desde → Inactivo | Cómo llegó |
| ------------------- | ---------------------------------------------------------------------- |
| `Activo` | Por fallo de renovación sin reintentos o fin del ciclo de recurrencias |
| `RenovationFailing` | Por agotamiento de los reintentos sin lograr el cobro |
| `Creación` | Si el pago inicial falla y no se puede forzar el cobro |
# UserDeactivated(Fallida)
(StateSubcription =4)
### 🔴 Estado: **UserDeactivated** (`"Fallida"`)
El estado **UserDeactivated** indica que el sistema **intentó renovar o ejecutar un cobro**, pero la suscripción **ya no estaba en condiciones de continuar** (por ejemplo, había sido cancelada previamente o el tipo era inválido al momento del intento).\
Es un estado de **fallo técnico o lógico**, no una cancelación explícita del usuario.
***
#### ¿Cuándo una suscripción pasa a estado UserDeactivated?
Una suscripción se marca como **UserDeactivated** cuando:
* El sistema intenta renovar o ejecutar un cobro, y detecta que:
* La suscripción fue **cancelada antes del intento**.
* El tipo de suscripción (`SubscriptionType`) **ya no está disponible o es inválido**.
* El proceso de cobro **falla por una inconsistencia lógica**, como falta de datos, configuración incorrecta o condiciones contractuales inválidas.
> Este estado se utiliza para **detener el ciclo de renovación o cobro**, registrando que el proceso falló no por rechazo del pago, sino por una **condición no recuperable** en la suscripción.
***
#### ⚠️ Advertencia importante
> El estado **UserDeactivated no implica que el usuario haya cancelado manualmente**.\
> Es asignado automáticamente por el sistema cuando **el cobro no puede ejecutarse** por motivos estructurales, contractuales o de configuración de la suscripción.
***
#### Comportamiento en estado UserDeactivated
* La suscripción **no puede continuar su ciclo**, ni ejecutar cobros automáticos.
* No hay reintentos posteriores.
* El sistema **no programa nuevas acciones** hasta que se intervenga manualmente (por ejemplo, con `/force` o reemplazo de suscripción).
* Se considera un estado de **fallo terminal**, salvo que se reactive de forma controlada.
***
#### Posibles transiciones desde UserDeactivated
| Evento | Nuevo Estado | Notas |
| -------------------------------------------------------- | -------------- | ----------------------------------------------------------------------- |
| Se actualiza el instrumento de pago y se fuerza el cobro | `Activo` | Usando `/force`, si las condiciones contractuales vuelven a ser válidas |
| Se genera una nueva suscripción (CancelAndReplace) | `Cancelado` | La suscripción original puede marcarse como cancelada posteriormente |
| No se realiza ninguna acción | — (sin cambio) | La suscripción queda en este estado de forma indefinida |
***
#### Relación con otros estados
| Desde → UserDeactivated | Cómo llegó |
| ------------------------------ | ---------------------------------------------------------------------------- |
| `Activo` o `RenovationFailing` | Se intentó renovar o cobrar, pero la suscripción estaba cancelada o inválida |
| `Inactivo` | Se forzó un pago sin condiciones válidas para ejecutarlo |
| UserDeactivated → Hacia | Condición |
| ----------------------- | -------------------------------------------------------------- |
| `Activo` | Se fuerza un nuevo pago exitoso tras corregir condiciones |
| `Cancelado` | El sistema o el usuario termina la suscripción definitivamente |
# 📝 Alta de nueva Empresa
Para dar de alta un nuevo cliente en el sistema, es necesario dirigirse al equipo **Comercial** y proporcionar la siguiente información:
* **Nombre** del cliente
* **RUT o CFDI** (según país)
* **Nombre legal** de la empresa o persona jurídica
* **Tasa de IVA** aplicable (por ejemplo: 0%, 10%, 22%)
* **URL para notificaciones** (si aplica, para recibir eventos vía webhook)
> Esta información es requerida para registrar correctamente al cliente y habilitar su operación dentro de la plataforma.
# Diagramas de Flujos
# Flujo de Creación de Suscripciones
# Renovación
Flujo de Renovación automática la misma es algo interno dentro de plexo
# Forzado de pago
# Cambio de Tipo de Suscripción
# Cancelacion
# Obtener Suscripciones
# Crear Suscripciones
# Esquema de Reintentos
# Ciclo de vida de la suscripcion
# Testing
Portal de Testing
{% embed url="" %}
Api Testing
# Tarjetas de prueba
### Reglas de simulación de respuestas por método y PAN
El sistema devuelve distintos resultados dependiendo del **método de operación** (`cancel`, `refund`, `purchase`, `reserve`, `commit`) y del **PAN** (número de tarjeta).
#### 1. Cancelaciones (`cancel`)
* **VISA**
* `4104292194302238` → `denied`
* `4548834887946849` → `exception`
* **SODEXO**
* `5058646599260130` → `denied`
* **TARJETA-D**
* `6018287227431046` → `denied`
* **ANDA**
* `6031998427187914` → `denied`
* **Otros PAN** → `approved`
***
#### 2. Reembolsos (`refund`)
* **ANDA**
* `6031997614492616` → `denied`
* **SODEXO**
* `5058647731868699` → `denied`
* **VISA**
* `4456530000001096` → `exception`
* `4104291542123320` → `denied`
* **Otros PAN** → `approved`
***
#### 3. Compras y Reservas (`purchase` o `reserve`)
* **SODEXO**
* `5058645584812145` → `approved`
* `5058647731868699` → `approved` (pero `refund` → `denied`)
* `5058646599260130` → `approved` (pero `cancel` → `denied`)
* **TARJETA-D**
* `6018282227431033` → `denied`
* `6018284227431049` → `approved`
* `6018287227431046` → `approved`
* **ANDA**
* `6031991248204901` → `approved`
* `6031997614492616` → `approved` (pero `refund` → `denied`)
* `6031998427187914` → `approved` (pero `cancel` → `denied`)
* `6031996189881443` → `denied`
* **EDENRED**
* `6374830000000823` → `approved`
* **PASSCARD**
* `6280260025383009` → `approved`
* **MASTERCARD**
* `5555555555554445` → `denied`
* `5105105105105100` → `denied`
* `5555555555554446` → `pending`
* `5555555555554447` → `pending`
* **OCA**
* `5429910247872511` → `denied`
* `5429910247872512` → `pending`
* `5429910247872513` → `pending`
* **VISA**
* `4556761029983886` → `pending`
* `4242424242424242` → `exception`
* `4213000010064264` → `noFunds`
* `4929635100275653` → `noFunds`
* `4111111111111111` → `denied`
* `4551751059354004` → `denied`
* `4444333322221112` → `denied`
* `4012888888881881` → `denied`
* `4917610000000000003` → `denied`
* `4024007101934890` → `denied`
***
#### 4. Confirmaciones (`commit`)
* **VISA**
* `4929283162469482` → `denied`
* `4222222222222225` → `denied`
* **MASTERCARD**
* `5322530906678806` → `denied`
* **Otros PAN** → `approved`
***
#### 5. Valor por defecto
Si el PAN no coincide en ninguno de los listados anteriores, el sistema devuelve siempre:\
→ `approved`
# Producción
Portal
Api
# Agosto 2025
# 🔄 Cambio Opcional de Pago al Cambiar Instrumento
### 📌 ¿Qué ocurre normalmente?
En el comportamiento por defecto del sistema, cuando un suscriptor **cambia su instrumento de pago** (por ejemplo, actualiza su tarjeta), ocurre lo siguiente:
1. Si la suscripción estaba **inactiva**, se **reactiva automáticamente**.
2. Se genera un **cobro inmediato** usando el nuevo instrumento.
***
### ⚙️ ¿Qué cambió?
Ahora es posible **desactivar esta funcionalidad automática**, para que:
* El cambio de instrumento **no reactive** la suscripción.
* **No se genere un cobro automático** al hacer el cambio.
Esta opción fue agregada porque algunos clientes prefieren manejar manualmente el cobro después del cambio, según sus propios procesos de control.
***
### 🛠️ ¿Cómo se desactiva esta opción?
Para deshabilitar el cobro automático al cambiar instrumento:
* Debés **notificar al equipo de soporte de Plexo**.
* Ellos aplicarán la configuración específica a tu cuenta.
***
### ✅ Resumen
| Acción | Comportamiento por defecto | Comportamiento opcional |
| ----------------------------- | ----------------------------- | --------------------------- |
| Cambio de instrumento | Reactiva suscripción inactiva | No reactiva automáticamente |
| | Genera un cobro inmediato | No genera cobro |
| Requiere configuración manual | ❌ | ✅ Contactar a soporte |
***
# 🔁 Cambios en Callbacks
A continuación se detallan los **cambios aplicados a todos los callbacks** del sistema, con el fin de estandarizar su estructura y facilitar el manejo de eventos por parte del cliente.
***
### 🆕 Estructura General del Callback
Todos los callbacks ahora comparten una estructura común que incluye los siguientes campos:
```csharp
public class NotificationDto
{
public NotificationType NotificationType { get; set; } // Tipo de evento
public string SubscriptionId { get; set; } // ID de la suscripción involucrada
public string TransactionID { get; set; } // ID de la transacción (si aplica)
public bool Result { get; set; } // Indica si la operación fue exitosa
public string ErrorString { get; set; } // Mensaje de error en caso de fallo
}
```
***
### 📌 Campo: `NotificationType`
Este campo permite **distinguir el tipo de callback recibido**, facilitando el manejo de cada caso desde el backend del cliente.
```csharp
public enum NotificationType
{
PaymentFailure = 0, // Pago fallido
TransactionCancellation, // Cancelación de transacción
SubscriptionCancellation, // Cancelación de suscripción
RecurringPayment, // Renovación/pago recurrente
SubscriptorData, // Datos del suscriptor
InstrumentRegistration // Nuevo - Registro de instrumento (desde 13/08)
}
```
***
### 🆕 Nuevo Tipo: `InstrumentRegistration`
Se agrega un nuevo valor en el enumerado `NotificationType`:
* `InstrumentRegistration`: identifica que el callback se origina por el **registro de un instrumento de pago** (tarjeta o similar).
***
### ✅ Campo: `Result`
El campo `Result` indica si la operación fue **exitosa o fallida**.\
En caso de error, el campo `ErrorString` incluirá una descripción del motivo del fallo.
***
### 📝 Resumen
| Campo | Descripción |
| ------------------ | ---------------------------------------------------- |
| `NotificationType` | Enum con tipo de evento recibido. |
| `SubscriptionId` | ID de la suscripción (si corresponde). |
| `TransactionID` | ID de la transacción asociada. |
| `Result` | `true` si fue exitoso, `false` si falló. |
| `ErrorString` | Mensaje con detalle del error (si `Result = false`). |
***
### 🆕 Compatibilidad
Estos cambios son compatibles con los callbacks existentes y permiten ampliar la lógica de manejo de eventos sin romper integraciones previas.
***
# Septiembre 2025
# Octubre 2025
Fix de Debito Automatico
# EndPoint
# Cuenta
Endpoints para obtener y gestionar datos de la cuenta de usuario.
## Obtener cuenta
> Devuelve la información de la cuenta del usuario autenticado.
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Cuenta","description":"Endpoints para obtener y gestionar datos de la cuenta de usuario."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Account":{"get":{"tags":["Cuenta"],"summary":"Obtener cuenta","description":"Devuelve la información de la cuenta del usuario autenticado.","operationId":"Cuenta_Obtener","responses":{"200":{"description":"Éxito","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountStrings"}}}},"400":{"description":"Solicitud incorrecta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"components":{"schemas":{"AccountStrings":{"type":"object","additionalProperties":false,"properties":{"recurringPaymentCallback":{"type":"string","nullable":true}}},"ErrorResponse":{"type":"object","additionalProperties":false,"properties":{"code":{"$ref":"#/components/schemas/HttpStatusCode"},"message":{"type":"string","nullable":true},"subCode":{"type":"integer","format":"int32"}}},"HttpStatusCode":{"type":"integer","description":"包含針對 HTTP 所定義的狀態碼值。","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,300,301,301,302,302,303,303,304,305,306,307,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511]}}}}
```
# Comercios
Endpoints para gestionar comercios asociados a un cliente.
## Listar comercios
> Obtiene los comercios asociados al cliente (Admin o credenciales del cliente).
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Comercios","description":"Endpoints para gestionar comercios asociados a un cliente."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Commerces":{"get":{"tags":["Comercios"],"summary":"Listar comercios","description":"Obtiene los comercios asociados al cliente (Admin o credenciales del cliente).","operationId":"Comercios_Listar","parameters":[{"name":"clientId","in":"header","schema":{"type":"string","nullable":true}},{"name":"clientSecret","in":"header","schema":{"type":"string","nullable":true}}],"responses":{"200":{"description":"Éxito","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CommerceDto"}}}}},"204":{"description":"Sin contenido"},"404":{"description":"Credenciales incorrectas"}}}}},"components":{"schemas":{"CommerceDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"issuer":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/IssuerDto"}]},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"fields":{"type":"object","nullable":true,"additionalProperties":{"type":"string"}}}},"IssuerDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"issuerImageUrl":{"type":"string","nullable":true},"fields":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FieldInfo"}}}},"FieldInfo":{"type":"object","additionalProperties":false,"properties":{"labelName":{"type":"string","nullable":true},"fieldType":{"$ref":"#/components/schemas/FieldType"},"required":{"type":"boolean"}}},"FieldType":{"type":"integer","description":"","enum":[257,258,259,260,261,262,263,264,265,266,267,268,269,270,271,272,273,274,513,514,515,516,517,518,519,520,521,522,523,524,525,526,527,528,529,530,531,532,533,534,535,1025,1281,1282,1283,1284,1285,1286,1287,1288,1289,1296,1297,1298,2049,2050,2051,2052,2053,2054,2055,2056,2057,2058,2059,2060,2061,2062,2063,2064,2065,2066,2067,2068,2069,2070,2071,2072,2073,2074,2075,2076,2077,2078,2079,2080,2081,2082,2083,2084,2085,2305,2306,2307,2308,2309,2310,2311,2312,2313,2320,33025,33026,33027,33028,33153,33154]},"ClientDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","nullable":true},"legalName":{"type":"string","nullable":true},"legalId":{"type":"string","nullable":true},"recurringPaymentUrl":{"type":"string","nullable":true},"plexoCommerceId":{"type":"integer","format":"int32"},"taxPercentage":{"type":"number","format":"decimal"},"admin":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ClientAdmin"}},"subscriptionTypesDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionTypeDto"}},"commercesDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/CommerceDto"}},"subscriptorsDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptorDto"}},"retriesConfiguration":{"$ref":"#/components/schemas/RetriesConfigurationEnum"},"notificationPermissionsDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NotificationPermissionsDto"}]}}},"ClientAdmin":{"type":"object","additionalProperties":false,"properties":{"userId":{"type":"string","nullable":true},"userName":{"type":"string","nullable":true},"clientId":{"type":"string","format":"guid"}}},"SubscriptionTypeDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"frequence":{"$ref":"#/components/schemas/Frequence"},"subscriptionBaseCost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"recurrence":{"type":"integer","format":"int32"},"regularType":{"type":"boolean"},"taxPercentage":{"type":"string","nullable":true}}},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"SubscriptorDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"fullName":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionDto"}},"firstSubscribed":{"type":"string","format":"date-time","nullable":true},"links":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LinkDto"}}}},"InstrumentDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"expiration":{"type":"string","format":"date-time"},"issuerImageUrl":{"type":"string","nullable":true},"issuerName":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"token":{"type":"string","format":"guid","nullable":true},"plexoExtendedResponse":{"type":"string","nullable":true},"optionalUniqueID":{"type":"string","nullable":true}}},"SubscriptionDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"token":{"type":"string","nullable":true},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"subscriptionDate":{"type":"string","format":"date-time"},"subscriptionStatus":{"$ref":"#/components/schemas/SubscriptionStatus"},"subscriptionLastPaymentDate":{"type":"string","format":"date-time"},"validUntil":{"type":"string","format":"date-time"},"remainingRecurrences":{"type":"integer","format":"int32","nullable":true},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionDto"}}}},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"subscriptionDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"amount":{"type":"number","format":"decimal"},"taxAmount":{"type":"number","format":"decimal"},"taxedAmount":{"type":"number","format":"decimal"},"createdAt":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/TransactionStatus"},"currency":{"$ref":"#/components/schemas/Currency"},"instrumentDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentDto"}]},"subscriptorDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"subscriptionTypeDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"transactionItemDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionItemDto"}]},"authorization":{"type":"string","nullable":true},"errorText":{"type":"string","nullable":true},"plexoClientReference":{"type":"string","nullable":true},"plexoTransactionId":{"type":"string","nullable":true}}},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionItemDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"amount":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"paymentRequestItemStatus":{"$ref":"#/components/schemas/PaymentRequestItemStatus"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionDto"}}}},"PaymentRequestItemStatus":{"type":"integer","description":"","enum":[1,2,3]},"LinkDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"externalId":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"canUpdateSubscriptorData":{"type":"boolean"},"status":{"$ref":"#/components/schemas/LinkStatusEnum"},"subscriptorDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]}}},"LinkStatusEnum":{"type":"integer","description":"","enum":[1,2,3]},"RetriesConfigurationEnum":{"type":"integer","description":"","enum":[0,1]},"NotificationPermissionsDto":{"type":"object","additionalProperties":false,"properties":{"transactionCancellation":{"type":"boolean"},"subscriptionCancellation":{"type":"boolean"},"subscriptorFields":{"type":"boolean"},"paymentSuccess":{"type":"boolean"},"paymentFailed":{"type":"boolean"}}}}}}
```
## Agregar comercio
> Agrega un comercio al cliente. Solo SuperAdmin / Admin.
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Comercios","description":"Endpoints para gestionar comercios asociados a un cliente."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Commerces":{"post":{"tags":["Comercios"],"summary":"Agregar comercio","description":"Agrega un comercio al cliente. Solo SuperAdmin / Admin.","operationId":"Comercios_Crear","parameters":[{"name":"clientSecret","in":"header","schema":{"type":"string","nullable":true}},{"name":"clientId","in":"header","schema":{"type":"string","nullable":true}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCommerceRequest"}}},"required":true},"responses":{"200":{"description":"Creado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommerceDto"}}}},"400":{"description":"Solicitud incorrecta"},"404":{"description":"Credenciales incorrectas"}}}}},"components":{"schemas":{"AddCommerceRequest":{"type":"object","additionalProperties":false,"properties":{"softDescriptor":{"type":"string","nullable":true},"commerceNumber":{"type":"string","nullable":true},"terminalNumber":{"type":"string","nullable":true},"issuerId":{"type":"integer","format":"int32"},"clientId":{"type":"string","format":"guid"},"availableBanks":{"type":"string","nullable":true},"acquirer":{"type":"string","nullable":true},"accountNumber":{"type":"string","nullable":true},"crossBankTransfers":{"type":"string","nullable":true},"merchantCategoryCode":{"type":"string","nullable":true},"rut":{"type":"string","nullable":true}}},"CommerceDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"issuer":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/IssuerDto"}]},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"fields":{"type":"object","nullable":true,"additionalProperties":{"type":"string"}}}},"IssuerDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"issuerImageUrl":{"type":"string","nullable":true},"fields":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FieldInfo"}}}},"FieldInfo":{"type":"object","additionalProperties":false,"properties":{"labelName":{"type":"string","nullable":true},"fieldType":{"$ref":"#/components/schemas/FieldType"},"required":{"type":"boolean"}}},"FieldType":{"type":"integer","description":"","enum":[257,258,259,260,261,262,263,264,265,266,267,268,269,270,271,272,273,274,513,514,515,516,517,518,519,520,521,522,523,524,525,526,527,528,529,530,531,532,533,534,535,1025,1281,1282,1283,1284,1285,1286,1287,1288,1289,1296,1297,1298,2049,2050,2051,2052,2053,2054,2055,2056,2057,2058,2059,2060,2061,2062,2063,2064,2065,2066,2067,2068,2069,2070,2071,2072,2073,2074,2075,2076,2077,2078,2079,2080,2081,2082,2083,2084,2085,2305,2306,2307,2308,2309,2310,2311,2312,2313,2320,33025,33026,33027,33028,33153,33154]},"ClientDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","nullable":true},"legalName":{"type":"string","nullable":true},"legalId":{"type":"string","nullable":true},"recurringPaymentUrl":{"type":"string","nullable":true},"plexoCommerceId":{"type":"integer","format":"int32"},"taxPercentage":{"type":"number","format":"decimal"},"admin":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ClientAdmin"}},"subscriptionTypesDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionTypeDto"}},"commercesDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/CommerceDto"}},"subscriptorsDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptorDto"}},"retriesConfiguration":{"$ref":"#/components/schemas/RetriesConfigurationEnum"},"notificationPermissionsDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NotificationPermissionsDto"}]}}},"ClientAdmin":{"type":"object","additionalProperties":false,"properties":{"userId":{"type":"string","nullable":true},"userName":{"type":"string","nullable":true},"clientId":{"type":"string","format":"guid"}}},"SubscriptionTypeDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"frequence":{"$ref":"#/components/schemas/Frequence"},"subscriptionBaseCost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"recurrence":{"type":"integer","format":"int32"},"regularType":{"type":"boolean"},"taxPercentage":{"type":"string","nullable":true}}},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"SubscriptorDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"fullName":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionDto"}},"firstSubscribed":{"type":"string","format":"date-time","nullable":true},"links":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LinkDto"}}}},"InstrumentDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"expiration":{"type":"string","format":"date-time"},"issuerImageUrl":{"type":"string","nullable":true},"issuerName":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"token":{"type":"string","format":"guid","nullable":true},"plexoExtendedResponse":{"type":"string","nullable":true},"optionalUniqueID":{"type":"string","nullable":true}}},"SubscriptionDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"token":{"type":"string","nullable":true},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"subscriptionDate":{"type":"string","format":"date-time"},"subscriptionStatus":{"$ref":"#/components/schemas/SubscriptionStatus"},"subscriptionLastPaymentDate":{"type":"string","format":"date-time"},"validUntil":{"type":"string","format":"date-time"},"remainingRecurrences":{"type":"integer","format":"int32","nullable":true},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionDto"}}}},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"subscriptionDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"amount":{"type":"number","format":"decimal"},"taxAmount":{"type":"number","format":"decimal"},"taxedAmount":{"type":"number","format":"decimal"},"createdAt":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/TransactionStatus"},"currency":{"$ref":"#/components/schemas/Currency"},"instrumentDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentDto"}]},"subscriptorDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"subscriptionTypeDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"transactionItemDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionItemDto"}]},"authorization":{"type":"string","nullable":true},"errorText":{"type":"string","nullable":true},"plexoClientReference":{"type":"string","nullable":true},"plexoTransactionId":{"type":"string","nullable":true}}},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionItemDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"amount":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"paymentRequestItemStatus":{"$ref":"#/components/schemas/PaymentRequestItemStatus"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionDto"}}}},"PaymentRequestItemStatus":{"type":"integer","description":"","enum":[1,2,3]},"LinkDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"externalId":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"canUpdateSubscriptorData":{"type":"boolean"},"status":{"$ref":"#/components/schemas/LinkStatusEnum"},"subscriptorDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]}}},"LinkStatusEnum":{"type":"integer","description":"","enum":[1,2,3]},"RetriesConfigurationEnum":{"type":"integer","description":"","enum":[0,1]},"NotificationPermissionsDto":{"type":"object","additionalProperties":false,"properties":{"transactionCancellation":{"type":"boolean"},"subscriptionCancellation":{"type":"boolean"},"subscriptorFields":{"type":"boolean"},"paymentSuccess":{"type":"boolean"},"paymentFailed":{"type":"boolean"}}}}}}
```
## Agregar comercio PF hardcoded
> Agrega un comercio PF (uso interno). Solo SuperAdmin.
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Comercios","description":"Endpoints para gestionar comercios asociados a un cliente."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Commerces/PfHardCoded":{"post":{"tags":["Comercios"],"summary":"Agregar comercio PF hardcoded","description":"Agrega un comercio PF (uso interno). Solo SuperAdmin.","operationId":"Comercios_CrearPF","parameters":[{"name":"clientId","in":"header","schema":{"type":"string","nullable":true}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddPFCommerceRequest"}}},"required":true},"responses":{"200":{"description":"Creado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommerceDto"}}}},"400":{"description":"Solicitud incorrecta"},"404":{"description":"Credenciales incorrectas"}}}}},"components":{"schemas":{"AddPFCommerceRequest":{"type":"object","additionalProperties":false,"properties":{"commerceName":{"type":"string","nullable":true},"commerceNumber":{"type":"string","nullable":true},"commerceTerminalNumber":{"type":"string","nullable":true},"issuerId":{"type":"integer","format":"int32"},"paymentFacilitatorPlexoCommerceId":{"type":"integer","format":"int32","nullable":true},"pfId":{"type":"string","nullable":true}}},"CommerceDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"issuer":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/IssuerDto"}]},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"fields":{"type":"object","nullable":true,"additionalProperties":{"type":"string"}}}},"IssuerDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"issuerImageUrl":{"type":"string","nullable":true},"fields":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FieldInfo"}}}},"FieldInfo":{"type":"object","additionalProperties":false,"properties":{"labelName":{"type":"string","nullable":true},"fieldType":{"$ref":"#/components/schemas/FieldType"},"required":{"type":"boolean"}}},"FieldType":{"type":"integer","description":"","enum":[257,258,259,260,261,262,263,264,265,266,267,268,269,270,271,272,273,274,513,514,515,516,517,518,519,520,521,522,523,524,525,526,527,528,529,530,531,532,533,534,535,1025,1281,1282,1283,1284,1285,1286,1287,1288,1289,1296,1297,1298,2049,2050,2051,2052,2053,2054,2055,2056,2057,2058,2059,2060,2061,2062,2063,2064,2065,2066,2067,2068,2069,2070,2071,2072,2073,2074,2075,2076,2077,2078,2079,2080,2081,2082,2083,2084,2085,2305,2306,2307,2308,2309,2310,2311,2312,2313,2320,33025,33026,33027,33028,33153,33154]},"ClientDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","nullable":true},"legalName":{"type":"string","nullable":true},"legalId":{"type":"string","nullable":true},"recurringPaymentUrl":{"type":"string","nullable":true},"plexoCommerceId":{"type":"integer","format":"int32"},"taxPercentage":{"type":"number","format":"decimal"},"admin":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ClientAdmin"}},"subscriptionTypesDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionTypeDto"}},"commercesDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/CommerceDto"}},"subscriptorsDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptorDto"}},"retriesConfiguration":{"$ref":"#/components/schemas/RetriesConfigurationEnum"},"notificationPermissionsDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NotificationPermissionsDto"}]}}},"ClientAdmin":{"type":"object","additionalProperties":false,"properties":{"userId":{"type":"string","nullable":true},"userName":{"type":"string","nullable":true},"clientId":{"type":"string","format":"guid"}}},"SubscriptionTypeDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"frequence":{"$ref":"#/components/schemas/Frequence"},"subscriptionBaseCost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"recurrence":{"type":"integer","format":"int32"},"regularType":{"type":"boolean"},"taxPercentage":{"type":"string","nullable":true}}},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"SubscriptorDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"fullName":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionDto"}},"firstSubscribed":{"type":"string","format":"date-time","nullable":true},"links":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LinkDto"}}}},"InstrumentDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"expiration":{"type":"string","format":"date-time"},"issuerImageUrl":{"type":"string","nullable":true},"issuerName":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"token":{"type":"string","format":"guid","nullable":true},"plexoExtendedResponse":{"type":"string","nullable":true},"optionalUniqueID":{"type":"string","nullable":true}}},"SubscriptionDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"token":{"type":"string","nullable":true},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"subscriptionDate":{"type":"string","format":"date-time"},"subscriptionStatus":{"$ref":"#/components/schemas/SubscriptionStatus"},"subscriptionLastPaymentDate":{"type":"string","format":"date-time"},"validUntil":{"type":"string","format":"date-time"},"remainingRecurrences":{"type":"integer","format":"int32","nullable":true},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionDto"}}}},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"subscriptionDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"amount":{"type":"number","format":"decimal"},"taxAmount":{"type":"number","format":"decimal"},"taxedAmount":{"type":"number","format":"decimal"},"createdAt":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/TransactionStatus"},"currency":{"$ref":"#/components/schemas/Currency"},"instrumentDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentDto"}]},"subscriptorDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"subscriptionTypeDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"transactionItemDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionItemDto"}]},"authorization":{"type":"string","nullable":true},"errorText":{"type":"string","nullable":true},"plexoClientReference":{"type":"string","nullable":true},"plexoTransactionId":{"type":"string","nullable":true}}},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionItemDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"amount":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"paymentRequestItemStatus":{"$ref":"#/components/schemas/PaymentRequestItemStatus"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionDto"}}}},"PaymentRequestItemStatus":{"type":"integer","description":"","enum":[1,2,3]},"LinkDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"externalId":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"canUpdateSubscriptorData":{"type":"boolean"},"status":{"$ref":"#/components/schemas/LinkStatusEnum"},"subscriptorDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]}}},"LinkStatusEnum":{"type":"integer","description":"","enum":[1,2,3]},"RetriesConfigurationEnum":{"type":"integer","description":"","enum":[0,1]},"NotificationPermissionsDto":{"type":"object","additionalProperties":false,"properties":{"transactionCancellation":{"type":"boolean"},"subscriptionCancellation":{"type":"boolean"},"subscriptorFields":{"type":"boolean"},"paymentSuccess":{"type":"boolean"},"paymentFailed":{"type":"boolean"}}}}}}
```
## Eliminar comercio
> Elimina un comercio del cliente.
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Comercios","description":"Endpoints para gestionar comercios asociados a un cliente."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Commerces/{commerceId}":{"delete":{"tags":["Comercios"],"summary":"Eliminar comercio","description":"Elimina un comercio del cliente.","operationId":"Comercios_Eliminar","parameters":[{"name":"commerceId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"clientId","in":"header","schema":{"type":"string","nullable":true}}],"responses":{"200":{"description":"Eliminado"},"400":{"description":"Solicitud incorrecta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Credenciales incorrectas"}}}}},"components":{"schemas":{"ErrorResponse":{"type":"object","additionalProperties":false,"properties":{"code":{"$ref":"#/components/schemas/HttpStatusCode"},"message":{"type":"string","nullable":true},"subCode":{"type":"integer","format":"int32"}}},"HttpStatusCode":{"type":"integer","description":"包含針對 HTTP 所定義的狀態碼值。","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,300,301,301,302,302,303,303,304,305,306,307,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511]}}}}
```
# Dashboard
Endpoints para información agregada y métricas del cliente.
## Obtener métricas del dashboard
> Devuelve métricas principales del cliente: suscripciones, transacciones y distribución de errores.
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Dashboard","description":"Endpoints para información agregada y métricas del cliente."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Home":{"get":{"tags":["Dashboard"],"summary":"Obtener métricas del dashboard","description":"Devuelve métricas principales del cliente: suscripciones, transacciones y distribución de errores.","operationId":"Dashboard_Get","parameters":[{"name":"clientId","in":"header","schema":{"type":"string","nullable":true}}],"responses":{"200":{"description":"Éxito","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HomeDto"}}}},"404":{"description":"Credenciales inválidas"}}}}},"components":{"schemas":{"HomeDto":{"type":"object","additionalProperties":false,"properties":{"totalRegularSubscriptions":{"type":"integer","format":"int32"},"almostFinishSubscription":{"type":"integer","format":"int32"},"totalPagossuccess":{"type":"integer","format":"int32"},"totalPagoserror":{"type":"integer","format":"int32"},"historicTotalSubscriptors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/HistoricDataDto"}},"errorCategories":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ErrorCategoryDto"}},"currentMonthRevenue":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/CurrencyRevenueDto"}},"previousMonthRevenue":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/CurrencyRevenueDto"}}}},"HistoricDataDto":{"type":"object","additionalProperties":false,"properties":{"date":{"type":"string","format":"date-time"},"count":{"type":"integer","format":"int32"}}},"ErrorCategoryDto":{"type":"object","additionalProperties":false,"properties":{"category":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64"}}},"CurrencyRevenueDto":{"type":"object","additionalProperties":false,"properties":{"currency":{"$ref":"#/components/schemas/Currency"},"amount":{"type":"number","format":"decimal"}}},"Currency":{"type":"integer","description":"","enum":[1,2]}}}}
```
# Instrumentos
Endpoints para registrar, consultar y eliminar instrumentos de pago.
## Obtener instrumento
> Recupera instrumento de pago activo del suscriptor.
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Instrumentos","description":"Endpoints para registrar, consultar y eliminar instrumentos de pago."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Instruments":{"get":{"tags":["Instrumentos"],"summary":"Obtener instrumento","description":"Recupera instrumento de pago activo del suscriptor.","operationId":"Instrumentos_Obtener","parameters":[{"name":"clientSecret","in":"header","schema":{"type":"string","nullable":true}},{"name":"clientId","in":"header","schema":{"type":"string","nullable":true}},{"name":"externalId","in":"header","schema":{"type":"string","nullable":true}},{"name":"opcionalParameter","in":"query","schema":{"type":"object","nullable":true,"additionalProperties":{"type":"boolean"}}}],"responses":{"200":{"description":"Éxito","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstrumentResponse"}}}},"204":{"description":"Sin contenido"},"400":{"description":"Solicitud incorrecta"},"404":{"description":"Credenciales inválidas"}}}}},"components":{"schemas":{"InstrumentResponse":{"type":"object","additionalProperties":false,"properties":{"expiration":{"type":"string","format":"date-time"},"instrumentId":{"type":"string","nullable":true},"issuerImageUrl":{"type":"string","nullable":true},"issuerName":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"optionalUniqueID":{"type":"string","nullable":true}}}}}}
```
## Iniciar registro instrumento
> Obtiene la URL de Plexo para registrar un instrumento de pago.
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Instrumentos","description":"Endpoints para registrar, consultar y eliminar instrumentos de pago."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Instruments":{"post":{"tags":["Instrumentos"],"summary":"Iniciar registro instrumento","description":"Obtiene la URL de Plexo para registrar un instrumento de pago.","operationId":"Instrumentos_IniciarRegistro","parameters":[{"name":"clientSecret","in":"header","schema":{"type":"string","nullable":true}},{"name":"clientId","in":"header","schema":{"type":"string","nullable":true}},{"name":"externalId","in":"header","schema":{"type":"string","nullable":true}},{"name":"redirectUrl","in":"header","schema":{"type":"string","nullable":true}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterInstrumentRequest"}}},"required":true},"responses":{"200":{"description":"Éxito","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterInstrumentResponse"}}}},"400":{"description":"Solicitud incorrecta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Credenciales inválidas"}}}}},"components":{"schemas":{"RegisterInstrumentRequest":{"type":"object","additionalProperties":false,"properties":{"callbackUrl":{"type":"string","nullable":true},"populateData":{"type":"boolean"}}},"RegisterInstrumentResponse":{"type":"object","additionalProperties":false,"properties":{"url":{"type":"string","nullable":true}}},"ErrorResponse":{"type":"object","additionalProperties":false,"properties":{"code":{"$ref":"#/components/schemas/HttpStatusCode"},"message":{"type":"string","nullable":true},"subCode":{"type":"integer","format":"int32"}}},"HttpStatusCode":{"type":"integer","description":"包含針對 HTTP 所定義的狀態碼值。","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,300,301,301,302,302,303,303,304,305,306,307,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511]}}}}
```
## Importar instrumentos (placeholder)
> Endpoint placeholder para importación masiva de instrumentos.
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Instrumentos","description":"Endpoints para registrar, consultar y eliminar instrumentos de pago."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Instruments/Import":{"post":{"tags":["Instrumentos"],"summary":"Importar instrumentos (placeholder)","description":"Endpoint placeholder para importación masiva de instrumentos.","operationId":"Instrumentos_Importar","parameters":[{"name":"base64","in":"query","schema":{"type":"string","nullable":true}}],"responses":{"200":{"description":"","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}}}}}}
```
## Eliminar instrumento
> Elimina un instrumento de pago del suscriptor.
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Instrumentos","description":"Endpoints para registrar, consultar y eliminar instrumentos de pago."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Instruments/{instrumentId}":{"delete":{"tags":["Instrumentos"],"summary":"Eliminar instrumento","description":"Elimina un instrumento de pago del suscriptor.","operationId":"Instrumentos_Eliminar","parameters":[{"name":"instrumentId","in":"path","required":true,"schema":{"type":"string"}},{"name":"clientSecret","in":"header","schema":{"type":"string","nullable":true}},{"name":"clientId","in":"header","schema":{"type":"string","nullable":true}},{"name":"externalId","in":"header","schema":{"type":"string","nullable":true}}],"responses":{"200":{"description":"Eliminado"},"400":{"description":"Solicitud incorrecta"},"404":{"description":"Credenciales inválidas"}}}}}}
```
## Iniciar registro por link
> Obtiene URL para registrar instrumento via link público.
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Instrumentos","description":"Endpoints para registrar, consultar y eliminar instrumentos de pago."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Instruments/links":{"post":{"tags":["Instrumentos"],"summary":"Iniciar registro por link","description":"Obtiene URL para registrar instrumento via link público.","operationId":"Instrumentos_IniciarRegistroLink","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterInstrumentLinkRequest"}}},"required":true},"responses":{"200":{"description":"Éxito","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterInstrumentResponse"}}}},"400":{"description":"Solicitud incorrecta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"components":{"schemas":{"RegisterInstrumentLinkRequest":{"type":"object","additionalProperties":false,"properties":{"linkId":{"type":"string","format":"guid"},"clientId":{"type":"string","format":"guid"},"externalId":{"type":"string","nullable":true},"redirectUrl":{"type":"string","nullable":true},"callbackUrl":{"type":"string","nullable":true},"populateData":{"type":"boolean"}}},"RegisterInstrumentResponse":{"type":"object","additionalProperties":false,"properties":{"url":{"type":"string","nullable":true}}},"ErrorResponse":{"type":"object","additionalProperties":false,"properties":{"code":{"$ref":"#/components/schemas/HttpStatusCode"},"message":{"type":"string","nullable":true},"subCode":{"type":"integer","format":"int32"}}},"HttpStatusCode":{"type":"integer","description":"包含針對 HTTP 所定義的狀態碼值。","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,300,301,301,302,302,303,303,304,305,306,307,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511]}}}}
```
# Emisores
Endpoints para consulta de emisores (Issuers) disponibles en la plataforma.
## Listar emisores
> Devuelve el listado de emisores disponibles. Valida credenciales si corresponde.
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Emisores","description":"Endpoints para consulta de emisores (Issuers) disponibles en la plataforma."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Issuers":{"get":{"tags":["Emisores"],"summary":"Listar emisores","description":"Devuelve el listado de emisores disponibles. Valida credenciales si corresponde.","operationId":"Emisores_Listar","parameters":[{"name":"clientSecret","in":"header","schema":{"type":"string","nullable":true}},{"name":"clientId","in":"header","schema":{"type":"string","nullable":true}}],"responses":{"200":{"description":"Éxito","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IssuerInfo"}}}}},"204":{"description":"Sin contenido"},"404":{"description":"Credenciales inválidas"}}}}},"components":{"schemas":{"IssuerInfo":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","nullable":true},"issuerId":{"type":"integer","format":"int32"},"variationId":{"type":"integer","format":"int32"},"issuer":{"type":"string","nullable":true},"bank":{"type":"string","nullable":true},"variation":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"mayHaveAsyncPayments":{"type":"boolean"},"supportsReserve":{"type":"boolean"},"mayHavePaymentsLimits":{"type":"boolean"},"fields":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FieldInfo"}}}},"FieldInfo":{"type":"object","additionalProperties":false,"properties":{"labelName":{"type":"string","nullable":true},"fieldType":{"$ref":"#/components/schemas/FieldType"},"required":{"type":"boolean"}}},"FieldType":{"type":"integer","description":"","enum":[257,258,259,260,261,262,263,264,265,266,267,268,269,270,271,272,273,274,513,514,515,516,517,518,519,520,521,522,523,524,525,526,527,528,529,530,531,532,533,534,535,1025,1281,1282,1283,1284,1285,1286,1287,1288,1289,1296,1297,1298,2049,2050,2051,2052,2053,2054,2055,2056,2057,2058,2059,2060,2061,2062,2063,2064,2065,2066,2067,2068,2069,2070,2071,2072,2073,2074,2075,2076,2077,2078,2079,2080,2081,2082,2083,2084,2085,2305,2306,2307,2308,2309,2310,2311,2312,2313,2320,33025,33026,33027,33028,33153,33154]}}}}
```
# Links
Endpoints para crear, listar y gestionar links de suscripción.
## Listar links
> Devuelve todos los links del cliente.
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Links","description":"Endpoints para crear, listar y gestionar links de suscripción."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Links":{"get":{"tags":["Links"],"summary":"Listar links","description":"Devuelve todos los links del cliente.","operationId":"Links_Listar","parameters":[{"name":"clientSecret","in":"header","schema":{"type":"string","nullable":true}},{"name":"clientId","in":"header","schema":{"type":"string","nullable":true}}],"responses":{"200":{"description":"","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}}}}}}
```
## Crear link
> Crea un link de suscripción para el cliente logueado (admin).
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Links","description":"Endpoints para crear, listar y gestionar links de suscripción."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Links":{"post":{"tags":["Links"],"summary":"Crear link","description":"Crea un link de suscripción para el cliente logueado (admin).","operationId":"Links_Crear","parameters":[{"name":"clientSecret","in":"header","schema":{"type":"string","nullable":true}},{"name":"clientId","in":"header","schema":{"type":"string","nullable":true}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLinkRequest"}}},"required":true},"responses":{"200":{"description":"","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}}}}},"components":{"schemas":{"CreateLinkRequest":{"type":"object","additionalProperties":false,"properties":{"externalId":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"canUpdateSubscriptorData":{"type":"boolean"},"subscriptionTypeId":{"type":"string","nullable":true}}}}}}
```
## Crear link por token
> Genera link usando el token de tipo de suscripción.
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Links","description":"Endpoints para crear, listar y gestionar links de suscripción."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Links/CreateLinkToken":{"post":{"tags":["Links"],"summary":"Crear link por token","description":"Genera link usando el token de tipo de suscripción.","operationId":"Links_ValidarToken","parameters":[{"name":"clientId","in":"header","schema":{"type":"string","format":"guid"}},{"name":"clientSecret","in":"header","schema":{"type":"string","nullable":true}}],"requestBody":{"content":{"application/json":{"schema":{"type":"integer","format":"int32"}}},"required":true},"responses":{"200":{"description":"","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}}}}}}
```
## Crear link con suscripción
> Genera link y crea contexto de suscripción basado en la request.
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Links","description":"Endpoints para crear, listar y gestionar links de suscripción."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Links/CreateLinkWithSuscription":{"post":{"tags":["Links"],"summary":"Crear link con suscripción","description":"Genera link y crea contexto de suscripción basado en la request.","operationId":"Links_CrearConSuscripcion","parameters":[{"name":"clientId","in":"header","schema":{"type":"string","format":"guid"}},{"name":"clientSecret","in":"header","schema":{"type":"string","nullable":true}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLinkRequest"}}},"required":true},"responses":{"200":{"description":"","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}}}}},"components":{"schemas":{"CreateLinkRequest":{"type":"object","additionalProperties":false,"properties":{"externalId":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"canUpdateSubscriptorData":{"type":"boolean"},"subscriptionTypeId":{"type":"string","nullable":true}}}}}}
```
## Obtener link
> Obtiene datos de un link público por Id.
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Links","description":"Endpoints para crear, listar y gestionar links de suscripción."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Links/{linkId}":{"get":{"tags":["Links"],"summary":"Obtener link","description":"Obtiene datos de un link público por Id.","operationId":"Links_Obtener","parameters":[{"name":"linkId","in":"path","required":true,"schema":{"type":"string","format":"guid"}},{"name":"clientSecret","in":"header","schema":{"type":"string","nullable":true}},{"name":"clientId","in":"header","schema":{"type":"string","nullable":true}}],"responses":{"200":{"description":"","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}}}}}}
```
## Eliminar link
> Elimina un link de suscripción por Id.
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Links","description":"Endpoints para crear, listar y gestionar links de suscripción."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Links/{linkId}":{"delete":{"tags":["Links"],"summary":"Eliminar link","description":"Elimina un link de suscripción por Id.","operationId":"Links_Eliminar","parameters":[{"name":"linkId","in":"path","required":true,"schema":{"type":"string","format":"guid"}},{"name":"clientSecret","in":"header","schema":{"type":"string","nullable":true}},{"name":"clientId","in":"header","schema":{"type":"string","nullable":true}}],"responses":{"200":{"description":"","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}}}}}}
```
## Crear link para suscriptor
> Crea un link específico para un suscriptor (solo admin).
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Links","description":"Endpoints para crear, listar y gestionar links de suscripción."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Links/subscriptor/{subscriptorId}":{"post":{"tags":["Links"],"summary":"Crear link para suscriptor","description":"Crea un link específico para un suscriptor (solo admin).","operationId":"Links_CrearParaSuscriptor","parameters":[{"name":"subscriptorId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"clientSecret","in":"header","schema":{"type":"string","nullable":true}},{"name":"clientId","in":"header","schema":{"type":"string","nullable":true}}],"responses":{"200":{"description":"","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}}}}}}
```
# Notificaciones
Endpoints para operar sobre notificaciones de transacciones.
## Reenviar notificación
> Reenvía la notificación asociada a una transacción específica.
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Notificaciones","description":"Endpoints para operar sobre notificaciones de transacciones."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Notifications/resend/{transactionId}":{"post":{"tags":["Notificaciones"],"summary":"Reenviar notificación","description":"Reenvía la notificación asociada a una transacción específica.","operationId":"Notificaciones_Reenviar","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"clientSecret","in":"header","schema":{"type":"string","nullable":true}},{"name":"clientId","in":"header","schema":{"type":"string","nullable":true}}],"responses":{"200":{"description":"","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}}}}}}}
```
# TiposSuscripción
Endpoints para administrar tipos de suscripción de un cliente.
## Listar tipos activos
> Obtiene los tipos de suscripción activos del cliente.
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"TiposSuscripción","description":"Endpoints para administrar tipos de suscripción de un cliente."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/SubscriptionTypes":{"get":{"tags":["TiposSuscripción"],"summary":"Listar tipos activos","description":"Obtiene los tipos de suscripción activos del cliente.","operationId":"TiposSuscripcion_Activos","parameters":[{"name":"clientSecret","in":"header","schema":{"type":"string","nullable":true}},{"name":"clientId","in":"header","schema":{"type":"string","nullable":true}}],"responses":{"200":{"description":"Éxito","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SubscriptionType"}}}}},"204":{"description":"Sin contenido"},"404":{"description":"Credenciales inválidas"}}}}},"components":{"schemas":{"SubscriptionType":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","description","frequence","cost","currency","status","recurrence"],"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","maxLength":50,"minLength":0},"description":{"type":"string","maxLength":120,"minLength":0},"frequence":{"$ref":"#/components/schemas/Frequence"},"cost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"status":{"$ref":"#/components/schemas/SubscriptionTypeStatus"},"recurrence":{"type":"integer","format":"int32","default":0},"taxPercentage":{"type":"number","format":"decimal","nullable":true}}}]},"BaseEntity":{"type":"object","additionalProperties":false},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"SubscriptionTypeStatus":{"type":"integer","description":"","enum":[0,99]}}}}
```
## Crear tipo de suscripción
> Crea un nuevo tipo de suscripción para el cliente.
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"TiposSuscripción","description":"Endpoints para administrar tipos de suscripción de un cliente."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/SubscriptionTypes":{"post":{"tags":["TiposSuscripción"],"summary":"Crear tipo de suscripción","description":"Crea un nuevo tipo de suscripción para el cliente.","operationId":"TiposSuscripcion_Crear","parameters":[{"name":"clientSecret","in":"header","schema":{"type":"string","nullable":true}},{"name":"clientId","in":"header","schema":{"type":"string","nullable":true}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddSubscriptionTypeRequest"}}},"required":true},"responses":{"200":{"description":"Éxito","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionType"}}}},"400":{"description":"Solicitud incorrecta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Credenciales inválidas"}}}}},"components":{"schemas":{"AddSubscriptionTypeRequest":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"frequence":{"$ref":"#/components/schemas/Frequence"},"subscriptionCost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"recurrence":{"type":"integer","format":"int32"},"taxPercentage":{"type":"number","format":"decimal","nullable":true}}},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"SubscriptionType":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","description","frequence","cost","currency","status","recurrence"],"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","maxLength":50,"minLength":0},"description":{"type":"string","maxLength":120,"minLength":0},"frequence":{"$ref":"#/components/schemas/Frequence"},"cost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"status":{"$ref":"#/components/schemas/SubscriptionTypeStatus"},"recurrence":{"type":"integer","format":"int32","default":0},"taxPercentage":{"type":"number","format":"decimal","nullable":true}}}]},"BaseEntity":{"type":"object","additionalProperties":false},"SubscriptionTypeStatus":{"type":"integer","description":"","enum":[0,99]},"ErrorResponse":{"type":"object","additionalProperties":false,"properties":{"code":{"$ref":"#/components/schemas/HttpStatusCode"},"message":{"type":"string","nullable":true},"subCode":{"type":"integer","format":"int32"}}},"HttpStatusCode":{"type":"integer","description":"包含針對 HTTP 所定義的狀態碼值。","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,300,301,301,302,302,303,303,304,305,306,307,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511]}}}}
```
## Listar todos los tipos
> Obtiene todos los tipos de suscripción del cliente (activos e inactivos).
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"TiposSuscripción","description":"Endpoints para administrar tipos de suscripción de un cliente."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/SubscriptionTypes/all":{"get":{"tags":["TiposSuscripción"],"summary":"Listar todos los tipos","description":"Obtiene todos los tipos de suscripción del cliente (activos e inactivos).","operationId":"TiposSuscripcion_Todos","parameters":[{"name":"clientSecret","in":"header","schema":{"type":"string","nullable":true}},{"name":"clientId","in":"header","schema":{"type":"string","nullable":true}}],"responses":{"200":{"description":"Éxito","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SubscriptionType"}}}}},"204":{"description":"Sin contenido"},"404":{"description":"Credenciales inválidas"}}}}},"components":{"schemas":{"SubscriptionType":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","description","frequence","cost","currency","status","recurrence"],"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","maxLength":50,"minLength":0},"description":{"type":"string","maxLength":120,"minLength":0},"frequence":{"$ref":"#/components/schemas/Frequence"},"cost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"status":{"$ref":"#/components/schemas/SubscriptionTypeStatus"},"recurrence":{"type":"integer","format":"int32","default":0},"taxPercentage":{"type":"number","format":"decimal","nullable":true}}}]},"BaseEntity":{"type":"object","additionalProperties":false},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"SubscriptionTypeStatus":{"type":"integer","description":"","enum":[0,99]}}}}
```
## Actualizar tipo
> Actualiza un tipo de suscripción existente.
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"TiposSuscripción","description":"Endpoints para administrar tipos de suscripción de un cliente."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/SubscriptionTypes/{subscriptionTypeId}":{"put":{"tags":["TiposSuscripción"],"summary":"Actualizar tipo","description":"Actualiza un tipo de suscripción existente.","operationId":"TiposSuscripcion_Actualizar","parameters":[{"name":"subscriptionTypeId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"clientSecret","in":"header","schema":{"type":"string","nullable":true}},{"name":"clientId","in":"header","schema":{"type":"string","nullable":true}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSubscriptionTypeRequest"}}},"required":true},"responses":{"200":{"description":"Éxito","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionType"}}}},"400":{"description":"Solicitud incorrecta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Credenciales inválidas"}}}}},"components":{"schemas":{"UpdateSubscriptionTypeRequest":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"subscriptionCost":{"type":"number","format":"decimal"},"taxPercentage":{"type":"string","nullable":true}}},"SubscriptionType":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","description","frequence","cost","currency","status","recurrence"],"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","maxLength":50,"minLength":0},"description":{"type":"string","maxLength":120,"minLength":0},"frequence":{"$ref":"#/components/schemas/Frequence"},"cost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"status":{"$ref":"#/components/schemas/SubscriptionTypeStatus"},"recurrence":{"type":"integer","format":"int32","default":0},"taxPercentage":{"type":"number","format":"decimal","nullable":true}}}]},"BaseEntity":{"type":"object","additionalProperties":false},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"SubscriptionTypeStatus":{"type":"integer","description":"","enum":[0,99]},"ErrorResponse":{"type":"object","additionalProperties":false,"properties":{"code":{"$ref":"#/components/schemas/HttpStatusCode"},"message":{"type":"string","nullable":true},"subCode":{"type":"integer","format":"int32"}}},"HttpStatusCode":{"type":"integer","description":"包含針對 HTTP 所定義的狀態碼值。","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,300,301,301,302,302,303,303,304,305,306,307,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511]}}}}
```
## Eliminar tipo
> Elimina un tipo de suscripción del cliente.
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"TiposSuscripción","description":"Endpoints para administrar tipos de suscripción de un cliente."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/SubscriptionTypes/{subscriptionTypeId}":{"delete":{"tags":["TiposSuscripción"],"summary":"Eliminar tipo","description":"Elimina un tipo de suscripción del cliente.","operationId":"TiposSuscripcion_Eliminar","parameters":[{"name":"subscriptionTypeId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"clientSecret","in":"header","schema":{"type":"string","nullable":true}},{"name":"clientId","in":"header","schema":{"type":"string","nullable":true}}],"responses":{"200":{"description":"Éxito"},"400":{"description":"Solicitud incorrecta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Credenciales inválidas"}}}}},"components":{"schemas":{"ErrorResponse":{"type":"object","additionalProperties":false,"properties":{"code":{"$ref":"#/components/schemas/HttpStatusCode"},"message":{"type":"string","nullable":true},"subCode":{"type":"integer","format":"int32"}}},"HttpStatusCode":{"type":"integer","description":"包含針對 HTTP 所定義的狀態碼值。","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,300,301,301,302,302,303,303,304,305,306,307,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511]}}}}
```
# Subscriptors
Endpoints para gestionar suscriptores, suscripciones y operaciones relacionadas.
## Obtener suscriptor por externalId
> Devuelve la información detallada del suscriptor, opcionalmente filtrando solo transacciones exitosas.
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Subscriptors","description":"Endpoints para gestionar suscriptores, suscripciones y operaciones relacionadas."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Subscriptors/{externalId}":{"get":{"tags":["Subscriptors"],"summary":"Obtener suscriptor por externalId","description":"Devuelve la información detallada del suscriptor, opcionalmente filtrando solo transacciones exitosas.","operationId":"GetSubscriptorInfo","parameters":[{"name":"externalId","in":"path","required":true,"schema":{"type":"string"}},{"name":"clientSecret","in":"header","schema":{"type":"string","nullable":true}},{"name":"clientId","in":"header","schema":{"type":"string","nullable":true}},{"name":"onlySuccessfulTransactions","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Éxito","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptorResponse"}}}},"400":{"description":"Solicitud incorrecta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"ClientSecret inválido"}}}}},"components":{"schemas":{"SubscriptorResponse":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"fullName":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentResponse"}]},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionResponse"}},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionResponse"}},"firstSubscribed":{"type":"string","format":"date-time"}}},"InstrumentResponse":{"type":"object","additionalProperties":false,"properties":{"expiration":{"type":"string","format":"date-time"},"instrumentId":{"type":"string","nullable":true},"issuerImageUrl":{"type":"string","nullable":true},"issuerName":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"optionalUniqueID":{"type":"string","nullable":true}}},"SubscriptionResponse":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","nullable":true},"token":{"type":"string","nullable":true},"subscriptionDate":{"type":"string","format":"date-time","nullable":true},"subscriptionLastPaymentDate":{"type":"string","format":"date-time"},"subscriptionStatus":{"$ref":"#/components/schemas/SubscriptionStatus"},"validUntil":{"type":"string","format":"date-time"},"legalId":{"type":"string","nullable":true},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"backgroundJobId":{"type":"string","nullable":true}}},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"SubscriptionTypeDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"frequence":{"$ref":"#/components/schemas/Frequence"},"subscriptionBaseCost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"recurrence":{"type":"integer","format":"int32"},"regularType":{"type":"boolean"},"taxPercentage":{"type":"string","nullable":true}}},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"TransactionResponse":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"subscription":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionResponse"}]},"amount":{"type":"number","format":"decimal"},"createdAt":{"type":"string","format":"date-time"},"state":{"$ref":"#/components/schemas/TransactionStatus"},"currency":{"$ref":"#/components/schemas/Currency"},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentResponse"}]},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorResponse"}]}}},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"ErrorResponse":{"type":"object","additionalProperties":false,"properties":{"code":{"$ref":"#/components/schemas/HttpStatusCode"},"message":{"type":"string","nullable":true},"subCode":{"type":"integer","format":"int32"}}},"HttpStatusCode":{"type":"integer","description":"包含針對 HTTP 所定義的狀態碼值。","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,300,301,301,302,302,303,303,304,305,306,307,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511]}}}}
```
## Actualizar suscriptor
> Actualiza datos de un suscriptor existente. Retorna error si no está registrado.
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Subscriptors","description":"Endpoints para gestionar suscriptores, suscripciones y operaciones relacionadas."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Subscriptors/{externalId}":{"put":{"tags":["Subscriptors"],"summary":"Actualizar suscriptor","description":"Actualiza datos de un suscriptor existente. Retorna error si no está registrado.","operationId":"UpdateSubscriptorData","parameters":[{"name":"externalId","in":"path","required":true,"schema":{"type":"string"}},{"name":"clientSecret","in":"header","schema":{"type":"string","nullable":true}},{"name":"clientId","in":"header","schema":{"type":"string","nullable":true}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSubscriptorRequest"}}},"required":true},"responses":{"200":{"description":"Éxito","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscriptor"}}}},"400":{"description":"Solicitud incorrecta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"ClientSecret inválido"}}}}},"components":{"schemas":{"UpdateSubscriptorRequest":{"type":"object","additionalProperties":false,"properties":{"email":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"fullName":{"type":"string","nullable":true}}},"Subscriptor":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["externalId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","maxLength":100,"minLength":0},"email":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"name":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"fullName":{"type":"string","maxLength":150,"minLength":0,"nullable":true},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"instruments":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Instrument"}},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscription"}},"links":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Link"}}}}]},"BaseEntity":{"type":"object","additionalProperties":false},"Client":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","legalName","legalId","clientSecret","plexoCommerceId","admin","taxPercentage"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"legalName":{"type":"string","maxLength":150,"minLength":1},"legalId":{"type":"string","maxLength":12,"minLength":1},"clientSecret":{"type":"string","maxLength":50,"minLength":1},"plexoCommerceId":{"type":"integer","format":"int32"},"recurringPaymentUrl":{"type":"string","maxLength":100,"nullable":true},"admin":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationUser"}},"taxPercentage":{"type":"number","format":"decimal","default":22},"subscriptionTypes":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionType"}},"clientIssuers":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ClientIssuer"}},"subscriptors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscriptor"}},"historicData":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/HistoricData"}},"retriesConfiguration":{"$ref":"#/components/schemas/RetriesConfigurationEnum"},"notificationPermissionsId":{"type":"integer","format":"int32"},"notificationPermissions":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NotificationPermissions"}]}}}]},"ApplicationUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUser"},{"type":"object","additionalProperties":false,"properties":{"userType":{"$ref":"#/components/schemas/UserType"},"clientID":{"type":"string","format":"guid"}}}]},"IdentityUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUserOfString"},{"type":"object","description":"The default implementation of IdentityUser`1 which uses a string as a primary key.","additionalProperties":false}]},"IdentityUserOfString":{"type":"object","description":"Represents a user in the identity system","additionalProperties":false,"properties":{"id":{"type":"string","description":"Gets or sets the primary key for this user.","nullable":true},"userName":{"type":"string","description":"Gets or sets the user name for this user.","nullable":true},"normalizedUserName":{"type":"string","description":"Gets or sets the normalized user name for this user.","nullable":true},"email":{"type":"string","description":"Gets or sets the email address for this user.","nullable":true},"normalizedEmail":{"type":"string","description":"Gets or sets the normalized email address for this user.","nullable":true},"emailConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their email address."},"passwordHash":{"type":"string","description":"Gets or sets a salted and hashed representation of the password for this user.","nullable":true},"securityStamp":{"type":"string","description":"A random value that must change whenever a users credentials change (password changed, login removed)","nullable":true},"concurrencyStamp":{"type":"string","description":"A random value that must change whenever a user is persisted to the store","nullable":true},"phoneNumber":{"type":"string","description":"Gets or sets a telephone number for the user.","nullable":true},"phoneNumberConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their telephone address."},"twoFactorEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if two factor authentication is enabled for this user."},"lockoutEnd":{"type":"string","description":"Gets or sets the date and time, in UTC, when any user lockout ends.","format":"date-time","nullable":true},"lockoutEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if the user could be locked out."},"accessFailedCount":{"type":"integer","description":"Gets or sets the number of failed login attempts for the current user.","format":"int32"}}},"UserType":{"type":"integer","description":"","enum":[0,1,2]},"SubscriptionType":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","description","frequence","cost","currency","status","recurrence"],"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","maxLength":50,"minLength":0},"description":{"type":"string","maxLength":120,"minLength":0},"frequence":{"$ref":"#/components/schemas/Frequence"},"cost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"status":{"$ref":"#/components/schemas/SubscriptionTypeStatus"},"recurrence":{"type":"integer","format":"int32","default":0},"taxPercentage":{"type":"number","format":"decimal","nullable":true}}}]},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"SubscriptionTypeStatus":{"type":"integer","description":"","enum":[0,99]},"ClientIssuer":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["issuerId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"issuerId":{"type":"integer","format":"int32"},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]}}}]},"HistoricData":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"date":{"type":"string","format":"date"},"totalSubscriptors":{"type":"integer","format":"int32"}}},"RetriesConfigurationEnum":{"type":"integer","description":"","enum":[0,1]},"NotificationPermissions":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["id"],"properties":{"id":{"type":"integer","format":"int32"},"transactionCancellation":{"type":"boolean"},"subscriptionCancellation":{"type":"boolean"},"subscriptorFields":{"type":"boolean"},"paymentSuccess":{"type":"boolean"},"paymentFailed":{"type":"boolean"},"subcriptioninactiveByPaymentFailure":{"type":"boolean"}}}]},"Instrument":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["subscriptorId","instrumentToken","name","issuerName","issuerImageUrl","expiration","status"],"properties":{"id":{"type":"string","format":"guid"},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"instrumentToken":{"type":"string","format":"guid","minLength":1},"name":{"type":"string","maxLength":50,"minLength":1},"issuerName":{"type":"string","maxLength":50,"minLength":1},"issuerImageUrl":{"type":"string","maxLength":200,"minLength":1},"expiration":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/InstrumentStatus"},"uniqueID":{"type":"string","maxLength":200,"nullable":true},"plexoExtendedResponse":{"type":"string","nullable":true}}}]},"InstrumentStatus":{"type":"integer","description":"","enum":[0,99]},"Subscription":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["token","subscriptionTypeId","date","status","lastPaymentDate","validToDate","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"token":{"type":"string","minLength":1},"subscriptionTypeId":{"type":"integer","format":"int32"},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionType"}]},"date":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/SubscriptionStatus"},"lastPaymentDate":{"type":"string","format":"date","minLength":1},"validToDate":{"type":"string","format":"date","minLength":1},"backgroundJobId":{"type":"string","nullable":true},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"suspendedBy":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SuspendedByEnum"}]},"suspendedDate":{"type":"string","format":"date","nullable":true},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"remainingRecurrences":{"type":"integer","format":"int32","nullable":true}}}]},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"SuspendedByEnum":{"type":"integer","description":"","enum":[0,1]},"Transaction":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["currency","amount","taxedAmount","taxAmount","date","status","retryAttempt","type","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"currency":{"$ref":"#/components/schemas/Currency"},"amount":{"type":"number","format":"decimal"},"taxedAmount":{"type":"number","format":"decimal"},"taxAmount":{"type":"number","format":"decimal"},"date":{"type":"string","format":"date-time","minLength":1},"status":{"$ref":"#/components/schemas/TransactionStatus"},"authorization":{"type":"string","nullable":true},"plexoReferenceId":{"type":"string","nullable":true},"errorText":{"type":"string","nullable":true},"retryAttempt":{"type":"integer","format":"int32","default":1},"plexoClientReference":{"type":"string","nullable":true},"ticket":{"type":"string","nullable":true},"type":{"default":1,"oneOf":[{"$ref":"#/components/schemas/TransactionType"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItemId":{"type":"string","format":"guid","nullable":true},"transactionRequestItem":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestItem"}]},"subscriptionId":{"type":"string","format":"guid","nullable":true},"subscription":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscription"}]},"instrumentId":{"type":"string","format":"guid","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Instrument"}]},"electronicBillingId":{"type":"integer","format":"int32","nullable":true},"electronicBilling":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ElectronicBill"}]}}}]},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionType":{"type":"integer","description":"","enum":[1,2]},"TransactionRequestItem":{"type":"object","additionalProperties":false,"required":["amount","currency","paymentRequestItemStatus","transactionRequestFileId","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"amount":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"paymentRequestItemStatus":{"$ref":"#/components/schemas/PaymentRequestItemStatus"},"transactionRequestFileId":{"type":"string","format":"guid","minLength":1},"transactionRequestFile":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestFile"}]},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"jobId":{"type":"string","nullable":true}}},"PaymentRequestItemStatus":{"type":"integer","description":"","enum":[1,2,3]},"TransactionRequestFile":{"type":"object","additionalProperties":false,"required":["name","url","clientId"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"url":{"type":"string","maxLength":200,"minLength":1},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItems":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionRequestItem"}},"date":{"type":"string","format":"date-time"}}},"ElectronicBill":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["internalId","caeNumber","series","number"],"properties":{"id":{"type":"integer","format":"int32"},"internalId":{"type":"integer","format":"int32"},"caeNumber":{"type":"string","minLength":1},"series":{"type":"string","minLength":1},"number":{"type":"integer","format":"int32"}}}]},"Link":{"type":"object","additionalProperties":false,"required":["externalId","status","clientId","canUpdateSubscriptorData"],"properties":{"id":{"type":"string","format":"guid"},"externalId":{"type":"string","maxLength":150,"minLength":1},"firstName":{"type":"string","maxLength":50,"nullable":true},"lastName":{"type":"string","maxLength":50,"nullable":true},"email":{"type":"string","maxLength":150,"nullable":true},"status":{"default":1,"oneOf":[{"$ref":"#/components/schemas/LinkStatusEnum"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"subscriptorId":{"type":"integer","format":"int32","nullable":true},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"canUpdateSubscriptorData":{"type":"boolean","default":true},"subscriptionTypeId":{"type":"string","nullable":true}}},"LinkStatusEnum":{"type":"integer","description":"","enum":[1,2,3]},"ErrorResponse":{"type":"object","additionalProperties":false,"properties":{"code":{"$ref":"#/components/schemas/HttpStatusCode"},"message":{"type":"string","nullable":true},"subCode":{"type":"integer","format":"int32"}}},"HttpStatusCode":{"type":"integer","description":"包含針對 HTTP 所定義的狀態碼值。","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,300,301,301,302,302,303,303,304,305,306,307,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511]}}}}
```
## Listar suscriptores (paginado)
> Devuelve una lista paginada de suscriptores del cliente, soportando varios filtros.
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Subscriptors","description":"Endpoints para gestionar suscriptores, suscripciones y operaciones relacionadas."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Subscriptors":{"get":{"tags":["Subscriptors"],"summary":"Listar suscriptores (paginado)","description":"Devuelve una lista paginada de suscriptores del cliente, soportando varios filtros.","operationId":"GetSubscriptors","parameters":[{"name":"clientSecret","in":"header","schema":{"type":"string","nullable":true}},{"name":"clientId","in":"header","schema":{"type":"string","nullable":true}},{"name":"Page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"Limit","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"SubscriptorEmailOrNameOrId","in":"query","schema":{"type":"string","nullable":true}},{"name":"SubscriptorsState","in":"query","schema":{"$ref":"#/components/schemas/SubscriptorsQueryState"}},{"name":"SubscriptionTypes","in":"query","schema":{"type":"string","nullable":true}},{"name":"ActiveOnly","in":"query","schema":{"type":"boolean","nullable":true}}],"responses":{"200":{"description":"Éxito","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResultOfSubscriptor"}}}},"204":{"description":"Sin contenido"},"404":{"description":"ClientSecret inválido"}}}}},"components":{"schemas":{"SubscriptorsQueryState":{"type":"integer","description":"","enum":[0,1,2]},"PagedResultOfSubscriptor":{"allOf":[{"$ref":"#/components/schemas/PagedResultBase"},{"type":"object","additionalProperties":false,"properties":{"results":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscriptor"}}}}]},"PagedResultBase":{"type":"object","additionalProperties":false,"properties":{"currentPage":{"type":"integer","format":"int32"},"pageCount":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"rowCount":{"type":"integer","format":"int32"},"totalPeso":{"type":"number","format":"decimal"},"totalDollar":{"type":"number","format":"decimal"},"totalPesoFailed":{"type":"number","format":"decimal"},"totalDollarFailed":{"type":"number","format":"decimal"},"firstRowOnPage":{"type":"integer","format":"int32"},"lastRowOnPage":{"type":"integer","format":"int32"}}},"Subscriptor":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["externalId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","maxLength":100,"minLength":0},"email":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"name":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"fullName":{"type":"string","maxLength":150,"minLength":0,"nullable":true},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"instruments":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Instrument"}},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscription"}},"links":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Link"}}}}]},"BaseEntity":{"type":"object","additionalProperties":false},"Client":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","legalName","legalId","clientSecret","plexoCommerceId","admin","taxPercentage"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"legalName":{"type":"string","maxLength":150,"minLength":1},"legalId":{"type":"string","maxLength":12,"minLength":1},"clientSecret":{"type":"string","maxLength":50,"minLength":1},"plexoCommerceId":{"type":"integer","format":"int32"},"recurringPaymentUrl":{"type":"string","maxLength":100,"nullable":true},"admin":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationUser"}},"taxPercentage":{"type":"number","format":"decimal","default":22},"subscriptionTypes":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionType"}},"clientIssuers":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ClientIssuer"}},"subscriptors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscriptor"}},"historicData":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/HistoricData"}},"retriesConfiguration":{"$ref":"#/components/schemas/RetriesConfigurationEnum"},"notificationPermissionsId":{"type":"integer","format":"int32"},"notificationPermissions":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NotificationPermissions"}]}}}]},"ApplicationUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUser"},{"type":"object","additionalProperties":false,"properties":{"userType":{"$ref":"#/components/schemas/UserType"},"clientID":{"type":"string","format":"guid"}}}]},"IdentityUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUserOfString"},{"type":"object","description":"The default implementation of IdentityUser`1 which uses a string as a primary key.","additionalProperties":false}]},"IdentityUserOfString":{"type":"object","description":"Represents a user in the identity system","additionalProperties":false,"properties":{"id":{"type":"string","description":"Gets or sets the primary key for this user.","nullable":true},"userName":{"type":"string","description":"Gets or sets the user name for this user.","nullable":true},"normalizedUserName":{"type":"string","description":"Gets or sets the normalized user name for this user.","nullable":true},"email":{"type":"string","description":"Gets or sets the email address for this user.","nullable":true},"normalizedEmail":{"type":"string","description":"Gets or sets the normalized email address for this user.","nullable":true},"emailConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their email address."},"passwordHash":{"type":"string","description":"Gets or sets a salted and hashed representation of the password for this user.","nullable":true},"securityStamp":{"type":"string","description":"A random value that must change whenever a users credentials change (password changed, login removed)","nullable":true},"concurrencyStamp":{"type":"string","description":"A random value that must change whenever a user is persisted to the store","nullable":true},"phoneNumber":{"type":"string","description":"Gets or sets a telephone number for the user.","nullable":true},"phoneNumberConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their telephone address."},"twoFactorEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if two factor authentication is enabled for this user."},"lockoutEnd":{"type":"string","description":"Gets or sets the date and time, in UTC, when any user lockout ends.","format":"date-time","nullable":true},"lockoutEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if the user could be locked out."},"accessFailedCount":{"type":"integer","description":"Gets or sets the number of failed login attempts for the current user.","format":"int32"}}},"UserType":{"type":"integer","description":"","enum":[0,1,2]},"SubscriptionType":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","description","frequence","cost","currency","status","recurrence"],"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","maxLength":50,"minLength":0},"description":{"type":"string","maxLength":120,"minLength":0},"frequence":{"$ref":"#/components/schemas/Frequence"},"cost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"status":{"$ref":"#/components/schemas/SubscriptionTypeStatus"},"recurrence":{"type":"integer","format":"int32","default":0},"taxPercentage":{"type":"number","format":"decimal","nullable":true}}}]},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"SubscriptionTypeStatus":{"type":"integer","description":"","enum":[0,99]},"ClientIssuer":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["issuerId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"issuerId":{"type":"integer","format":"int32"},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]}}}]},"HistoricData":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"date":{"type":"string","format":"date"},"totalSubscriptors":{"type":"integer","format":"int32"}}},"RetriesConfigurationEnum":{"type":"integer","description":"","enum":[0,1]},"NotificationPermissions":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["id"],"properties":{"id":{"type":"integer","format":"int32"},"transactionCancellation":{"type":"boolean"},"subscriptionCancellation":{"type":"boolean"},"subscriptorFields":{"type":"boolean"},"paymentSuccess":{"type":"boolean"},"paymentFailed":{"type":"boolean"},"subcriptioninactiveByPaymentFailure":{"type":"boolean"}}}]},"Instrument":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["subscriptorId","instrumentToken","name","issuerName","issuerImageUrl","expiration","status"],"properties":{"id":{"type":"string","format":"guid"},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"instrumentToken":{"type":"string","format":"guid","minLength":1},"name":{"type":"string","maxLength":50,"minLength":1},"issuerName":{"type":"string","maxLength":50,"minLength":1},"issuerImageUrl":{"type":"string","maxLength":200,"minLength":1},"expiration":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/InstrumentStatus"},"uniqueID":{"type":"string","maxLength":200,"nullable":true},"plexoExtendedResponse":{"type":"string","nullable":true}}}]},"InstrumentStatus":{"type":"integer","description":"","enum":[0,99]},"Subscription":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["token","subscriptionTypeId","date","status","lastPaymentDate","validToDate","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"token":{"type":"string","minLength":1},"subscriptionTypeId":{"type":"integer","format":"int32"},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionType"}]},"date":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/SubscriptionStatus"},"lastPaymentDate":{"type":"string","format":"date","minLength":1},"validToDate":{"type":"string","format":"date","minLength":1},"backgroundJobId":{"type":"string","nullable":true},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"suspendedBy":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SuspendedByEnum"}]},"suspendedDate":{"type":"string","format":"date","nullable":true},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"remainingRecurrences":{"type":"integer","format":"int32","nullable":true}}}]},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"SuspendedByEnum":{"type":"integer","description":"","enum":[0,1]},"Transaction":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["currency","amount","taxedAmount","taxAmount","date","status","retryAttempt","type","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"currency":{"$ref":"#/components/schemas/Currency"},"amount":{"type":"number","format":"decimal"},"taxedAmount":{"type":"number","format":"decimal"},"taxAmount":{"type":"number","format":"decimal"},"date":{"type":"string","format":"date-time","minLength":1},"status":{"$ref":"#/components/schemas/TransactionStatus"},"authorization":{"type":"string","nullable":true},"plexoReferenceId":{"type":"string","nullable":true},"errorText":{"type":"string","nullable":true},"retryAttempt":{"type":"integer","format":"int32","default":1},"plexoClientReference":{"type":"string","nullable":true},"ticket":{"type":"string","nullable":true},"type":{"default":1,"oneOf":[{"$ref":"#/components/schemas/TransactionType"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItemId":{"type":"string","format":"guid","nullable":true},"transactionRequestItem":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestItem"}]},"subscriptionId":{"type":"string","format":"guid","nullable":true},"subscription":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscription"}]},"instrumentId":{"type":"string","format":"guid","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Instrument"}]},"electronicBillingId":{"type":"integer","format":"int32","nullable":true},"electronicBilling":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ElectronicBill"}]}}}]},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionType":{"type":"integer","description":"","enum":[1,2]},"TransactionRequestItem":{"type":"object","additionalProperties":false,"required":["amount","currency","paymentRequestItemStatus","transactionRequestFileId","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"amount":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"paymentRequestItemStatus":{"$ref":"#/components/schemas/PaymentRequestItemStatus"},"transactionRequestFileId":{"type":"string","format":"guid","minLength":1},"transactionRequestFile":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestFile"}]},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"jobId":{"type":"string","nullable":true}}},"PaymentRequestItemStatus":{"type":"integer","description":"","enum":[1,2,3]},"TransactionRequestFile":{"type":"object","additionalProperties":false,"required":["name","url","clientId"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"url":{"type":"string","maxLength":200,"minLength":1},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItems":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionRequestItem"}},"date":{"type":"string","format":"date-time"}}},"ElectronicBill":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["internalId","caeNumber","series","number"],"properties":{"id":{"type":"integer","format":"int32"},"internalId":{"type":"integer","format":"int32"},"caeNumber":{"type":"string","minLength":1},"series":{"type":"string","minLength":1},"number":{"type":"integer","format":"int32"}}}]},"Link":{"type":"object","additionalProperties":false,"required":["externalId","status","clientId","canUpdateSubscriptorData"],"properties":{"id":{"type":"string","format":"guid"},"externalId":{"type":"string","maxLength":150,"minLength":1},"firstName":{"type":"string","maxLength":50,"nullable":true},"lastName":{"type":"string","maxLength":50,"nullable":true},"email":{"type":"string","maxLength":150,"nullable":true},"status":{"default":1,"oneOf":[{"$ref":"#/components/schemas/LinkStatusEnum"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"subscriptorId":{"type":"integer","format":"int32","nullable":true},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"canUpdateSubscriptorData":{"type":"boolean","default":true},"subscriptionTypeId":{"type":"string","nullable":true}}},"LinkStatusEnum":{"type":"integer","description":"","enum":[1,2,3]}}}}
```
## Registrar suscriptor
> Registra un nuevo suscriptor para el cliente especificado. Requiere credenciales válidas del cliente.
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Subscriptors","description":"Endpoints para gestionar suscriptores, suscripciones y operaciones relacionadas."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Subscriptors":{"post":{"tags":["Subscriptors"],"summary":"Registrar suscriptor","description":"Registra un nuevo suscriptor para el cliente especificado. Requiere credenciales válidas del cliente.","operationId":"RegisterSubscriptor","parameters":[{"name":"clientSecret","in":"header","schema":{"type":"string","nullable":true}},{"name":"clientId","in":"header","schema":{"type":"string","nullable":true}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddSubscriptorRequest"}}},"required":true},"responses":{"200":{"description":"Éxito","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscriptor"}}}},"400":{"description":"Solicitud incorrecta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"ClientSecret inválido"}}}}},"components":{"schemas":{"AddSubscriptorRequest":{"type":"object","additionalProperties":false,"properties":{"externalId":{"type":"string","description":"El externalId es el Id del suscriptor dentro del sistema del cliente.","maxLength":100,"nullable":true},"email":{"type":"string","format":"email","maxLength":50,"nullable":true},"name":{"type":"string","maxLength":50,"nullable":true},"fullName":{"type":"string","maxLength":150,"nullable":true},"linkId":{"type":"string","format":"guid","nullable":true}}},"Subscriptor":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["externalId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","maxLength":100,"minLength":0},"email":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"name":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"fullName":{"type":"string","maxLength":150,"minLength":0,"nullable":true},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"instruments":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Instrument"}},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscription"}},"links":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Link"}}}}]},"BaseEntity":{"type":"object","additionalProperties":false},"Client":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","legalName","legalId","clientSecret","plexoCommerceId","admin","taxPercentage"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"legalName":{"type":"string","maxLength":150,"minLength":1},"legalId":{"type":"string","maxLength":12,"minLength":1},"clientSecret":{"type":"string","maxLength":50,"minLength":1},"plexoCommerceId":{"type":"integer","format":"int32"},"recurringPaymentUrl":{"type":"string","maxLength":100,"nullable":true},"admin":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationUser"}},"taxPercentage":{"type":"number","format":"decimal","default":22},"subscriptionTypes":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionType"}},"clientIssuers":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ClientIssuer"}},"subscriptors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscriptor"}},"historicData":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/HistoricData"}},"retriesConfiguration":{"$ref":"#/components/schemas/RetriesConfigurationEnum"},"notificationPermissionsId":{"type":"integer","format":"int32"},"notificationPermissions":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NotificationPermissions"}]}}}]},"ApplicationUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUser"},{"type":"object","additionalProperties":false,"properties":{"userType":{"$ref":"#/components/schemas/UserType"},"clientID":{"type":"string","format":"guid"}}}]},"IdentityUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUserOfString"},{"type":"object","description":"The default implementation of IdentityUser`1 which uses a string as a primary key.","additionalProperties":false}]},"IdentityUserOfString":{"type":"object","description":"Represents a user in the identity system","additionalProperties":false,"properties":{"id":{"type":"string","description":"Gets or sets the primary key for this user.","nullable":true},"userName":{"type":"string","description":"Gets or sets the user name for this user.","nullable":true},"normalizedUserName":{"type":"string","description":"Gets or sets the normalized user name for this user.","nullable":true},"email":{"type":"string","description":"Gets or sets the email address for this user.","nullable":true},"normalizedEmail":{"type":"string","description":"Gets or sets the normalized email address for this user.","nullable":true},"emailConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their email address."},"passwordHash":{"type":"string","description":"Gets or sets a salted and hashed representation of the password for this user.","nullable":true},"securityStamp":{"type":"string","description":"A random value that must change whenever a users credentials change (password changed, login removed)","nullable":true},"concurrencyStamp":{"type":"string","description":"A random value that must change whenever a user is persisted to the store","nullable":true},"phoneNumber":{"type":"string","description":"Gets or sets a telephone number for the user.","nullable":true},"phoneNumberConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their telephone address."},"twoFactorEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if two factor authentication is enabled for this user."},"lockoutEnd":{"type":"string","description":"Gets or sets the date and time, in UTC, when any user lockout ends.","format":"date-time","nullable":true},"lockoutEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if the user could be locked out."},"accessFailedCount":{"type":"integer","description":"Gets or sets the number of failed login attempts for the current user.","format":"int32"}}},"UserType":{"type":"integer","description":"","enum":[0,1,2]},"SubscriptionType":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","description","frequence","cost","currency","status","recurrence"],"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","maxLength":50,"minLength":0},"description":{"type":"string","maxLength":120,"minLength":0},"frequence":{"$ref":"#/components/schemas/Frequence"},"cost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"status":{"$ref":"#/components/schemas/SubscriptionTypeStatus"},"recurrence":{"type":"integer","format":"int32","default":0},"taxPercentage":{"type":"number","format":"decimal","nullable":true}}}]},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"SubscriptionTypeStatus":{"type":"integer","description":"","enum":[0,99]},"ClientIssuer":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["issuerId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"issuerId":{"type":"integer","format":"int32"},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]}}}]},"HistoricData":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"date":{"type":"string","format":"date"},"totalSubscriptors":{"type":"integer","format":"int32"}}},"RetriesConfigurationEnum":{"type":"integer","description":"","enum":[0,1]},"NotificationPermissions":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["id"],"properties":{"id":{"type":"integer","format":"int32"},"transactionCancellation":{"type":"boolean"},"subscriptionCancellation":{"type":"boolean"},"subscriptorFields":{"type":"boolean"},"paymentSuccess":{"type":"boolean"},"paymentFailed":{"type":"boolean"},"subcriptioninactiveByPaymentFailure":{"type":"boolean"}}}]},"Instrument":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["subscriptorId","instrumentToken","name","issuerName","issuerImageUrl","expiration","status"],"properties":{"id":{"type":"string","format":"guid"},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"instrumentToken":{"type":"string","format":"guid","minLength":1},"name":{"type":"string","maxLength":50,"minLength":1},"issuerName":{"type":"string","maxLength":50,"minLength":1},"issuerImageUrl":{"type":"string","maxLength":200,"minLength":1},"expiration":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/InstrumentStatus"},"uniqueID":{"type":"string","maxLength":200,"nullable":true},"plexoExtendedResponse":{"type":"string","nullable":true}}}]},"InstrumentStatus":{"type":"integer","description":"","enum":[0,99]},"Subscription":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["token","subscriptionTypeId","date","status","lastPaymentDate","validToDate","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"token":{"type":"string","minLength":1},"subscriptionTypeId":{"type":"integer","format":"int32"},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionType"}]},"date":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/SubscriptionStatus"},"lastPaymentDate":{"type":"string","format":"date","minLength":1},"validToDate":{"type":"string","format":"date","minLength":1},"backgroundJobId":{"type":"string","nullable":true},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"suspendedBy":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SuspendedByEnum"}]},"suspendedDate":{"type":"string","format":"date","nullable":true},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"remainingRecurrences":{"type":"integer","format":"int32","nullable":true}}}]},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"SuspendedByEnum":{"type":"integer","description":"","enum":[0,1]},"Transaction":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["currency","amount","taxedAmount","taxAmount","date","status","retryAttempt","type","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"currency":{"$ref":"#/components/schemas/Currency"},"amount":{"type":"number","format":"decimal"},"taxedAmount":{"type":"number","format":"decimal"},"taxAmount":{"type":"number","format":"decimal"},"date":{"type":"string","format":"date-time","minLength":1},"status":{"$ref":"#/components/schemas/TransactionStatus"},"authorization":{"type":"string","nullable":true},"plexoReferenceId":{"type":"string","nullable":true},"errorText":{"type":"string","nullable":true},"retryAttempt":{"type":"integer","format":"int32","default":1},"plexoClientReference":{"type":"string","nullable":true},"ticket":{"type":"string","nullable":true},"type":{"default":1,"oneOf":[{"$ref":"#/components/schemas/TransactionType"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItemId":{"type":"string","format":"guid","nullable":true},"transactionRequestItem":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestItem"}]},"subscriptionId":{"type":"string","format":"guid","nullable":true},"subscription":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscription"}]},"instrumentId":{"type":"string","format":"guid","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Instrument"}]},"electronicBillingId":{"type":"integer","format":"int32","nullable":true},"electronicBilling":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ElectronicBill"}]}}}]},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionType":{"type":"integer","description":"","enum":[1,2]},"TransactionRequestItem":{"type":"object","additionalProperties":false,"required":["amount","currency","paymentRequestItemStatus","transactionRequestFileId","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"amount":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"paymentRequestItemStatus":{"$ref":"#/components/schemas/PaymentRequestItemStatus"},"transactionRequestFileId":{"type":"string","format":"guid","minLength":1},"transactionRequestFile":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestFile"}]},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"jobId":{"type":"string","nullable":true}}},"PaymentRequestItemStatus":{"type":"integer","description":"","enum":[1,2,3]},"TransactionRequestFile":{"type":"object","additionalProperties":false,"required":["name","url","clientId"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"url":{"type":"string","maxLength":200,"minLength":1},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItems":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionRequestItem"}},"date":{"type":"string","format":"date-time"}}},"ElectronicBill":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["internalId","caeNumber","series","number"],"properties":{"id":{"type":"integer","format":"int32"},"internalId":{"type":"integer","format":"int32"},"caeNumber":{"type":"string","minLength":1},"series":{"type":"string","minLength":1},"number":{"type":"integer","format":"int32"}}}]},"Link":{"type":"object","additionalProperties":false,"required":["externalId","status","clientId","canUpdateSubscriptorData"],"properties":{"id":{"type":"string","format":"guid"},"externalId":{"type":"string","maxLength":150,"minLength":1},"firstName":{"type":"string","maxLength":50,"nullable":true},"lastName":{"type":"string","maxLength":50,"nullable":true},"email":{"type":"string","maxLength":150,"nullable":true},"status":{"default":1,"oneOf":[{"$ref":"#/components/schemas/LinkStatusEnum"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"subscriptorId":{"type":"integer","format":"int32","nullable":true},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"canUpdateSubscriptorData":{"type":"boolean","default":true},"subscriptionTypeId":{"type":"string","nullable":true}}},"LinkStatusEnum":{"type":"integer","description":"","enum":[1,2,3]},"ErrorResponse":{"type":"object","additionalProperties":false,"properties":{"code":{"$ref":"#/components/schemas/HttpStatusCode"},"message":{"type":"string","nullable":true},"subCode":{"type":"integer","format":"int32"}}},"HttpStatusCode":{"type":"integer","description":"包含針對 HTTP 所定義的狀態碼值。","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,300,301,301,302,302,303,303,304,305,306,307,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511]}}}}
```
## Registro público vía link
> Registra un suscriptor usando el contexto de un link público. No requiere cabeceras del cliente.
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Subscriptors","description":"Endpoints para gestionar suscriptores, suscripciones y operaciones relacionadas."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Subscriptors/link":{"post":{"tags":["Subscriptors"],"summary":"Registro público vía link","description":"Registra un suscriptor usando el contexto de un link público. No requiere cabeceras del cliente.","operationId":"RegisterSubscriptorLink","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddSubscriptorLinkRequest"}}},"required":true},"responses":{"200":{"description":"Éxito","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscriptor"}}}},"400":{"description":"Solicitud incorrecta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"ClientSecret inválido"}}}}},"components":{"schemas":{"AddSubscriptorLinkRequest":{"type":"object","additionalProperties":false,"properties":{"externalId":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"fullName":{"type":"string","nullable":true},"linkId":{"type":"string","format":"guid"}}},"Subscriptor":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["externalId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","maxLength":100,"minLength":0},"email":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"name":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"fullName":{"type":"string","maxLength":150,"minLength":0,"nullable":true},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"instruments":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Instrument"}},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscription"}},"links":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Link"}}}}]},"BaseEntity":{"type":"object","additionalProperties":false},"Client":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","legalName","legalId","clientSecret","plexoCommerceId","admin","taxPercentage"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"legalName":{"type":"string","maxLength":150,"minLength":1},"legalId":{"type":"string","maxLength":12,"minLength":1},"clientSecret":{"type":"string","maxLength":50,"minLength":1},"plexoCommerceId":{"type":"integer","format":"int32"},"recurringPaymentUrl":{"type":"string","maxLength":100,"nullable":true},"admin":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationUser"}},"taxPercentage":{"type":"number","format":"decimal","default":22},"subscriptionTypes":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionType"}},"clientIssuers":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ClientIssuer"}},"subscriptors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscriptor"}},"historicData":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/HistoricData"}},"retriesConfiguration":{"$ref":"#/components/schemas/RetriesConfigurationEnum"},"notificationPermissionsId":{"type":"integer","format":"int32"},"notificationPermissions":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NotificationPermissions"}]}}}]},"ApplicationUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUser"},{"type":"object","additionalProperties":false,"properties":{"userType":{"$ref":"#/components/schemas/UserType"},"clientID":{"type":"string","format":"guid"}}}]},"IdentityUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUserOfString"},{"type":"object","description":"The default implementation of IdentityUser`1 which uses a string as a primary key.","additionalProperties":false}]},"IdentityUserOfString":{"type":"object","description":"Represents a user in the identity system","additionalProperties":false,"properties":{"id":{"type":"string","description":"Gets or sets the primary key for this user.","nullable":true},"userName":{"type":"string","description":"Gets or sets the user name for this user.","nullable":true},"normalizedUserName":{"type":"string","description":"Gets or sets the normalized user name for this user.","nullable":true},"email":{"type":"string","description":"Gets or sets the email address for this user.","nullable":true},"normalizedEmail":{"type":"string","description":"Gets or sets the normalized email address for this user.","nullable":true},"emailConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their email address."},"passwordHash":{"type":"string","description":"Gets or sets a salted and hashed representation of the password for this user.","nullable":true},"securityStamp":{"type":"string","description":"A random value that must change whenever a users credentials change (password changed, login removed)","nullable":true},"concurrencyStamp":{"type":"string","description":"A random value that must change whenever a user is persisted to the store","nullable":true},"phoneNumber":{"type":"string","description":"Gets or sets a telephone number for the user.","nullable":true},"phoneNumberConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their telephone address."},"twoFactorEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if two factor authentication is enabled for this user."},"lockoutEnd":{"type":"string","description":"Gets or sets the date and time, in UTC, when any user lockout ends.","format":"date-time","nullable":true},"lockoutEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if the user could be locked out."},"accessFailedCount":{"type":"integer","description":"Gets or sets the number of failed login attempts for the current user.","format":"int32"}}},"UserType":{"type":"integer","description":"","enum":[0,1,2]},"SubscriptionType":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","description","frequence","cost","currency","status","recurrence"],"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","maxLength":50,"minLength":0},"description":{"type":"string","maxLength":120,"minLength":0},"frequence":{"$ref":"#/components/schemas/Frequence"},"cost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"status":{"$ref":"#/components/schemas/SubscriptionTypeStatus"},"recurrence":{"type":"integer","format":"int32","default":0},"taxPercentage":{"type":"number","format":"decimal","nullable":true}}}]},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"SubscriptionTypeStatus":{"type":"integer","description":"","enum":[0,99]},"ClientIssuer":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["issuerId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"issuerId":{"type":"integer","format":"int32"},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]}}}]},"HistoricData":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"date":{"type":"string","format":"date"},"totalSubscriptors":{"type":"integer","format":"int32"}}},"RetriesConfigurationEnum":{"type":"integer","description":"","enum":[0,1]},"NotificationPermissions":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["id"],"properties":{"id":{"type":"integer","format":"int32"},"transactionCancellation":{"type":"boolean"},"subscriptionCancellation":{"type":"boolean"},"subscriptorFields":{"type":"boolean"},"paymentSuccess":{"type":"boolean"},"paymentFailed":{"type":"boolean"},"subcriptioninactiveByPaymentFailure":{"type":"boolean"}}}]},"Instrument":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["subscriptorId","instrumentToken","name","issuerName","issuerImageUrl","expiration","status"],"properties":{"id":{"type":"string","format":"guid"},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"instrumentToken":{"type":"string","format":"guid","minLength":1},"name":{"type":"string","maxLength":50,"minLength":1},"issuerName":{"type":"string","maxLength":50,"minLength":1},"issuerImageUrl":{"type":"string","maxLength":200,"minLength":1},"expiration":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/InstrumentStatus"},"uniqueID":{"type":"string","maxLength":200,"nullable":true},"plexoExtendedResponse":{"type":"string","nullable":true}}}]},"InstrumentStatus":{"type":"integer","description":"","enum":[0,99]},"Subscription":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["token","subscriptionTypeId","date","status","lastPaymentDate","validToDate","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"token":{"type":"string","minLength":1},"subscriptionTypeId":{"type":"integer","format":"int32"},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionType"}]},"date":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/SubscriptionStatus"},"lastPaymentDate":{"type":"string","format":"date","minLength":1},"validToDate":{"type":"string","format":"date","minLength":1},"backgroundJobId":{"type":"string","nullable":true},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"suspendedBy":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SuspendedByEnum"}]},"suspendedDate":{"type":"string","format":"date","nullable":true},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"remainingRecurrences":{"type":"integer","format":"int32","nullable":true}}}]},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"SuspendedByEnum":{"type":"integer","description":"","enum":[0,1]},"Transaction":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["currency","amount","taxedAmount","taxAmount","date","status","retryAttempt","type","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"currency":{"$ref":"#/components/schemas/Currency"},"amount":{"type":"number","format":"decimal"},"taxedAmount":{"type":"number","format":"decimal"},"taxAmount":{"type":"number","format":"decimal"},"date":{"type":"string","format":"date-time","minLength":1},"status":{"$ref":"#/components/schemas/TransactionStatus"},"authorization":{"type":"string","nullable":true},"plexoReferenceId":{"type":"string","nullable":true},"errorText":{"type":"string","nullable":true},"retryAttempt":{"type":"integer","format":"int32","default":1},"plexoClientReference":{"type":"string","nullable":true},"ticket":{"type":"string","nullable":true},"type":{"default":1,"oneOf":[{"$ref":"#/components/schemas/TransactionType"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItemId":{"type":"string","format":"guid","nullable":true},"transactionRequestItem":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestItem"}]},"subscriptionId":{"type":"string","format":"guid","nullable":true},"subscription":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscription"}]},"instrumentId":{"type":"string","format":"guid","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Instrument"}]},"electronicBillingId":{"type":"integer","format":"int32","nullable":true},"electronicBilling":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ElectronicBill"}]}}}]},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionType":{"type":"integer","description":"","enum":[1,2]},"TransactionRequestItem":{"type":"object","additionalProperties":false,"required":["amount","currency","paymentRequestItemStatus","transactionRequestFileId","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"amount":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"paymentRequestItemStatus":{"$ref":"#/components/schemas/PaymentRequestItemStatus"},"transactionRequestFileId":{"type":"string","format":"guid","minLength":1},"transactionRequestFile":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestFile"}]},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"jobId":{"type":"string","nullable":true}}},"PaymentRequestItemStatus":{"type":"integer","description":"","enum":[1,2,3]},"TransactionRequestFile":{"type":"object","additionalProperties":false,"required":["name","url","clientId"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"url":{"type":"string","maxLength":200,"minLength":1},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItems":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionRequestItem"}},"date":{"type":"string","format":"date-time"}}},"ElectronicBill":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["internalId","caeNumber","series","number"],"properties":{"id":{"type":"integer","format":"int32"},"internalId":{"type":"integer","format":"int32"},"caeNumber":{"type":"string","minLength":1},"series":{"type":"string","minLength":1},"number":{"type":"integer","format":"int32"}}}]},"Link":{"type":"object","additionalProperties":false,"required":["externalId","status","clientId","canUpdateSubscriptorData"],"properties":{"id":{"type":"string","format":"guid"},"externalId":{"type":"string","maxLength":150,"minLength":1},"firstName":{"type":"string","maxLength":50,"nullable":true},"lastName":{"type":"string","maxLength":50,"nullable":true},"email":{"type":"string","maxLength":150,"nullable":true},"status":{"default":1,"oneOf":[{"$ref":"#/components/schemas/LinkStatusEnum"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"subscriptorId":{"type":"integer","format":"int32","nullable":true},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"canUpdateSubscriptorData":{"type":"boolean","default":true},"subscriptionTypeId":{"type":"string","nullable":true}}},"LinkStatusEnum":{"type":"integer","description":"","enum":[1,2,3]},"ErrorResponse":{"type":"object","additionalProperties":false,"properties":{"code":{"$ref":"#/components/schemas/HttpStatusCode"},"message":{"type":"string","nullable":true},"subCode":{"type":"integer","format":"int32"}}},"HttpStatusCode":{"type":"integer","description":"包含針對 HTTP 所定義的狀態碼值。","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,300,301,301,302,302,303,303,304,305,306,307,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511]}}}}
```
## Exportar todos los suscriptores
> Devuelve la lista completa de suscriptores para usos de BackOffice (sin paginación).
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Subscriptors","description":"Endpoints para gestionar suscriptores, suscripciones y operaciones relacionadas."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Subscriptors/export":{"get":{"tags":["Subscriptors"],"summary":"Exportar todos los suscriptores","description":"Devuelve la lista completa de suscriptores para usos de BackOffice (sin paginación).","operationId":"ExportSubscriptors","parameters":[{"name":"Page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"Limit","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"SubscriptorEmailOrNameOrId","in":"query","schema":{"type":"string","nullable":true}},{"name":"SubscriptorsState","in":"query","schema":{"$ref":"#/components/schemas/SubscriptorsQueryState"}},{"name":"SubscriptionTypes","in":"query","schema":{"type":"string","nullable":true}},{"name":"ActiveOnly","in":"query","schema":{"type":"boolean","nullable":true}}],"responses":{"200":{"description":"Éxito","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Subscriptor"}}}}},"204":{"description":"Sin contenido"},"404":{"description":"ClientSecret inválido"}}}}},"components":{"schemas":{"SubscriptorsQueryState":{"type":"integer","description":"","enum":[0,1,2]},"Subscriptor":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["externalId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","maxLength":100,"minLength":0},"email":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"name":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"fullName":{"type":"string","maxLength":150,"minLength":0,"nullable":true},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"instruments":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Instrument"}},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscription"}},"links":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Link"}}}}]},"BaseEntity":{"type":"object","additionalProperties":false},"Client":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","legalName","legalId","clientSecret","plexoCommerceId","admin","taxPercentage"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"legalName":{"type":"string","maxLength":150,"minLength":1},"legalId":{"type":"string","maxLength":12,"minLength":1},"clientSecret":{"type":"string","maxLength":50,"minLength":1},"plexoCommerceId":{"type":"integer","format":"int32"},"recurringPaymentUrl":{"type":"string","maxLength":100,"nullable":true},"admin":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationUser"}},"taxPercentage":{"type":"number","format":"decimal","default":22},"subscriptionTypes":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionType"}},"clientIssuers":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ClientIssuer"}},"subscriptors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscriptor"}},"historicData":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/HistoricData"}},"retriesConfiguration":{"$ref":"#/components/schemas/RetriesConfigurationEnum"},"notificationPermissionsId":{"type":"integer","format":"int32"},"notificationPermissions":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NotificationPermissions"}]}}}]},"ApplicationUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUser"},{"type":"object","additionalProperties":false,"properties":{"userType":{"$ref":"#/components/schemas/UserType"},"clientID":{"type":"string","format":"guid"}}}]},"IdentityUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUserOfString"},{"type":"object","description":"The default implementation of IdentityUser`1 which uses a string as a primary key.","additionalProperties":false}]},"IdentityUserOfString":{"type":"object","description":"Represents a user in the identity system","additionalProperties":false,"properties":{"id":{"type":"string","description":"Gets or sets the primary key for this user.","nullable":true},"userName":{"type":"string","description":"Gets or sets the user name for this user.","nullable":true},"normalizedUserName":{"type":"string","description":"Gets or sets the normalized user name for this user.","nullable":true},"email":{"type":"string","description":"Gets or sets the email address for this user.","nullable":true},"normalizedEmail":{"type":"string","description":"Gets or sets the normalized email address for this user.","nullable":true},"emailConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their email address."},"passwordHash":{"type":"string","description":"Gets or sets a salted and hashed representation of the password for this user.","nullable":true},"securityStamp":{"type":"string","description":"A random value that must change whenever a users credentials change (password changed, login removed)","nullable":true},"concurrencyStamp":{"type":"string","description":"A random value that must change whenever a user is persisted to the store","nullable":true},"phoneNumber":{"type":"string","description":"Gets or sets a telephone number for the user.","nullable":true},"phoneNumberConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their telephone address."},"twoFactorEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if two factor authentication is enabled for this user."},"lockoutEnd":{"type":"string","description":"Gets or sets the date and time, in UTC, when any user lockout ends.","format":"date-time","nullable":true},"lockoutEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if the user could be locked out."},"accessFailedCount":{"type":"integer","description":"Gets or sets the number of failed login attempts for the current user.","format":"int32"}}},"UserType":{"type":"integer","description":"","enum":[0,1,2]},"SubscriptionType":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","description","frequence","cost","currency","status","recurrence"],"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","maxLength":50,"minLength":0},"description":{"type":"string","maxLength":120,"minLength":0},"frequence":{"$ref":"#/components/schemas/Frequence"},"cost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"status":{"$ref":"#/components/schemas/SubscriptionTypeStatus"},"recurrence":{"type":"integer","format":"int32","default":0},"taxPercentage":{"type":"number","format":"decimal","nullable":true}}}]},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"SubscriptionTypeStatus":{"type":"integer","description":"","enum":[0,99]},"ClientIssuer":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["issuerId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"issuerId":{"type":"integer","format":"int32"},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]}}}]},"HistoricData":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"date":{"type":"string","format":"date"},"totalSubscriptors":{"type":"integer","format":"int32"}}},"RetriesConfigurationEnum":{"type":"integer","description":"","enum":[0,1]},"NotificationPermissions":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["id"],"properties":{"id":{"type":"integer","format":"int32"},"transactionCancellation":{"type":"boolean"},"subscriptionCancellation":{"type":"boolean"},"subscriptorFields":{"type":"boolean"},"paymentSuccess":{"type":"boolean"},"paymentFailed":{"type":"boolean"},"subcriptioninactiveByPaymentFailure":{"type":"boolean"}}}]},"Instrument":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["subscriptorId","instrumentToken","name","issuerName","issuerImageUrl","expiration","status"],"properties":{"id":{"type":"string","format":"guid"},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"instrumentToken":{"type":"string","format":"guid","minLength":1},"name":{"type":"string","maxLength":50,"minLength":1},"issuerName":{"type":"string","maxLength":50,"minLength":1},"issuerImageUrl":{"type":"string","maxLength":200,"minLength":1},"expiration":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/InstrumentStatus"},"uniqueID":{"type":"string","maxLength":200,"nullable":true},"plexoExtendedResponse":{"type":"string","nullable":true}}}]},"InstrumentStatus":{"type":"integer","description":"","enum":[0,99]},"Subscription":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["token","subscriptionTypeId","date","status","lastPaymentDate","validToDate","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"token":{"type":"string","minLength":1},"subscriptionTypeId":{"type":"integer","format":"int32"},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionType"}]},"date":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/SubscriptionStatus"},"lastPaymentDate":{"type":"string","format":"date","minLength":1},"validToDate":{"type":"string","format":"date","minLength":1},"backgroundJobId":{"type":"string","nullable":true},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"suspendedBy":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SuspendedByEnum"}]},"suspendedDate":{"type":"string","format":"date","nullable":true},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"remainingRecurrences":{"type":"integer","format":"int32","nullable":true}}}]},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"SuspendedByEnum":{"type":"integer","description":"","enum":[0,1]},"Transaction":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["currency","amount","taxedAmount","taxAmount","date","status","retryAttempt","type","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"currency":{"$ref":"#/components/schemas/Currency"},"amount":{"type":"number","format":"decimal"},"taxedAmount":{"type":"number","format":"decimal"},"taxAmount":{"type":"number","format":"decimal"},"date":{"type":"string","format":"date-time","minLength":1},"status":{"$ref":"#/components/schemas/TransactionStatus"},"authorization":{"type":"string","nullable":true},"plexoReferenceId":{"type":"string","nullable":true},"errorText":{"type":"string","nullable":true},"retryAttempt":{"type":"integer","format":"int32","default":1},"plexoClientReference":{"type":"string","nullable":true},"ticket":{"type":"string","nullable":true},"type":{"default":1,"oneOf":[{"$ref":"#/components/schemas/TransactionType"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItemId":{"type":"string","format":"guid","nullable":true},"transactionRequestItem":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestItem"}]},"subscriptionId":{"type":"string","format":"guid","nullable":true},"subscription":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscription"}]},"instrumentId":{"type":"string","format":"guid","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Instrument"}]},"electronicBillingId":{"type":"integer","format":"int32","nullable":true},"electronicBilling":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ElectronicBill"}]}}}]},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionType":{"type":"integer","description":"","enum":[1,2]},"TransactionRequestItem":{"type":"object","additionalProperties":false,"required":["amount","currency","paymentRequestItemStatus","transactionRequestFileId","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"amount":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"paymentRequestItemStatus":{"$ref":"#/components/schemas/PaymentRequestItemStatus"},"transactionRequestFileId":{"type":"string","format":"guid","minLength":1},"transactionRequestFile":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestFile"}]},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"jobId":{"type":"string","nullable":true}}},"PaymentRequestItemStatus":{"type":"integer","description":"","enum":[1,2,3]},"TransactionRequestFile":{"type":"object","additionalProperties":false,"required":["name","url","clientId"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"url":{"type":"string","maxLength":200,"minLength":1},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItems":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionRequestItem"}},"date":{"type":"string","format":"date-time"}}},"ElectronicBill":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["internalId","caeNumber","series","number"],"properties":{"id":{"type":"integer","format":"int32"},"internalId":{"type":"integer","format":"int32"},"caeNumber":{"type":"string","minLength":1},"series":{"type":"string","minLength":1},"number":{"type":"integer","format":"int32"}}}]},"Link":{"type":"object","additionalProperties":false,"required":["externalId","status","clientId","canUpdateSubscriptorData"],"properties":{"id":{"type":"string","format":"guid"},"externalId":{"type":"string","maxLength":150,"minLength":1},"firstName":{"type":"string","maxLength":50,"nullable":true},"lastName":{"type":"string","maxLength":50,"nullable":true},"email":{"type":"string","maxLength":150,"nullable":true},"status":{"default":1,"oneOf":[{"$ref":"#/components/schemas/LinkStatusEnum"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"subscriptorId":{"type":"integer","format":"int32","nullable":true},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"canUpdateSubscriptorData":{"type":"boolean","default":true},"subscriptionTypeId":{"type":"string","nullable":true}}},"LinkStatusEnum":{"type":"integer","description":"","enum":[1,2,3]}}}}
```
## Listar suscripciones del suscriptor
> Devuelve todas las suscripciones de un suscriptor identificado por externalId.
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Subscriptors","description":"Endpoints para gestionar suscriptores, suscripciones y operaciones relacionadas."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Subscriptors/subscriptions":{"get":{"tags":["Subscriptors"],"summary":"Listar suscripciones del suscriptor","description":"Devuelve todas las suscripciones de un suscriptor identificado por externalId.","operationId":"GetUserSubscriptions","parameters":[{"name":"clientSecret","in":"header","schema":{"type":"string","nullable":true}},{"name":"clientId","in":"header","schema":{"type":"string","nullable":true}},{"name":"externalId","in":"header","schema":{"type":"string","nullable":true}}],"responses":{"200":{"description":"Éxito","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Subscription"}}}}},"204":{"description":"Sin contenido"},"400":{"description":"Solicitud incorrecta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"ClientSecret inválido"}}}}},"components":{"schemas":{"Subscription":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["token","subscriptionTypeId","date","status","lastPaymentDate","validToDate","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"token":{"type":"string","minLength":1},"subscriptionTypeId":{"type":"integer","format":"int32"},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionType"}]},"date":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/SubscriptionStatus"},"lastPaymentDate":{"type":"string","format":"date","minLength":1},"validToDate":{"type":"string","format":"date","minLength":1},"backgroundJobId":{"type":"string","nullable":true},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"suspendedBy":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SuspendedByEnum"}]},"suspendedDate":{"type":"string","format":"date","nullable":true},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"remainingRecurrences":{"type":"integer","format":"int32","nullable":true}}}]},"BaseEntity":{"type":"object","additionalProperties":false},"SubscriptionType":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","description","frequence","cost","currency","status","recurrence"],"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","maxLength":50,"minLength":0},"description":{"type":"string","maxLength":120,"minLength":0},"frequence":{"$ref":"#/components/schemas/Frequence"},"cost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"status":{"$ref":"#/components/schemas/SubscriptionTypeStatus"},"recurrence":{"type":"integer","format":"int32","default":0},"taxPercentage":{"type":"number","format":"decimal","nullable":true}}}]},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"SubscriptionTypeStatus":{"type":"integer","description":"","enum":[0,99]},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"Subscriptor":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["externalId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","maxLength":100,"minLength":0},"email":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"name":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"fullName":{"type":"string","maxLength":150,"minLength":0,"nullable":true},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"instruments":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Instrument"}},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscription"}},"links":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Link"}}}}]},"Client":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","legalName","legalId","clientSecret","plexoCommerceId","admin","taxPercentage"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"legalName":{"type":"string","maxLength":150,"minLength":1},"legalId":{"type":"string","maxLength":12,"minLength":1},"clientSecret":{"type":"string","maxLength":50,"minLength":1},"plexoCommerceId":{"type":"integer","format":"int32"},"recurringPaymentUrl":{"type":"string","maxLength":100,"nullable":true},"admin":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationUser"}},"taxPercentage":{"type":"number","format":"decimal","default":22},"subscriptionTypes":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionType"}},"clientIssuers":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ClientIssuer"}},"subscriptors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscriptor"}},"historicData":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/HistoricData"}},"retriesConfiguration":{"$ref":"#/components/schemas/RetriesConfigurationEnum"},"notificationPermissionsId":{"type":"integer","format":"int32"},"notificationPermissions":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NotificationPermissions"}]}}}]},"ApplicationUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUser"},{"type":"object","additionalProperties":false,"properties":{"userType":{"$ref":"#/components/schemas/UserType"},"clientID":{"type":"string","format":"guid"}}}]},"IdentityUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUserOfString"},{"type":"object","description":"The default implementation of IdentityUser`1 which uses a string as a primary key.","additionalProperties":false}]},"IdentityUserOfString":{"type":"object","description":"Represents a user in the identity system","additionalProperties":false,"properties":{"id":{"type":"string","description":"Gets or sets the primary key for this user.","nullable":true},"userName":{"type":"string","description":"Gets or sets the user name for this user.","nullable":true},"normalizedUserName":{"type":"string","description":"Gets or sets the normalized user name for this user.","nullable":true},"email":{"type":"string","description":"Gets or sets the email address for this user.","nullable":true},"normalizedEmail":{"type":"string","description":"Gets or sets the normalized email address for this user.","nullable":true},"emailConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their email address."},"passwordHash":{"type":"string","description":"Gets or sets a salted and hashed representation of the password for this user.","nullable":true},"securityStamp":{"type":"string","description":"A random value that must change whenever a users credentials change (password changed, login removed)","nullable":true},"concurrencyStamp":{"type":"string","description":"A random value that must change whenever a user is persisted to the store","nullable":true},"phoneNumber":{"type":"string","description":"Gets or sets a telephone number for the user.","nullable":true},"phoneNumberConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their telephone address."},"twoFactorEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if two factor authentication is enabled for this user."},"lockoutEnd":{"type":"string","description":"Gets or sets the date and time, in UTC, when any user lockout ends.","format":"date-time","nullable":true},"lockoutEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if the user could be locked out."},"accessFailedCount":{"type":"integer","description":"Gets or sets the number of failed login attempts for the current user.","format":"int32"}}},"UserType":{"type":"integer","description":"","enum":[0,1,2]},"ClientIssuer":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["issuerId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"issuerId":{"type":"integer","format":"int32"},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]}}}]},"HistoricData":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"date":{"type":"string","format":"date"},"totalSubscriptors":{"type":"integer","format":"int32"}}},"RetriesConfigurationEnum":{"type":"integer","description":"","enum":[0,1]},"NotificationPermissions":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["id"],"properties":{"id":{"type":"integer","format":"int32"},"transactionCancellation":{"type":"boolean"},"subscriptionCancellation":{"type":"boolean"},"subscriptorFields":{"type":"boolean"},"paymentSuccess":{"type":"boolean"},"paymentFailed":{"type":"boolean"},"subcriptioninactiveByPaymentFailure":{"type":"boolean"}}}]},"Instrument":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["subscriptorId","instrumentToken","name","issuerName","issuerImageUrl","expiration","status"],"properties":{"id":{"type":"string","format":"guid"},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"instrumentToken":{"type":"string","format":"guid","minLength":1},"name":{"type":"string","maxLength":50,"minLength":1},"issuerName":{"type":"string","maxLength":50,"minLength":1},"issuerImageUrl":{"type":"string","maxLength":200,"minLength":1},"expiration":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/InstrumentStatus"},"uniqueID":{"type":"string","maxLength":200,"nullable":true},"plexoExtendedResponse":{"type":"string","nullable":true}}}]},"InstrumentStatus":{"type":"integer","description":"","enum":[0,99]},"Link":{"type":"object","additionalProperties":false,"required":["externalId","status","clientId","canUpdateSubscriptorData"],"properties":{"id":{"type":"string","format":"guid"},"externalId":{"type":"string","maxLength":150,"minLength":1},"firstName":{"type":"string","maxLength":50,"nullable":true},"lastName":{"type":"string","maxLength":50,"nullable":true},"email":{"type":"string","maxLength":150,"nullable":true},"status":{"default":1,"oneOf":[{"$ref":"#/components/schemas/LinkStatusEnum"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"subscriptorId":{"type":"integer","format":"int32","nullable":true},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"canUpdateSubscriptorData":{"type":"boolean","default":true},"subscriptionTypeId":{"type":"string","nullable":true}}},"LinkStatusEnum":{"type":"integer","description":"","enum":[1,2,3]},"SuspendedByEnum":{"type":"integer","description":"","enum":[0,1]},"Transaction":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["currency","amount","taxedAmount","taxAmount","date","status","retryAttempt","type","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"currency":{"$ref":"#/components/schemas/Currency"},"amount":{"type":"number","format":"decimal"},"taxedAmount":{"type":"number","format":"decimal"},"taxAmount":{"type":"number","format":"decimal"},"date":{"type":"string","format":"date-time","minLength":1},"status":{"$ref":"#/components/schemas/TransactionStatus"},"authorization":{"type":"string","nullable":true},"plexoReferenceId":{"type":"string","nullable":true},"errorText":{"type":"string","nullable":true},"retryAttempt":{"type":"integer","format":"int32","default":1},"plexoClientReference":{"type":"string","nullable":true},"ticket":{"type":"string","nullable":true},"type":{"default":1,"oneOf":[{"$ref":"#/components/schemas/TransactionType"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItemId":{"type":"string","format":"guid","nullable":true},"transactionRequestItem":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestItem"}]},"subscriptionId":{"type":"string","format":"guid","nullable":true},"subscription":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscription"}]},"instrumentId":{"type":"string","format":"guid","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Instrument"}]},"electronicBillingId":{"type":"integer","format":"int32","nullable":true},"electronicBilling":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ElectronicBill"}]}}}]},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionType":{"type":"integer","description":"","enum":[1,2]},"TransactionRequestItem":{"type":"object","additionalProperties":false,"required":["amount","currency","paymentRequestItemStatus","transactionRequestFileId","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"amount":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"paymentRequestItemStatus":{"$ref":"#/components/schemas/PaymentRequestItemStatus"},"transactionRequestFileId":{"type":"string","format":"guid","minLength":1},"transactionRequestFile":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestFile"}]},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"jobId":{"type":"string","nullable":true}}},"PaymentRequestItemStatus":{"type":"integer","description":"","enum":[1,2,3]},"TransactionRequestFile":{"type":"object","additionalProperties":false,"required":["name","url","clientId"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"url":{"type":"string","maxLength":200,"minLength":1},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItems":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionRequestItem"}},"date":{"type":"string","format":"date-time"}}},"ElectronicBill":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["internalId","caeNumber","series","number"],"properties":{"id":{"type":"integer","format":"int32"},"internalId":{"type":"integer","format":"int32"},"caeNumber":{"type":"string","minLength":1},"series":{"type":"string","minLength":1},"number":{"type":"integer","format":"int32"}}}]},"ErrorResponse":{"type":"object","additionalProperties":false,"properties":{"code":{"$ref":"#/components/schemas/HttpStatusCode"},"message":{"type":"string","nullable":true},"subCode":{"type":"integer","format":"int32"}}},"HttpStatusCode":{"type":"integer","description":"包含針對 HTTP 所定義的狀態碼值。","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,300,301,301,302,302,303,303,304,305,306,307,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511]}}}}
```
## Estado de la suscripción
> Devuelve el estado actual de una suscripción identificada por su token.
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Subscriptors","description":"Endpoints para gestionar suscriptores, suscripciones y operaciones relacionadas."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Subscriptors/subscriptions/{subscriptionToken}":{"get":{"tags":["Subscriptors"],"summary":"Estado de la suscripción","description":"Devuelve el estado actual de una suscripción identificada por su token.","operationId":"GetSubscriptionState","parameters":[{"name":"subscriptionToken","in":"path","required":true,"schema":{"type":"string"}},{"name":"clientSecret","in":"header","schema":{"type":"string","nullable":true}},{"name":"clientId","in":"header","schema":{"type":"string","nullable":true}}],"responses":{"200":{"description":"Éxito","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionStateResponse"}}}},"400":{"description":"Solicitud incorrecta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"ClientSecret inválido"}}}}},"components":{"schemas":{"SubscriptionStateResponse":{"type":"object","additionalProperties":false,"properties":{"valid":{"type":"boolean"},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeResponse"}]},"activeUntil":{"type":"string","format":"date-time","nullable":true},"subscriptionStatus":{"$ref":"#/components/schemas/SubscriptionStatus"}}},"SubscriptionTypeResponse":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"frequence":{"$ref":"#/components/schemas/Frequence"},"currency":{"$ref":"#/components/schemas/Currency"},"subscriptionBaseCost":{"type":"number","format":"decimal"},"recurrence":{"type":"integer","format":"int32"}}},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"ErrorResponse":{"type":"object","additionalProperties":false,"properties":{"code":{"$ref":"#/components/schemas/HttpStatusCode"},"message":{"type":"string","nullable":true},"subCode":{"type":"integer","format":"int32"}}},"HttpStatusCode":{"type":"integer","description":"包含針對 HTTP 所定義的狀態碼值。","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,300,301,301,302,302,303,303,304,305,306,307,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511]}}}}
```
## Crear suscripción
> Crea una suscripción para el suscriptor y tipo indicado. Puede requerir un pago exitoso para activarse.
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Subscriptors","description":"Endpoints para gestionar suscriptores, suscripciones y operaciones relacionadas."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Subscriptors/subscribe":{"post":{"tags":["Subscriptors"],"summary":"Crear suscripción","description":"Crea una suscripción para el suscriptor y tipo indicado. Puede requerir un pago exitoso para activarse.","operationId":"SubscribeUser","parameters":[{"name":"clientSecret","in":"header","schema":{"type":"string","nullable":true}},{"name":"clientId","in":"header","schema":{"type":"string","nullable":true}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscribeRequest"}}},"required":true},"responses":{"200":{"description":"Éxito","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"400":{"description":"Solicitud incorrecta. La suscripción puede crearse sin pago exitoso","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"ClientSecret inválido"}}}}},"components":{"schemas":{"SubscribeRequest":{"type":"object","additionalProperties":false,"properties":{"clientId":{"type":"string","format":"guid"},"externalId":{"type":"string","nullable":true},"subscriptionTypeId":{"type":"integer","format":"int32"},"subscriptionCreationStrategy":{"$ref":"#/components/schemas/SubscriptionCreationStrategy"},"requireSuccessfulTransaction":{"type":"boolean"},"dayOfRenewal":{"type":"integer","format":"int32","nullable":true}}},"SubscriptionCreationStrategy":{"type":"integer","description":"","enum":[0,1,2]},"Subscription":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["token","subscriptionTypeId","date","status","lastPaymentDate","validToDate","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"token":{"type":"string","minLength":1},"subscriptionTypeId":{"type":"integer","format":"int32"},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionType"}]},"date":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/SubscriptionStatus"},"lastPaymentDate":{"type":"string","format":"date","minLength":1},"validToDate":{"type":"string","format":"date","minLength":1},"backgroundJobId":{"type":"string","nullable":true},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"suspendedBy":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SuspendedByEnum"}]},"suspendedDate":{"type":"string","format":"date","nullable":true},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"remainingRecurrences":{"type":"integer","format":"int32","nullable":true}}}]},"BaseEntity":{"type":"object","additionalProperties":false},"SubscriptionType":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","description","frequence","cost","currency","status","recurrence"],"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","maxLength":50,"minLength":0},"description":{"type":"string","maxLength":120,"minLength":0},"frequence":{"$ref":"#/components/schemas/Frequence"},"cost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"status":{"$ref":"#/components/schemas/SubscriptionTypeStatus"},"recurrence":{"type":"integer","format":"int32","default":0},"taxPercentage":{"type":"number","format":"decimal","nullable":true}}}]},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"SubscriptionTypeStatus":{"type":"integer","description":"","enum":[0,99]},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"Subscriptor":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["externalId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","maxLength":100,"minLength":0},"email":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"name":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"fullName":{"type":"string","maxLength":150,"minLength":0,"nullable":true},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"instruments":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Instrument"}},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscription"}},"links":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Link"}}}}]},"Client":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","legalName","legalId","clientSecret","plexoCommerceId","admin","taxPercentage"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"legalName":{"type":"string","maxLength":150,"minLength":1},"legalId":{"type":"string","maxLength":12,"minLength":1},"clientSecret":{"type":"string","maxLength":50,"minLength":1},"plexoCommerceId":{"type":"integer","format":"int32"},"recurringPaymentUrl":{"type":"string","maxLength":100,"nullable":true},"admin":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationUser"}},"taxPercentage":{"type":"number","format":"decimal","default":22},"subscriptionTypes":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionType"}},"clientIssuers":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ClientIssuer"}},"subscriptors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscriptor"}},"historicData":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/HistoricData"}},"retriesConfiguration":{"$ref":"#/components/schemas/RetriesConfigurationEnum"},"notificationPermissionsId":{"type":"integer","format":"int32"},"notificationPermissions":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NotificationPermissions"}]}}}]},"ApplicationUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUser"},{"type":"object","additionalProperties":false,"properties":{"userType":{"$ref":"#/components/schemas/UserType"},"clientID":{"type":"string","format":"guid"}}}]},"IdentityUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUserOfString"},{"type":"object","description":"The default implementation of IdentityUser`1 which uses a string as a primary key.","additionalProperties":false}]},"IdentityUserOfString":{"type":"object","description":"Represents a user in the identity system","additionalProperties":false,"properties":{"id":{"type":"string","description":"Gets or sets the primary key for this user.","nullable":true},"userName":{"type":"string","description":"Gets or sets the user name for this user.","nullable":true},"normalizedUserName":{"type":"string","description":"Gets or sets the normalized user name for this user.","nullable":true},"email":{"type":"string","description":"Gets or sets the email address for this user.","nullable":true},"normalizedEmail":{"type":"string","description":"Gets or sets the normalized email address for this user.","nullable":true},"emailConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their email address."},"passwordHash":{"type":"string","description":"Gets or sets a salted and hashed representation of the password for this user.","nullable":true},"securityStamp":{"type":"string","description":"A random value that must change whenever a users credentials change (password changed, login removed)","nullable":true},"concurrencyStamp":{"type":"string","description":"A random value that must change whenever a user is persisted to the store","nullable":true},"phoneNumber":{"type":"string","description":"Gets or sets a telephone number for the user.","nullable":true},"phoneNumberConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their telephone address."},"twoFactorEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if two factor authentication is enabled for this user."},"lockoutEnd":{"type":"string","description":"Gets or sets the date and time, in UTC, when any user lockout ends.","format":"date-time","nullable":true},"lockoutEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if the user could be locked out."},"accessFailedCount":{"type":"integer","description":"Gets or sets the number of failed login attempts for the current user.","format":"int32"}}},"UserType":{"type":"integer","description":"","enum":[0,1,2]},"ClientIssuer":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["issuerId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"issuerId":{"type":"integer","format":"int32"},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]}}}]},"HistoricData":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"date":{"type":"string","format":"date"},"totalSubscriptors":{"type":"integer","format":"int32"}}},"RetriesConfigurationEnum":{"type":"integer","description":"","enum":[0,1]},"NotificationPermissions":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["id"],"properties":{"id":{"type":"integer","format":"int32"},"transactionCancellation":{"type":"boolean"},"subscriptionCancellation":{"type":"boolean"},"subscriptorFields":{"type":"boolean"},"paymentSuccess":{"type":"boolean"},"paymentFailed":{"type":"boolean"},"subcriptioninactiveByPaymentFailure":{"type":"boolean"}}}]},"Instrument":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["subscriptorId","instrumentToken","name","issuerName","issuerImageUrl","expiration","status"],"properties":{"id":{"type":"string","format":"guid"},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"instrumentToken":{"type":"string","format":"guid","minLength":1},"name":{"type":"string","maxLength":50,"minLength":1},"issuerName":{"type":"string","maxLength":50,"minLength":1},"issuerImageUrl":{"type":"string","maxLength":200,"minLength":1},"expiration":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/InstrumentStatus"},"uniqueID":{"type":"string","maxLength":200,"nullable":true},"plexoExtendedResponse":{"type":"string","nullable":true}}}]},"InstrumentStatus":{"type":"integer","description":"","enum":[0,99]},"Link":{"type":"object","additionalProperties":false,"required":["externalId","status","clientId","canUpdateSubscriptorData"],"properties":{"id":{"type":"string","format":"guid"},"externalId":{"type":"string","maxLength":150,"minLength":1},"firstName":{"type":"string","maxLength":50,"nullable":true},"lastName":{"type":"string","maxLength":50,"nullable":true},"email":{"type":"string","maxLength":150,"nullable":true},"status":{"default":1,"oneOf":[{"$ref":"#/components/schemas/LinkStatusEnum"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"subscriptorId":{"type":"integer","format":"int32","nullable":true},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"canUpdateSubscriptorData":{"type":"boolean","default":true},"subscriptionTypeId":{"type":"string","nullable":true}}},"LinkStatusEnum":{"type":"integer","description":"","enum":[1,2,3]},"SuspendedByEnum":{"type":"integer","description":"","enum":[0,1]},"Transaction":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["currency","amount","taxedAmount","taxAmount","date","status","retryAttempt","type","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"currency":{"$ref":"#/components/schemas/Currency"},"amount":{"type":"number","format":"decimal"},"taxedAmount":{"type":"number","format":"decimal"},"taxAmount":{"type":"number","format":"decimal"},"date":{"type":"string","format":"date-time","minLength":1},"status":{"$ref":"#/components/schemas/TransactionStatus"},"authorization":{"type":"string","nullable":true},"plexoReferenceId":{"type":"string","nullable":true},"errorText":{"type":"string","nullable":true},"retryAttempt":{"type":"integer","format":"int32","default":1},"plexoClientReference":{"type":"string","nullable":true},"ticket":{"type":"string","nullable":true},"type":{"default":1,"oneOf":[{"$ref":"#/components/schemas/TransactionType"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItemId":{"type":"string","format":"guid","nullable":true},"transactionRequestItem":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestItem"}]},"subscriptionId":{"type":"string","format":"guid","nullable":true},"subscription":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscription"}]},"instrumentId":{"type":"string","format":"guid","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Instrument"}]},"electronicBillingId":{"type":"integer","format":"int32","nullable":true},"electronicBilling":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ElectronicBill"}]}}}]},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionType":{"type":"integer","description":"","enum":[1,2]},"TransactionRequestItem":{"type":"object","additionalProperties":false,"required":["amount","currency","paymentRequestItemStatus","transactionRequestFileId","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"amount":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"paymentRequestItemStatus":{"$ref":"#/components/schemas/PaymentRequestItemStatus"},"transactionRequestFileId":{"type":"string","format":"guid","minLength":1},"transactionRequestFile":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestFile"}]},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"jobId":{"type":"string","nullable":true}}},"PaymentRequestItemStatus":{"type":"integer","description":"","enum":[1,2,3]},"TransactionRequestFile":{"type":"object","additionalProperties":false,"required":["name","url","clientId"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"url":{"type":"string","maxLength":200,"minLength":1},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItems":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionRequestItem"}},"date":{"type":"string","format":"date-time"}}},"ElectronicBill":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["internalId","caeNumber","series","number"],"properties":{"id":{"type":"integer","format":"int32"},"internalId":{"type":"integer","format":"int32"},"caeNumber":{"type":"string","minLength":1},"series":{"type":"string","minLength":1},"number":{"type":"integer","format":"int32"}}}]},"ErrorResponse":{"type":"object","additionalProperties":false,"properties":{"code":{"$ref":"#/components/schemas/HttpStatusCode"},"message":{"type":"string","nullable":true},"subCode":{"type":"integer","format":"int32"}}},"HttpStatusCode":{"type":"integer","description":"包含針對 HTTP 所定義的狀態碼值。","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,300,301,301,302,302,303,303,304,305,306,307,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511]}}}}
```
## Forzar pago
> Intenta realizar un pago en una suscripción inactiva para reactivarla.
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Subscriptors","description":"Endpoints para gestionar suscriptores, suscripciones y operaciones relacionadas."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Subscriptors/force/{subscriptionToken}":{"post":{"tags":["Subscriptors"],"summary":"Forzar pago","description":"Intenta realizar un pago en una suscripción inactiva para reactivarla.","operationId":"ForceSubscriptionPayment","parameters":[{"name":"subscriptionToken","in":"path","required":true,"schema":{"type":"string"}},{"name":"clientSecret","in":"header","schema":{"type":"string","nullable":true}},{"name":"clientId","in":"header","schema":{"type":"string","nullable":true}},{"name":"externalId","in":"header","schema":{"type":"string","nullable":true}}],"responses":{"200":{"description":"Éxito. Suscripción nuevamente activa","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"400":{"description":"Solicitud incorrecta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"ClientSecret inválido"}}}}},"components":{"schemas":{"Subscription":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["token","subscriptionTypeId","date","status","lastPaymentDate","validToDate","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"token":{"type":"string","minLength":1},"subscriptionTypeId":{"type":"integer","format":"int32"},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionType"}]},"date":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/SubscriptionStatus"},"lastPaymentDate":{"type":"string","format":"date","minLength":1},"validToDate":{"type":"string","format":"date","minLength":1},"backgroundJobId":{"type":"string","nullable":true},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"suspendedBy":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SuspendedByEnum"}]},"suspendedDate":{"type":"string","format":"date","nullable":true},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"remainingRecurrences":{"type":"integer","format":"int32","nullable":true}}}]},"BaseEntity":{"type":"object","additionalProperties":false},"SubscriptionType":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","description","frequence","cost","currency","status","recurrence"],"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","maxLength":50,"minLength":0},"description":{"type":"string","maxLength":120,"minLength":0},"frequence":{"$ref":"#/components/schemas/Frequence"},"cost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"status":{"$ref":"#/components/schemas/SubscriptionTypeStatus"},"recurrence":{"type":"integer","format":"int32","default":0},"taxPercentage":{"type":"number","format":"decimal","nullable":true}}}]},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"SubscriptionTypeStatus":{"type":"integer","description":"","enum":[0,99]},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"Subscriptor":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["externalId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","maxLength":100,"minLength":0},"email":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"name":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"fullName":{"type":"string","maxLength":150,"minLength":0,"nullable":true},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"instruments":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Instrument"}},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscription"}},"links":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Link"}}}}]},"Client":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","legalName","legalId","clientSecret","plexoCommerceId","admin","taxPercentage"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"legalName":{"type":"string","maxLength":150,"minLength":1},"legalId":{"type":"string","maxLength":12,"minLength":1},"clientSecret":{"type":"string","maxLength":50,"minLength":1},"plexoCommerceId":{"type":"integer","format":"int32"},"recurringPaymentUrl":{"type":"string","maxLength":100,"nullable":true},"admin":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationUser"}},"taxPercentage":{"type":"number","format":"decimal","default":22},"subscriptionTypes":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionType"}},"clientIssuers":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ClientIssuer"}},"subscriptors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscriptor"}},"historicData":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/HistoricData"}},"retriesConfiguration":{"$ref":"#/components/schemas/RetriesConfigurationEnum"},"notificationPermissionsId":{"type":"integer","format":"int32"},"notificationPermissions":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NotificationPermissions"}]}}}]},"ApplicationUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUser"},{"type":"object","additionalProperties":false,"properties":{"userType":{"$ref":"#/components/schemas/UserType"},"clientID":{"type":"string","format":"guid"}}}]},"IdentityUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUserOfString"},{"type":"object","description":"The default implementation of IdentityUser`1 which uses a string as a primary key.","additionalProperties":false}]},"IdentityUserOfString":{"type":"object","description":"Represents a user in the identity system","additionalProperties":false,"properties":{"id":{"type":"string","description":"Gets or sets the primary key for this user.","nullable":true},"userName":{"type":"string","description":"Gets or sets the user name for this user.","nullable":true},"normalizedUserName":{"type":"string","description":"Gets or sets the normalized user name for this user.","nullable":true},"email":{"type":"string","description":"Gets or sets the email address for this user.","nullable":true},"normalizedEmail":{"type":"string","description":"Gets or sets the normalized email address for this user.","nullable":true},"emailConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their email address."},"passwordHash":{"type":"string","description":"Gets or sets a salted and hashed representation of the password for this user.","nullable":true},"securityStamp":{"type":"string","description":"A random value that must change whenever a users credentials change (password changed, login removed)","nullable":true},"concurrencyStamp":{"type":"string","description":"A random value that must change whenever a user is persisted to the store","nullable":true},"phoneNumber":{"type":"string","description":"Gets or sets a telephone number for the user.","nullable":true},"phoneNumberConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their telephone address."},"twoFactorEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if two factor authentication is enabled for this user."},"lockoutEnd":{"type":"string","description":"Gets or sets the date and time, in UTC, when any user lockout ends.","format":"date-time","nullable":true},"lockoutEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if the user could be locked out."},"accessFailedCount":{"type":"integer","description":"Gets or sets the number of failed login attempts for the current user.","format":"int32"}}},"UserType":{"type":"integer","description":"","enum":[0,1,2]},"ClientIssuer":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["issuerId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"issuerId":{"type":"integer","format":"int32"},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]}}}]},"HistoricData":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"date":{"type":"string","format":"date"},"totalSubscriptors":{"type":"integer","format":"int32"}}},"RetriesConfigurationEnum":{"type":"integer","description":"","enum":[0,1]},"NotificationPermissions":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["id"],"properties":{"id":{"type":"integer","format":"int32"},"transactionCancellation":{"type":"boolean"},"subscriptionCancellation":{"type":"boolean"},"subscriptorFields":{"type":"boolean"},"paymentSuccess":{"type":"boolean"},"paymentFailed":{"type":"boolean"},"subcriptioninactiveByPaymentFailure":{"type":"boolean"}}}]},"Instrument":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["subscriptorId","instrumentToken","name","issuerName","issuerImageUrl","expiration","status"],"properties":{"id":{"type":"string","format":"guid"},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"instrumentToken":{"type":"string","format":"guid","minLength":1},"name":{"type":"string","maxLength":50,"minLength":1},"issuerName":{"type":"string","maxLength":50,"minLength":1},"issuerImageUrl":{"type":"string","maxLength":200,"minLength":1},"expiration":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/InstrumentStatus"},"uniqueID":{"type":"string","maxLength":200,"nullable":true},"plexoExtendedResponse":{"type":"string","nullable":true}}}]},"InstrumentStatus":{"type":"integer","description":"","enum":[0,99]},"Link":{"type":"object","additionalProperties":false,"required":["externalId","status","clientId","canUpdateSubscriptorData"],"properties":{"id":{"type":"string","format":"guid"},"externalId":{"type":"string","maxLength":150,"minLength":1},"firstName":{"type":"string","maxLength":50,"nullable":true},"lastName":{"type":"string","maxLength":50,"nullable":true},"email":{"type":"string","maxLength":150,"nullable":true},"status":{"default":1,"oneOf":[{"$ref":"#/components/schemas/LinkStatusEnum"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"subscriptorId":{"type":"integer","format":"int32","nullable":true},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"canUpdateSubscriptorData":{"type":"boolean","default":true},"subscriptionTypeId":{"type":"string","nullable":true}}},"LinkStatusEnum":{"type":"integer","description":"","enum":[1,2,3]},"SuspendedByEnum":{"type":"integer","description":"","enum":[0,1]},"Transaction":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["currency","amount","taxedAmount","taxAmount","date","status","retryAttempt","type","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"currency":{"$ref":"#/components/schemas/Currency"},"amount":{"type":"number","format":"decimal"},"taxedAmount":{"type":"number","format":"decimal"},"taxAmount":{"type":"number","format":"decimal"},"date":{"type":"string","format":"date-time","minLength":1},"status":{"$ref":"#/components/schemas/TransactionStatus"},"authorization":{"type":"string","nullable":true},"plexoReferenceId":{"type":"string","nullable":true},"errorText":{"type":"string","nullable":true},"retryAttempt":{"type":"integer","format":"int32","default":1},"plexoClientReference":{"type":"string","nullable":true},"ticket":{"type":"string","nullable":true},"type":{"default":1,"oneOf":[{"$ref":"#/components/schemas/TransactionType"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItemId":{"type":"string","format":"guid","nullable":true},"transactionRequestItem":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestItem"}]},"subscriptionId":{"type":"string","format":"guid","nullable":true},"subscription":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscription"}]},"instrumentId":{"type":"string","format":"guid","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Instrument"}]},"electronicBillingId":{"type":"integer","format":"int32","nullable":true},"electronicBilling":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ElectronicBill"}]}}}]},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionType":{"type":"integer","description":"","enum":[1,2]},"TransactionRequestItem":{"type":"object","additionalProperties":false,"required":["amount","currency","paymentRequestItemStatus","transactionRequestFileId","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"amount":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"paymentRequestItemStatus":{"$ref":"#/components/schemas/PaymentRequestItemStatus"},"transactionRequestFileId":{"type":"string","format":"guid","minLength":1},"transactionRequestFile":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestFile"}]},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"jobId":{"type":"string","nullable":true}}},"PaymentRequestItemStatus":{"type":"integer","description":"","enum":[1,2,3]},"TransactionRequestFile":{"type":"object","additionalProperties":false,"required":["name","url","clientId"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"url":{"type":"string","maxLength":200,"minLength":1},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItems":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionRequestItem"}},"date":{"type":"string","format":"date-time"}}},"ElectronicBill":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["internalId","caeNumber","series","number"],"properties":{"id":{"type":"integer","format":"int32"},"internalId":{"type":"integer","format":"int32"},"caeNumber":{"type":"string","minLength":1},"series":{"type":"string","minLength":1},"number":{"type":"integer","format":"int32"}}}]},"ErrorResponse":{"type":"object","additionalProperties":false,"properties":{"code":{"$ref":"#/components/schemas/HttpStatusCode"},"message":{"type":"string","nullable":true},"subCode":{"type":"integer","format":"int32"}}},"HttpStatusCode":{"type":"integer","description":"包含針對 HTTP 所定義的狀態碼值。","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,300,301,301,302,302,303,303,304,305,306,307,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511]}}}}
```
## Cancelar suscripción
> Cancela una suscripción. Opcionalmente cancela el último pago si se solicita.
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Subscriptors","description":"Endpoints para gestionar suscriptores, suscripciones y operaciones relacionadas."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Subscriptors/cancel/{subscriptionToken}":{"post":{"tags":["Subscriptors"],"summary":"Cancelar suscripción","description":"Cancela una suscripción. Opcionalmente cancela el último pago si se solicita.","operationId":"CancelSubscription","parameters":[{"name":"subscriptionToken","in":"path","required":true,"schema":{"type":"string"}},{"name":"clientSecret","in":"header","schema":{"type":"string","nullable":true}},{"name":"clientId","in":"header","schema":{"type":"string","nullable":true}},{"name":"externalId","in":"header","schema":{"type":"string","nullable":true}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelSubscriptionRequest"}}},"required":true},"responses":{"200":{"description":"Cancelada"},"400":{"description":"Solicitud incorrecta"},"401":{"description":"ClientSecret inválido"}}}}},"components":{"schemas":{"CancelSubscriptionRequest":{"type":"object","additionalProperties":false,"properties":{"clientId":{"type":"string","format":"guid"},"externalId":{"type":"string","nullable":true},"subscriptionToken":{"type":"string","nullable":true},"cancelLastPayment":{"type":"boolean"},"loggedRole":{"$ref":"#/components/schemas/SuspendedByEnum"}}},"SuspendedByEnum":{"type":"integer","description":"","enum":[0,1]}}}}
```
## Cambiar tipo de suscripción
> Cambia el tipo de una suscripción existente del suscriptor.
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Subscriptors","description":"Endpoints para gestionar suscriptores, suscripciones y operaciones relacionadas."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Subscriptors/change-type":{"put":{"tags":["Subscriptors"],"summary":"Cambiar tipo de suscripción","description":"Cambia el tipo de una suscripción existente del suscriptor.","operationId":"ChangeTypeSubscriptor","parameters":[{"name":"subscriptionToken","in":"query","schema":{"type":"string","nullable":true}},{"name":"clientSecret","in":"header","schema":{"type":"string","nullable":true}},{"name":"externalId","in":"header","schema":{"type":"string","nullable":true}},{"name":"clientId","in":"header","schema":{"type":"string","nullable":true}},{"name":"subscriptionTypeId","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Éxito","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscriptor"}}}},"400":{"description":"Solicitud incorrecta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"ClientSecret inválido"}}}}},"components":{"schemas":{"Subscriptor":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["externalId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","maxLength":100,"minLength":0},"email":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"name":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"fullName":{"type":"string","maxLength":150,"minLength":0,"nullable":true},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"instruments":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Instrument"}},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscription"}},"links":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Link"}}}}]},"BaseEntity":{"type":"object","additionalProperties":false},"Client":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","legalName","legalId","clientSecret","plexoCommerceId","admin","taxPercentage"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"legalName":{"type":"string","maxLength":150,"minLength":1},"legalId":{"type":"string","maxLength":12,"minLength":1},"clientSecret":{"type":"string","maxLength":50,"minLength":1},"plexoCommerceId":{"type":"integer","format":"int32"},"recurringPaymentUrl":{"type":"string","maxLength":100,"nullable":true},"admin":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationUser"}},"taxPercentage":{"type":"number","format":"decimal","default":22},"subscriptionTypes":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionType"}},"clientIssuers":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ClientIssuer"}},"subscriptors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscriptor"}},"historicData":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/HistoricData"}},"retriesConfiguration":{"$ref":"#/components/schemas/RetriesConfigurationEnum"},"notificationPermissionsId":{"type":"integer","format":"int32"},"notificationPermissions":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NotificationPermissions"}]}}}]},"ApplicationUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUser"},{"type":"object","additionalProperties":false,"properties":{"userType":{"$ref":"#/components/schemas/UserType"},"clientID":{"type":"string","format":"guid"}}}]},"IdentityUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUserOfString"},{"type":"object","description":"The default implementation of IdentityUser`1 which uses a string as a primary key.","additionalProperties":false}]},"IdentityUserOfString":{"type":"object","description":"Represents a user in the identity system","additionalProperties":false,"properties":{"id":{"type":"string","description":"Gets or sets the primary key for this user.","nullable":true},"userName":{"type":"string","description":"Gets or sets the user name for this user.","nullable":true},"normalizedUserName":{"type":"string","description":"Gets or sets the normalized user name for this user.","nullable":true},"email":{"type":"string","description":"Gets or sets the email address for this user.","nullable":true},"normalizedEmail":{"type":"string","description":"Gets or sets the normalized email address for this user.","nullable":true},"emailConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their email address."},"passwordHash":{"type":"string","description":"Gets or sets a salted and hashed representation of the password for this user.","nullable":true},"securityStamp":{"type":"string","description":"A random value that must change whenever a users credentials change (password changed, login removed)","nullable":true},"concurrencyStamp":{"type":"string","description":"A random value that must change whenever a user is persisted to the store","nullable":true},"phoneNumber":{"type":"string","description":"Gets or sets a telephone number for the user.","nullable":true},"phoneNumberConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their telephone address."},"twoFactorEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if two factor authentication is enabled for this user."},"lockoutEnd":{"type":"string","description":"Gets or sets the date and time, in UTC, when any user lockout ends.","format":"date-time","nullable":true},"lockoutEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if the user could be locked out."},"accessFailedCount":{"type":"integer","description":"Gets or sets the number of failed login attempts for the current user.","format":"int32"}}},"UserType":{"type":"integer","description":"","enum":[0,1,2]},"SubscriptionType":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","description","frequence","cost","currency","status","recurrence"],"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","maxLength":50,"minLength":0},"description":{"type":"string","maxLength":120,"minLength":0},"frequence":{"$ref":"#/components/schemas/Frequence"},"cost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"status":{"$ref":"#/components/schemas/SubscriptionTypeStatus"},"recurrence":{"type":"integer","format":"int32","default":0},"taxPercentage":{"type":"number","format":"decimal","nullable":true}}}]},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"SubscriptionTypeStatus":{"type":"integer","description":"","enum":[0,99]},"ClientIssuer":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["issuerId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"issuerId":{"type":"integer","format":"int32"},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]}}}]},"HistoricData":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"date":{"type":"string","format":"date"},"totalSubscriptors":{"type":"integer","format":"int32"}}},"RetriesConfigurationEnum":{"type":"integer","description":"","enum":[0,1]},"NotificationPermissions":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["id"],"properties":{"id":{"type":"integer","format":"int32"},"transactionCancellation":{"type":"boolean"},"subscriptionCancellation":{"type":"boolean"},"subscriptorFields":{"type":"boolean"},"paymentSuccess":{"type":"boolean"},"paymentFailed":{"type":"boolean"},"subcriptioninactiveByPaymentFailure":{"type":"boolean"}}}]},"Instrument":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["subscriptorId","instrumentToken","name","issuerName","issuerImageUrl","expiration","status"],"properties":{"id":{"type":"string","format":"guid"},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"instrumentToken":{"type":"string","format":"guid","minLength":1},"name":{"type":"string","maxLength":50,"minLength":1},"issuerName":{"type":"string","maxLength":50,"minLength":1},"issuerImageUrl":{"type":"string","maxLength":200,"minLength":1},"expiration":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/InstrumentStatus"},"uniqueID":{"type":"string","maxLength":200,"nullable":true},"plexoExtendedResponse":{"type":"string","nullable":true}}}]},"InstrumentStatus":{"type":"integer","description":"","enum":[0,99]},"Subscription":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["token","subscriptionTypeId","date","status","lastPaymentDate","validToDate","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"token":{"type":"string","minLength":1},"subscriptionTypeId":{"type":"integer","format":"int32"},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionType"}]},"date":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/SubscriptionStatus"},"lastPaymentDate":{"type":"string","format":"date","minLength":1},"validToDate":{"type":"string","format":"date","minLength":1},"backgroundJobId":{"type":"string","nullable":true},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"suspendedBy":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SuspendedByEnum"}]},"suspendedDate":{"type":"string","format":"date","nullable":true},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"remainingRecurrences":{"type":"integer","format":"int32","nullable":true}}}]},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"SuspendedByEnum":{"type":"integer","description":"","enum":[0,1]},"Transaction":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["currency","amount","taxedAmount","taxAmount","date","status","retryAttempt","type","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"currency":{"$ref":"#/components/schemas/Currency"},"amount":{"type":"number","format":"decimal"},"taxedAmount":{"type":"number","format":"decimal"},"taxAmount":{"type":"number","format":"decimal"},"date":{"type":"string","format":"date-time","minLength":1},"status":{"$ref":"#/components/schemas/TransactionStatus"},"authorization":{"type":"string","nullable":true},"plexoReferenceId":{"type":"string","nullable":true},"errorText":{"type":"string","nullable":true},"retryAttempt":{"type":"integer","format":"int32","default":1},"plexoClientReference":{"type":"string","nullable":true},"ticket":{"type":"string","nullable":true},"type":{"default":1,"oneOf":[{"$ref":"#/components/schemas/TransactionType"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItemId":{"type":"string","format":"guid","nullable":true},"transactionRequestItem":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestItem"}]},"subscriptionId":{"type":"string","format":"guid","nullable":true},"subscription":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscription"}]},"instrumentId":{"type":"string","format":"guid","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Instrument"}]},"electronicBillingId":{"type":"integer","format":"int32","nullable":true},"electronicBilling":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ElectronicBill"}]}}}]},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionType":{"type":"integer","description":"","enum":[1,2]},"TransactionRequestItem":{"type":"object","additionalProperties":false,"required":["amount","currency","paymentRequestItemStatus","transactionRequestFileId","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"amount":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"paymentRequestItemStatus":{"$ref":"#/components/schemas/PaymentRequestItemStatus"},"transactionRequestFileId":{"type":"string","format":"guid","minLength":1},"transactionRequestFile":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestFile"}]},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"jobId":{"type":"string","nullable":true}}},"PaymentRequestItemStatus":{"type":"integer","description":"","enum":[1,2,3]},"TransactionRequestFile":{"type":"object","additionalProperties":false,"required":["name","url","clientId"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"url":{"type":"string","maxLength":200,"minLength":1},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItems":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionRequestItem"}},"date":{"type":"string","format":"date-time"}}},"ElectronicBill":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["internalId","caeNumber","series","number"],"properties":{"id":{"type":"integer","format":"int32"},"internalId":{"type":"integer","format":"int32"},"caeNumber":{"type":"string","minLength":1},"series":{"type":"string","minLength":1},"number":{"type":"integer","format":"int32"}}}]},"Link":{"type":"object","additionalProperties":false,"required":["externalId","status","clientId","canUpdateSubscriptorData"],"properties":{"id":{"type":"string","format":"guid"},"externalId":{"type":"string","maxLength":150,"minLength":1},"firstName":{"type":"string","maxLength":50,"nullable":true},"lastName":{"type":"string","maxLength":50,"nullable":true},"email":{"type":"string","maxLength":150,"nullable":true},"status":{"default":1,"oneOf":[{"$ref":"#/components/schemas/LinkStatusEnum"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"subscriptorId":{"type":"integer","format":"int32","nullable":true},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"canUpdateSubscriptorData":{"type":"boolean","default":true},"subscriptionTypeId":{"type":"string","nullable":true}}},"LinkStatusEnum":{"type":"integer","description":"","enum":[1,2,3]},"ErrorResponse":{"type":"object","additionalProperties":false,"properties":{"code":{"$ref":"#/components/schemas/HttpStatusCode"},"message":{"type":"string","nullable":true},"subCode":{"type":"integer","format":"int32"}}},"HttpStatusCode":{"type":"integer","description":"包含針對 HTTP 所定義的狀態碼值。","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,300,301,301,302,302,303,303,304,305,306,307,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511]}}}}
```
## Buscar suscripciones
> Busca suscripciones por múltiples filtros (id, token, datos del suscriptor, estado, tipos). Devuelve una lista o un único elemento.
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Subscriptors","description":"Endpoints para gestionar suscriptores, suscripciones y operaciones relacionadas."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Subscriptors/subscriptions/search":{"get":{"tags":["Subscriptors"],"summary":"Buscar suscripciones","description":"Busca suscripciones por múltiples filtros (id, token, datos del suscriptor, estado, tipos). Devuelve una lista o un único elemento.","operationId":"SearchSubscriptionState","parameters":[{"name":"clientSecret","in":"header","schema":{"type":"string","nullable":true}},{"name":"clientId","in":"header","schema":{"type":"string","nullable":true}},{"name":"subscriptionId","in":"query","schema":{"type":"string","nullable":true}},{"name":"token","in":"query","schema":{"type":"string","nullable":true}},{"name":"subscriptorEmailOrNameOrId","in":"query","schema":{"type":"string","nullable":true}},{"name":"subscriptorsState","in":"query","schema":{"default":0,"oneOf":[{"$ref":"#/components/schemas/SubscriptorsQueryState"}]}},{"name":"subscriptionTypes","in":"query","schema":{"type":"string","nullable":true}}],"responses":{"200":{"description":"Éxito","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionStateResponse"}}}},"204":{"description":"Sin contenido"},"400":{"description":"Solicitud incorrecta","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"ClientSecret inválido"}}}}},"components":{"schemas":{"SubscriptorsQueryState":{"type":"integer","description":"","enum":[0,1,2]},"SubscriptionStateResponse":{"type":"object","additionalProperties":false,"properties":{"valid":{"type":"boolean"},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeResponse"}]},"activeUntil":{"type":"string","format":"date-time","nullable":true},"subscriptionStatus":{"$ref":"#/components/schemas/SubscriptionStatus"}}},"SubscriptionTypeResponse":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"frequence":{"$ref":"#/components/schemas/Frequence"},"currency":{"$ref":"#/components/schemas/Currency"},"subscriptionBaseCost":{"type":"number","format":"decimal"},"recurrence":{"type":"integer","format":"int32"}}},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"ErrorResponse":{"type":"object","additionalProperties":false,"properties":{"code":{"$ref":"#/components/schemas/HttpStatusCode"},"message":{"type":"string","nullable":true},"subCode":{"type":"integer","format":"int32"}}},"HttpStatusCode":{"type":"integer","description":"包含針對 HTTP 所定義的狀態碼值。","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,300,301,301,302,302,303,303,304,305,306,307,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511]}}}}
```
# Transacciones
Endpoints para consultar y gestionar transacciones y archivos de débito automático.
## Listar transacciones
> Devuelve transacciones del cliente en formato paginado.
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Transacciones","description":"Endpoints para consultar y gestionar transacciones y archivos de débito automático."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Transactions":{"get":{"tags":["Transacciones"],"summary":"Listar transacciones","description":"Devuelve transacciones del cliente en formato paginado.","operationId":"Transacciones_Listar","parameters":[{"name":"clientSecret","in":"header","schema":{"type":"string","nullable":true}},{"name":"clientId","in":"header","schema":{"type":"string","nullable":true}},{"name":"From","in":"query","schema":{"type":"string","format":"date-time","nullable":true}},{"name":"To","in":"query","schema":{"type":"string","format":"date-time","nullable":true}},{"name":"MinAmount","in":"query","schema":{"type":"number","format":"decimal","nullable":true}},{"name":"MaxAmount","in":"query","schema":{"type":"number","format":"decimal","nullable":true}},{"name":"SubscriptionTypes","in":"query","schema":{"type":"string","nullable":true}},{"name":"Currency","in":"query","schema":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Currency"}]}},{"name":"Page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"Limit","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"TransactionState","in":"query","schema":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionStatus"}]}},{"name":"SubscriptionToken","in":"query","schema":{"type":"string","nullable":true}}],"responses":{"200":{"description":"Éxito","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResultApiOfGetTransactionResponse"}}}},"204":{"description":"Sin contenido"},"404":{"description":"ClientSecret inválido"}}}}},"components":{"schemas":{"Currency":{"type":"integer","description":"","enum":[1,2]},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"PagedResultApiOfGetTransactionResponse":{"allOf":[{"$ref":"#/components/schemas/PagedResultBaseApi"},{"type":"object","additionalProperties":false,"properties":{"results":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/GetTransactionResponse"}}}}]},"PagedResultBaseApi":{"type":"object","additionalProperties":false,"properties":{"currentPage":{"type":"integer","format":"int32"},"pageCount":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"rowCount":{"type":"integer","format":"int32"},"totals":{"type":"number","format":"decimal"},"totalsDollar":{"type":"number","format":"decimal"},"linkTemplate":{"type":"string","nullable":true},"firstRowOnPage":{"type":"integer","format":"int32"},"lastRowOnPage":{"type":"integer","format":"int32"}}},"GetTransactionResponse":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"subscription":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionResponse"}]},"amount":{"type":"number","format":"decimal"},"createdAt":{"type":"string","format":"date-time"},"createdUTC":{"type":"string","format":"date-time"},"currency":{"$ref":"#/components/schemas/Currency"},"state":{"$ref":"#/components/schemas/TransactionStatus"},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentResponse"}]},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorResponse"}]}}},"SubscriptionResponse":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","nullable":true},"token":{"type":"string","nullable":true},"subscriptionDate":{"type":"string","format":"date-time","nullable":true},"subscriptionLastPaymentDate":{"type":"string","format":"date-time"},"subscriptionStatus":{"$ref":"#/components/schemas/SubscriptionStatus"},"validUntil":{"type":"string","format":"date-time"},"legalId":{"type":"string","nullable":true},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"backgroundJobId":{"type":"string","nullable":true}}},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"SubscriptionTypeDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"frequence":{"$ref":"#/components/schemas/Frequence"},"subscriptionBaseCost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"recurrence":{"type":"integer","format":"int32"},"regularType":{"type":"boolean"},"taxPercentage":{"type":"string","nullable":true}}},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"InstrumentResponse":{"type":"object","additionalProperties":false,"properties":{"expiration":{"type":"string","format":"date-time"},"instrumentId":{"type":"string","nullable":true},"issuerImageUrl":{"type":"string","nullable":true},"issuerName":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"optionalUniqueID":{"type":"string","nullable":true}}},"SubscriptorResponse":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"fullName":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentResponse"}]},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionResponse"}},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionResponse"}},"firstSubscribed":{"type":"string","format":"date-time"}}},"TransactionResponse":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"subscription":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionResponse"}]},"amount":{"type":"number","format":"decimal"},"createdAt":{"type":"string","format":"date-time"},"state":{"$ref":"#/components/schemas/TransactionStatus"},"currency":{"$ref":"#/components/schemas/Currency"},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentResponse"}]},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorResponse"}]}}}}}}
```
## Listar transacciones BackOffice
> Devuelve transacciones para uso interno BackOffice.
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Transacciones","description":"Endpoints para consultar y gestionar transacciones y archivos de débito automático."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Transactions/bo":{"get":{"tags":["Transacciones"],"summary":"Listar transacciones BackOffice","description":"Devuelve transacciones para uso interno BackOffice.","operationId":"Transacciones_ListarBackOffice","parameters":[{"name":"clientSecret","in":"header","schema":{"type":"string","nullable":true}},{"name":"clientId","in":"header","schema":{"type":"string","nullable":true}},{"name":"From","in":"query","schema":{"type":"string","format":"date-time","nullable":true}},{"name":"To","in":"query","schema":{"type":"string","format":"date-time","nullable":true}},{"name":"MinAmount","in":"query","schema":{"type":"number","format":"decimal","nullable":true}},{"name":"MaxAmount","in":"query","schema":{"type":"number","format":"decimal","nullable":true}},{"name":"SubscriptionTypes","in":"query","schema":{"type":"string","nullable":true}},{"name":"Currency","in":"query","schema":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Currency"}]}},{"name":"Page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"Limit","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"TransactionState","in":"query","schema":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionStatus"}]}},{"name":"SubscriptionToken","in":"query","schema":{"type":"string","nullable":true}}],"responses":{"200":{"description":"Éxito","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResultOfTransactionDto"}}}},"204":{"description":"Sin contenido"},"404":{"description":"ClientSecret inválido"}}}}},"components":{"schemas":{"Currency":{"type":"integer","description":"","enum":[1,2]},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"PagedResultOfTransactionDto":{"allOf":[{"$ref":"#/components/schemas/PagedResultBase"},{"type":"object","additionalProperties":false,"properties":{"results":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionDto"}}}}]},"PagedResultBase":{"type":"object","additionalProperties":false,"properties":{"currentPage":{"type":"integer","format":"int32"},"pageCount":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"rowCount":{"type":"integer","format":"int32"},"totalPeso":{"type":"number","format":"decimal"},"totalDollar":{"type":"number","format":"decimal"},"totalPesoFailed":{"type":"number","format":"decimal"},"totalDollarFailed":{"type":"number","format":"decimal"},"firstRowOnPage":{"type":"integer","format":"int32"},"lastRowOnPage":{"type":"integer","format":"int32"}}},"TransactionDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"subscriptionDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"amount":{"type":"number","format":"decimal"},"taxAmount":{"type":"number","format":"decimal"},"taxedAmount":{"type":"number","format":"decimal"},"createdAt":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/TransactionStatus"},"currency":{"$ref":"#/components/schemas/Currency"},"instrumentDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentDto"}]},"subscriptorDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"subscriptionTypeDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"transactionItemDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionItemDto"}]},"authorization":{"type":"string","nullable":true},"errorText":{"type":"string","nullable":true},"plexoClientReference":{"type":"string","nullable":true},"plexoTransactionId":{"type":"string","nullable":true}}},"SubscriptionDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"token":{"type":"string","nullable":true},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"subscriptionDate":{"type":"string","format":"date-time"},"subscriptionStatus":{"$ref":"#/components/schemas/SubscriptionStatus"},"subscriptionLastPaymentDate":{"type":"string","format":"date-time"},"validUntil":{"type":"string","format":"date-time"},"remainingRecurrences":{"type":"integer","format":"int32","nullable":true},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionDto"}}}},"SubscriptionTypeDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"frequence":{"$ref":"#/components/schemas/Frequence"},"subscriptionBaseCost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"recurrence":{"type":"integer","format":"int32"},"regularType":{"type":"boolean"},"taxPercentage":{"type":"string","nullable":true}}},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"ClientDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","nullable":true},"legalName":{"type":"string","nullable":true},"legalId":{"type":"string","nullable":true},"recurringPaymentUrl":{"type":"string","nullable":true},"plexoCommerceId":{"type":"integer","format":"int32"},"taxPercentage":{"type":"number","format":"decimal"},"admin":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ClientAdmin"}},"subscriptionTypesDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionTypeDto"}},"commercesDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/CommerceDto"}},"subscriptorsDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptorDto"}},"retriesConfiguration":{"$ref":"#/components/schemas/RetriesConfigurationEnum"},"notificationPermissionsDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NotificationPermissionsDto"}]}}},"ClientAdmin":{"type":"object","additionalProperties":false,"properties":{"userId":{"type":"string","nullable":true},"userName":{"type":"string","nullable":true},"clientId":{"type":"string","format":"guid"}}},"CommerceDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"issuer":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/IssuerDto"}]},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"fields":{"type":"object","nullable":true,"additionalProperties":{"type":"string"}}}},"IssuerDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"issuerImageUrl":{"type":"string","nullable":true},"fields":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FieldInfo"}}}},"FieldInfo":{"type":"object","additionalProperties":false,"properties":{"labelName":{"type":"string","nullable":true},"fieldType":{"$ref":"#/components/schemas/FieldType"},"required":{"type":"boolean"}}},"FieldType":{"type":"integer","description":"","enum":[257,258,259,260,261,262,263,264,265,266,267,268,269,270,271,272,273,274,513,514,515,516,517,518,519,520,521,522,523,524,525,526,527,528,529,530,531,532,533,534,535,1025,1281,1282,1283,1284,1285,1286,1287,1288,1289,1296,1297,1298,2049,2050,2051,2052,2053,2054,2055,2056,2057,2058,2059,2060,2061,2062,2063,2064,2065,2066,2067,2068,2069,2070,2071,2072,2073,2074,2075,2076,2077,2078,2079,2080,2081,2082,2083,2084,2085,2305,2306,2307,2308,2309,2310,2311,2312,2313,2320,33025,33026,33027,33028,33153,33154]},"SubscriptorDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"fullName":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionDto"}},"firstSubscribed":{"type":"string","format":"date-time","nullable":true},"links":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LinkDto"}}}},"InstrumentDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"expiration":{"type":"string","format":"date-time"},"issuerImageUrl":{"type":"string","nullable":true},"issuerName":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"token":{"type":"string","format":"guid","nullable":true},"plexoExtendedResponse":{"type":"string","nullable":true},"optionalUniqueID":{"type":"string","nullable":true}}},"LinkDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"externalId":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"canUpdateSubscriptorData":{"type":"boolean"},"status":{"$ref":"#/components/schemas/LinkStatusEnum"},"subscriptorDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]}}},"LinkStatusEnum":{"type":"integer","description":"","enum":[1,2,3]},"RetriesConfigurationEnum":{"type":"integer","description":"","enum":[0,1]},"NotificationPermissionsDto":{"type":"object","additionalProperties":false,"properties":{"transactionCancellation":{"type":"boolean"},"subscriptionCancellation":{"type":"boolean"},"subscriptorFields":{"type":"boolean"},"paymentSuccess":{"type":"boolean"},"paymentFailed":{"type":"boolean"}}},"TransactionItemDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"amount":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"paymentRequestItemStatus":{"$ref":"#/components/schemas/PaymentRequestItemStatus"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionDto"}}}},"PaymentRequestItemStatus":{"type":"integer","description":"","enum":[1,2,3]}}}}
```
## Exportar transacciones
> Obtiene todas las transacciones del cliente (no paginado).
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Transacciones","description":"Endpoints para consultar y gestionar transacciones y archivos de débito automático."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Transactions/export":{"get":{"tags":["Transacciones"],"summary":"Exportar transacciones","description":"Obtiene todas las transacciones del cliente (no paginado).","operationId":"Transacciones_Exportar","parameters":[{"name":"clientSecret","in":"header","schema":{"type":"string","nullable":true}},{"name":"clientId","in":"header","schema":{"type":"string","nullable":true}},{"name":"From","in":"query","schema":{"type":"string","format":"date-time","nullable":true}},{"name":"To","in":"query","schema":{"type":"string","format":"date-time","nullable":true}},{"name":"MinAmount","in":"query","schema":{"type":"number","format":"decimal","nullable":true}},{"name":"MaxAmount","in":"query","schema":{"type":"number","format":"decimal","nullable":true}},{"name":"SubscriptionTypes","in":"query","schema":{"type":"string","nullable":true}},{"name":"Currency","in":"query","schema":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Currency"}]}},{"name":"Page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"Limit","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"TransactionState","in":"query","schema":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionStatus"}]}},{"name":"SubscriptionToken","in":"query","schema":{"type":"string","nullable":true}}],"responses":{"200":{"description":"Éxito","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResultApiOfTransactionResponse"}}}},"204":{"description":"Sin contenido"},"404":{"description":"ClientSecret inválido"}}}}},"components":{"schemas":{"Currency":{"type":"integer","description":"","enum":[1,2]},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"PagedResultApiOfTransactionResponse":{"allOf":[{"$ref":"#/components/schemas/PagedResultBaseApi"},{"type":"object","additionalProperties":false,"properties":{"results":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionResponse"}}}}]},"PagedResultBaseApi":{"type":"object","additionalProperties":false,"properties":{"currentPage":{"type":"integer","format":"int32"},"pageCount":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"rowCount":{"type":"integer","format":"int32"},"totals":{"type":"number","format":"decimal"},"totalsDollar":{"type":"number","format":"decimal"},"linkTemplate":{"type":"string","nullable":true},"firstRowOnPage":{"type":"integer","format":"int32"},"lastRowOnPage":{"type":"integer","format":"int32"}}},"TransactionResponse":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"subscription":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionResponse"}]},"amount":{"type":"number","format":"decimal"},"createdAt":{"type":"string","format":"date-time"},"state":{"$ref":"#/components/schemas/TransactionStatus"},"currency":{"$ref":"#/components/schemas/Currency"},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentResponse"}]},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorResponse"}]}}},"SubscriptionResponse":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","nullable":true},"token":{"type":"string","nullable":true},"subscriptionDate":{"type":"string","format":"date-time","nullable":true},"subscriptionLastPaymentDate":{"type":"string","format":"date-time"},"subscriptionStatus":{"$ref":"#/components/schemas/SubscriptionStatus"},"validUntil":{"type":"string","format":"date-time"},"legalId":{"type":"string","nullable":true},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"backgroundJobId":{"type":"string","nullable":true}}},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"SubscriptionTypeDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"frequence":{"$ref":"#/components/schemas/Frequence"},"subscriptionBaseCost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"recurrence":{"type":"integer","format":"int32"},"regularType":{"type":"boolean"},"taxPercentage":{"type":"string","nullable":true}}},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"InstrumentResponse":{"type":"object","additionalProperties":false,"properties":{"expiration":{"type":"string","format":"date-time"},"instrumentId":{"type":"string","nullable":true},"issuerImageUrl":{"type":"string","nullable":true},"issuerName":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"optionalUniqueID":{"type":"string","nullable":true}}},"SubscriptorResponse":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"fullName":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentResponse"}]},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionResponse"}},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionResponse"}},"firstSubscribed":{"type":"string","format":"date-time"}}}}}}
```
## Transacciones por suscripción
> Obtiene transacciones asociadas a un token de suscripción específico.
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Transacciones","description":"Endpoints para consultar y gestionar transacciones y archivos de débito automático."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Transactions/{subscriptionToken}":{"get":{"tags":["Transacciones"],"summary":"Transacciones por suscripción","description":"Obtiene transacciones asociadas a un token de suscripción específico.","operationId":"Transacciones_PorSuscripcion","parameters":[{"name":"subscriptionToken","in":"path","required":true,"schema":{"type":"string"}},{"name":"clientSecret","in":"header","schema":{"type":"string","nullable":true}},{"name":"clientId","in":"header","schema":{"type":"string","nullable":true}},{"name":"From","in":"query","schema":{"type":"string","format":"date-time","nullable":true}},{"name":"To","in":"query","schema":{"type":"string","format":"date-time","nullable":true}},{"name":"MinAmount","in":"query","schema":{"type":"number","format":"decimal","nullable":true}},{"name":"MaxAmount","in":"query","schema":{"type":"number","format":"decimal","nullable":true}},{"name":"SubscriptionTypes","in":"query","schema":{"type":"string","nullable":true}},{"name":"Currency","in":"query","schema":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Currency"}]}},{"name":"Page","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"Limit","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"TransactionState","in":"query","schema":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionStatus"}]}},{"name":"SubscriptionToken","in":"query","schema":{"type":"string","nullable":true}}],"responses":{"200":{"description":"Éxito","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedResultOfTransaction"}}}},"204":{"description":"Sin contenido"},"404":{"description":"ClientSecret inválido"}}}}},"components":{"schemas":{"Currency":{"type":"integer","description":"","enum":[1,2]},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"PagedResultOfTransaction":{"allOf":[{"$ref":"#/components/schemas/PagedResultBase"},{"type":"object","additionalProperties":false,"properties":{"results":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}}}}]},"PagedResultBase":{"type":"object","additionalProperties":false,"properties":{"currentPage":{"type":"integer","format":"int32"},"pageCount":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"rowCount":{"type":"integer","format":"int32"},"totalPeso":{"type":"number","format":"decimal"},"totalDollar":{"type":"number","format":"decimal"},"totalPesoFailed":{"type":"number","format":"decimal"},"totalDollarFailed":{"type":"number","format":"decimal"},"firstRowOnPage":{"type":"integer","format":"int32"},"lastRowOnPage":{"type":"integer","format":"int32"}}},"Transaction":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["currency","amount","taxedAmount","taxAmount","date","status","retryAttempt","type","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"currency":{"$ref":"#/components/schemas/Currency"},"amount":{"type":"number","format":"decimal"},"taxedAmount":{"type":"number","format":"decimal"},"taxAmount":{"type":"number","format":"decimal"},"date":{"type":"string","format":"date-time","minLength":1},"status":{"$ref":"#/components/schemas/TransactionStatus"},"authorization":{"type":"string","nullable":true},"plexoReferenceId":{"type":"string","nullable":true},"errorText":{"type":"string","nullable":true},"retryAttempt":{"type":"integer","format":"int32","default":1},"plexoClientReference":{"type":"string","nullable":true},"ticket":{"type":"string","nullable":true},"type":{"default":1,"oneOf":[{"$ref":"#/components/schemas/TransactionType"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItemId":{"type":"string","format":"guid","nullable":true},"transactionRequestItem":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestItem"}]},"subscriptionId":{"type":"string","format":"guid","nullable":true},"subscription":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscription"}]},"instrumentId":{"type":"string","format":"guid","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Instrument"}]},"electronicBillingId":{"type":"integer","format":"int32","nullable":true},"electronicBilling":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ElectronicBill"}]}}}]},"BaseEntity":{"type":"object","additionalProperties":false},"TransactionType":{"type":"integer","description":"","enum":[1,2]},"Client":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","legalName","legalId","clientSecret","plexoCommerceId","admin","taxPercentage"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"legalName":{"type":"string","maxLength":150,"minLength":1},"legalId":{"type":"string","maxLength":12,"minLength":1},"clientSecret":{"type":"string","maxLength":50,"minLength":1},"plexoCommerceId":{"type":"integer","format":"int32"},"recurringPaymentUrl":{"type":"string","maxLength":100,"nullable":true},"admin":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationUser"}},"taxPercentage":{"type":"number","format":"decimal","default":22},"subscriptionTypes":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionType"}},"clientIssuers":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ClientIssuer"}},"subscriptors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscriptor"}},"historicData":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/HistoricData"}},"retriesConfiguration":{"$ref":"#/components/schemas/RetriesConfigurationEnum"},"notificationPermissionsId":{"type":"integer","format":"int32"},"notificationPermissions":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NotificationPermissions"}]}}}]},"ApplicationUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUser"},{"type":"object","additionalProperties":false,"properties":{"userType":{"$ref":"#/components/schemas/UserType"},"clientID":{"type":"string","format":"guid"}}}]},"IdentityUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUserOfString"},{"type":"object","description":"The default implementation of IdentityUser`1 which uses a string as a primary key.","additionalProperties":false}]},"IdentityUserOfString":{"type":"object","description":"Represents a user in the identity system","additionalProperties":false,"properties":{"id":{"type":"string","description":"Gets or sets the primary key for this user.","nullable":true},"userName":{"type":"string","description":"Gets or sets the user name for this user.","nullable":true},"normalizedUserName":{"type":"string","description":"Gets or sets the normalized user name for this user.","nullable":true},"email":{"type":"string","description":"Gets or sets the email address for this user.","nullable":true},"normalizedEmail":{"type":"string","description":"Gets or sets the normalized email address for this user.","nullable":true},"emailConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their email address."},"passwordHash":{"type":"string","description":"Gets or sets a salted and hashed representation of the password for this user.","nullable":true},"securityStamp":{"type":"string","description":"A random value that must change whenever a users credentials change (password changed, login removed)","nullable":true},"concurrencyStamp":{"type":"string","description":"A random value that must change whenever a user is persisted to the store","nullable":true},"phoneNumber":{"type":"string","description":"Gets or sets a telephone number for the user.","nullable":true},"phoneNumberConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their telephone address."},"twoFactorEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if two factor authentication is enabled for this user."},"lockoutEnd":{"type":"string","description":"Gets or sets the date and time, in UTC, when any user lockout ends.","format":"date-time","nullable":true},"lockoutEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if the user could be locked out."},"accessFailedCount":{"type":"integer","description":"Gets or sets the number of failed login attempts for the current user.","format":"int32"}}},"UserType":{"type":"integer","description":"","enum":[0,1,2]},"SubscriptionType":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","description","frequence","cost","currency","status","recurrence"],"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","maxLength":50,"minLength":0},"description":{"type":"string","maxLength":120,"minLength":0},"frequence":{"$ref":"#/components/schemas/Frequence"},"cost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"status":{"$ref":"#/components/schemas/SubscriptionTypeStatus"},"recurrence":{"type":"integer","format":"int32","default":0},"taxPercentage":{"type":"number","format":"decimal","nullable":true}}}]},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"SubscriptionTypeStatus":{"type":"integer","description":"","enum":[0,99]},"ClientIssuer":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["issuerId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"issuerId":{"type":"integer","format":"int32"},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]}}}]},"Subscriptor":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["externalId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","maxLength":100,"minLength":0},"email":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"name":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"fullName":{"type":"string","maxLength":150,"minLength":0,"nullable":true},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"instruments":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Instrument"}},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscription"}},"links":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Link"}}}}]},"Instrument":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["subscriptorId","instrumentToken","name","issuerName","issuerImageUrl","expiration","status"],"properties":{"id":{"type":"string","format":"guid"},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"instrumentToken":{"type":"string","format":"guid","minLength":1},"name":{"type":"string","maxLength":50,"minLength":1},"issuerName":{"type":"string","maxLength":50,"minLength":1},"issuerImageUrl":{"type":"string","maxLength":200,"minLength":1},"expiration":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/InstrumentStatus"},"uniqueID":{"type":"string","maxLength":200,"nullable":true},"plexoExtendedResponse":{"type":"string","nullable":true}}}]},"InstrumentStatus":{"type":"integer","description":"","enum":[0,99]},"Subscription":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["token","subscriptionTypeId","date","status","lastPaymentDate","validToDate","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"token":{"type":"string","minLength":1},"subscriptionTypeId":{"type":"integer","format":"int32"},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionType"}]},"date":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/SubscriptionStatus"},"lastPaymentDate":{"type":"string","format":"date","minLength":1},"validToDate":{"type":"string","format":"date","minLength":1},"backgroundJobId":{"type":"string","nullable":true},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"suspendedBy":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SuspendedByEnum"}]},"suspendedDate":{"type":"string","format":"date","nullable":true},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"remainingRecurrences":{"type":"integer","format":"int32","nullable":true}}}]},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"SuspendedByEnum":{"type":"integer","description":"","enum":[0,1]},"Link":{"type":"object","additionalProperties":false,"required":["externalId","status","clientId","canUpdateSubscriptorData"],"properties":{"id":{"type":"string","format":"guid"},"externalId":{"type":"string","maxLength":150,"minLength":1},"firstName":{"type":"string","maxLength":50,"nullable":true},"lastName":{"type":"string","maxLength":50,"nullable":true},"email":{"type":"string","maxLength":150,"nullable":true},"status":{"default":1,"oneOf":[{"$ref":"#/components/schemas/LinkStatusEnum"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"subscriptorId":{"type":"integer","format":"int32","nullable":true},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"canUpdateSubscriptorData":{"type":"boolean","default":true},"subscriptionTypeId":{"type":"string","nullable":true}}},"LinkStatusEnum":{"type":"integer","description":"","enum":[1,2,3]},"HistoricData":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"date":{"type":"string","format":"date"},"totalSubscriptors":{"type":"integer","format":"int32"}}},"RetriesConfigurationEnum":{"type":"integer","description":"","enum":[0,1]},"NotificationPermissions":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["id"],"properties":{"id":{"type":"integer","format":"int32"},"transactionCancellation":{"type":"boolean"},"subscriptionCancellation":{"type":"boolean"},"subscriptorFields":{"type":"boolean"},"paymentSuccess":{"type":"boolean"},"paymentFailed":{"type":"boolean"},"subcriptioninactiveByPaymentFailure":{"type":"boolean"}}}]},"TransactionRequestItem":{"type":"object","additionalProperties":false,"required":["amount","currency","paymentRequestItemStatus","transactionRequestFileId","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"amount":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"paymentRequestItemStatus":{"$ref":"#/components/schemas/PaymentRequestItemStatus"},"transactionRequestFileId":{"type":"string","format":"guid","minLength":1},"transactionRequestFile":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestFile"}]},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"jobId":{"type":"string","nullable":true}}},"PaymentRequestItemStatus":{"type":"integer","description":"","enum":[1,2,3]},"TransactionRequestFile":{"type":"object","additionalProperties":false,"required":["name","url","clientId"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"url":{"type":"string","maxLength":200,"minLength":1},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItems":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionRequestItem"}},"date":{"type":"string","format":"date-time"}}},"ElectronicBill":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["internalId","caeNumber","series","number"],"properties":{"id":{"type":"integer","format":"int32"},"internalId":{"type":"integer","format":"int32"},"caeNumber":{"type":"string","minLength":1},"series":{"type":"string","minLength":1},"number":{"type":"integer","format":"int32"}}}]}}}}
```
## Subir archivo de solicitud
> Sube archivo para crear solicitudes de transacciones masivas (débito automático).
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Transacciones","description":"Endpoints para consultar y gestionar transacciones y archivos de débito automático."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Transactions/upload":{"post":{"tags":["Transacciones"],"summary":"Subir archivo de solicitud","description":"Sube archivo para crear solicitudes de transacciones masivas (débito automático).","operationId":"Transacciones_SubirArchivo","requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"ContentType":{"type":"string","nullable":true},"ContentDisposition":{"type":"string","nullable":true},"Headers":{"type":"array","nullable":true,"items":{}},"Length":{"type":"integer","format":"int64"},"Name":{"type":"string","nullable":true},"FileName":{"type":"string","nullable":true}}}}}},"responses":{"200":{"description":"Éxito","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionRequestFileDto"}}}},"204":{"description":"Sin contenido"}}}}},"components":{"schemas":{"TransactionRequestFileDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","nullable":true},"url":{"type":"string","nullable":true},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"totalCount":{"type":"integer","format":"int32"},"successCount":{"type":"integer","format":"int32"},"failedCount":{"type":"integer","format":"int32"},"date":{"type":"string","format":"date-time"}}},"ClientDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","nullable":true},"legalName":{"type":"string","nullable":true},"legalId":{"type":"string","nullable":true},"recurringPaymentUrl":{"type":"string","nullable":true},"plexoCommerceId":{"type":"integer","format":"int32"},"taxPercentage":{"type":"number","format":"decimal"},"admin":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ClientAdmin"}},"subscriptionTypesDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionTypeDto"}},"commercesDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/CommerceDto"}},"subscriptorsDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptorDto"}},"retriesConfiguration":{"$ref":"#/components/schemas/RetriesConfigurationEnum"},"notificationPermissionsDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NotificationPermissionsDto"}]}}},"ClientAdmin":{"type":"object","additionalProperties":false,"properties":{"userId":{"type":"string","nullable":true},"userName":{"type":"string","nullable":true},"clientId":{"type":"string","format":"guid"}}},"SubscriptionTypeDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"frequence":{"$ref":"#/components/schemas/Frequence"},"subscriptionBaseCost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"recurrence":{"type":"integer","format":"int32"},"regularType":{"type":"boolean"},"taxPercentage":{"type":"string","nullable":true}}},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"CommerceDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"issuer":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/IssuerDto"}]},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"fields":{"type":"object","nullable":true,"additionalProperties":{"type":"string"}}}},"IssuerDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"issuerImageUrl":{"type":"string","nullable":true},"fields":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FieldInfo"}}}},"FieldInfo":{"type":"object","additionalProperties":false,"properties":{"labelName":{"type":"string","nullable":true},"fieldType":{"$ref":"#/components/schemas/FieldType"},"required":{"type":"boolean"}}},"FieldType":{"type":"integer","description":"","enum":[257,258,259,260,261,262,263,264,265,266,267,268,269,270,271,272,273,274,513,514,515,516,517,518,519,520,521,522,523,524,525,526,527,528,529,530,531,532,533,534,535,1025,1281,1282,1283,1284,1285,1286,1287,1288,1289,1296,1297,1298,2049,2050,2051,2052,2053,2054,2055,2056,2057,2058,2059,2060,2061,2062,2063,2064,2065,2066,2067,2068,2069,2070,2071,2072,2073,2074,2075,2076,2077,2078,2079,2080,2081,2082,2083,2084,2085,2305,2306,2307,2308,2309,2310,2311,2312,2313,2320,33025,33026,33027,33028,33153,33154]},"SubscriptorDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"fullName":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionDto"}},"firstSubscribed":{"type":"string","format":"date-time","nullable":true},"links":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LinkDto"}}}},"InstrumentDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"expiration":{"type":"string","format":"date-time"},"issuerImageUrl":{"type":"string","nullable":true},"issuerName":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"token":{"type":"string","format":"guid","nullable":true},"plexoExtendedResponse":{"type":"string","nullable":true},"optionalUniqueID":{"type":"string","nullable":true}}},"SubscriptionDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"token":{"type":"string","nullable":true},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"subscriptionDate":{"type":"string","format":"date-time"},"subscriptionStatus":{"$ref":"#/components/schemas/SubscriptionStatus"},"subscriptionLastPaymentDate":{"type":"string","format":"date-time"},"validUntil":{"type":"string","format":"date-time"},"remainingRecurrences":{"type":"integer","format":"int32","nullable":true},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionDto"}}}},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"subscriptionDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"amount":{"type":"number","format":"decimal"},"taxAmount":{"type":"number","format":"decimal"},"taxedAmount":{"type":"number","format":"decimal"},"createdAt":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/TransactionStatus"},"currency":{"$ref":"#/components/schemas/Currency"},"instrumentDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentDto"}]},"subscriptorDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"subscriptionTypeDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"transactionItemDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionItemDto"}]},"authorization":{"type":"string","nullable":true},"errorText":{"type":"string","nullable":true},"plexoClientReference":{"type":"string","nullable":true},"plexoTransactionId":{"type":"string","nullable":true}}},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionItemDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"amount":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"paymentRequestItemStatus":{"$ref":"#/components/schemas/PaymentRequestItemStatus"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionDto"}}}},"PaymentRequestItemStatus":{"type":"integer","description":"","enum":[1,2,3]},"LinkDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"externalId":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"canUpdateSubscriptorData":{"type":"boolean"},"status":{"$ref":"#/components/schemas/LinkStatusEnum"},"subscriptorDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]}}},"LinkStatusEnum":{"type":"integer","description":"","enum":[1,2,3]},"RetriesConfigurationEnum":{"type":"integer","description":"","enum":[0,1]},"NotificationPermissionsDto":{"type":"object","additionalProperties":false,"properties":{"transactionCancellation":{"type":"boolean"},"subscriptionCancellation":{"type":"boolean"},"subscriptorFields":{"type":"boolean"},"paymentSuccess":{"type":"boolean"},"paymentFailed":{"type":"boolean"}}}}}}
```
## Listar archivos
> Lista archivos de solicitudes de transacciones subidos.
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Transacciones","description":"Endpoints para consultar y gestionar transacciones y archivos de débito automático."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Transactions/files":{"get":{"tags":["Transacciones"],"summary":"Listar archivos","description":"Lista archivos de solicitudes de transacciones subidos.","operationId":"Transacciones_ListarArchivos","responses":{"200":{"description":"Éxito","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TransactionRequestFileDto"}}}}},"204":{"description":"Sin contenido"}}}}},"components":{"schemas":{"TransactionRequestFileDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","nullable":true},"url":{"type":"string","nullable":true},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"totalCount":{"type":"integer","format":"int32"},"successCount":{"type":"integer","format":"int32"},"failedCount":{"type":"integer","format":"int32"},"date":{"type":"string","format":"date-time"}}},"ClientDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","nullable":true},"legalName":{"type":"string","nullable":true},"legalId":{"type":"string","nullable":true},"recurringPaymentUrl":{"type":"string","nullable":true},"plexoCommerceId":{"type":"integer","format":"int32"},"taxPercentage":{"type":"number","format":"decimal"},"admin":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ClientAdmin"}},"subscriptionTypesDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionTypeDto"}},"commercesDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/CommerceDto"}},"subscriptorsDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptorDto"}},"retriesConfiguration":{"$ref":"#/components/schemas/RetriesConfigurationEnum"},"notificationPermissionsDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NotificationPermissionsDto"}]}}},"ClientAdmin":{"type":"object","additionalProperties":false,"properties":{"userId":{"type":"string","nullable":true},"userName":{"type":"string","nullable":true},"clientId":{"type":"string","format":"guid"}}},"SubscriptionTypeDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"frequence":{"$ref":"#/components/schemas/Frequence"},"subscriptionBaseCost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"recurrence":{"type":"integer","format":"int32"},"regularType":{"type":"boolean"},"taxPercentage":{"type":"string","nullable":true}}},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"CommerceDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"issuer":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/IssuerDto"}]},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"fields":{"type":"object","nullable":true,"additionalProperties":{"type":"string"}}}},"IssuerDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"issuerImageUrl":{"type":"string","nullable":true},"fields":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FieldInfo"}}}},"FieldInfo":{"type":"object","additionalProperties":false,"properties":{"labelName":{"type":"string","nullable":true},"fieldType":{"$ref":"#/components/schemas/FieldType"},"required":{"type":"boolean"}}},"FieldType":{"type":"integer","description":"","enum":[257,258,259,260,261,262,263,264,265,266,267,268,269,270,271,272,273,274,513,514,515,516,517,518,519,520,521,522,523,524,525,526,527,528,529,530,531,532,533,534,535,1025,1281,1282,1283,1284,1285,1286,1287,1288,1289,1296,1297,1298,2049,2050,2051,2052,2053,2054,2055,2056,2057,2058,2059,2060,2061,2062,2063,2064,2065,2066,2067,2068,2069,2070,2071,2072,2073,2074,2075,2076,2077,2078,2079,2080,2081,2082,2083,2084,2085,2305,2306,2307,2308,2309,2310,2311,2312,2313,2320,33025,33026,33027,33028,33153,33154]},"SubscriptorDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"fullName":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionDto"}},"firstSubscribed":{"type":"string","format":"date-time","nullable":true},"links":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LinkDto"}}}},"InstrumentDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"expiration":{"type":"string","format":"date-time"},"issuerImageUrl":{"type":"string","nullable":true},"issuerName":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"token":{"type":"string","format":"guid","nullable":true},"plexoExtendedResponse":{"type":"string","nullable":true},"optionalUniqueID":{"type":"string","nullable":true}}},"SubscriptionDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"token":{"type":"string","nullable":true},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"subscriptionDate":{"type":"string","format":"date-time"},"subscriptionStatus":{"$ref":"#/components/schemas/SubscriptionStatus"},"subscriptionLastPaymentDate":{"type":"string","format":"date-time"},"validUntil":{"type":"string","format":"date-time"},"remainingRecurrences":{"type":"integer","format":"int32","nullable":true},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionDto"}}}},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"subscriptionDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"amount":{"type":"number","format":"decimal"},"taxAmount":{"type":"number","format":"decimal"},"taxedAmount":{"type":"number","format":"decimal"},"createdAt":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/TransactionStatus"},"currency":{"$ref":"#/components/schemas/Currency"},"instrumentDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentDto"}]},"subscriptorDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"subscriptionTypeDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"transactionItemDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionItemDto"}]},"authorization":{"type":"string","nullable":true},"errorText":{"type":"string","nullable":true},"plexoClientReference":{"type":"string","nullable":true},"plexoTransactionId":{"type":"string","nullable":true}}},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionItemDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"amount":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"paymentRequestItemStatus":{"$ref":"#/components/schemas/PaymentRequestItemStatus"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionDto"}}}},"PaymentRequestItemStatus":{"type":"integer","description":"","enum":[1,2,3]},"LinkDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"externalId":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"canUpdateSubscriptorData":{"type":"boolean"},"status":{"$ref":"#/components/schemas/LinkStatusEnum"},"subscriptorDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]}}},"LinkStatusEnum":{"type":"integer","description":"","enum":[1,2,3]},"RetriesConfigurationEnum":{"type":"integer","description":"","enum":[0,1]},"NotificationPermissionsDto":{"type":"object","additionalProperties":false,"properties":{"transactionCancellation":{"type":"boolean"},"subscriptionCancellation":{"type":"boolean"},"subscriptorFields":{"type":"boolean"},"paymentSuccess":{"type":"boolean"},"paymentFailed":{"type":"boolean"}}}}}}
```
## Obtener archivo por Id
> Obtiene el contenido de un archivo de solicitudes específico.
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Transacciones","description":"Endpoints para consultar y gestionar transacciones y archivos de débito automático."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Transactions/files/{fileId}":{"get":{"tags":["Transacciones"],"summary":"Obtener archivo por Id","description":"Obtiene el contenido de un archivo de solicitudes específico.","operationId":"Transacciones_ArchivoPorId","parameters":[{"name":"fileId","in":"path","required":true,"schema":{"type":"string","format":"guid"}}],"responses":{"200":{"description":"Éxito","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionRequestFileData"}}}},"400":{"description":"Solicitud incorrecta"}}}}},"components":{"schemas":{"TransactionRequestFileData":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","nullable":true},"url":{"type":"string","nullable":true},"date":{"type":"string","format":"date-time"},"transactionRequestItems":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionItemDto"}}}},"TransactionItemDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"amount":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"paymentRequestItemStatus":{"$ref":"#/components/schemas/PaymentRequestItemStatus"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionDto"}}}},"Currency":{"type":"integer","description":"","enum":[1,2]},"PaymentRequestItemStatus":{"type":"integer","description":"","enum":[1,2,3]},"SubscriptorDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"fullName":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionDto"}},"firstSubscribed":{"type":"string","format":"date-time","nullable":true},"links":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LinkDto"}}}},"InstrumentDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"expiration":{"type":"string","format":"date-time"},"issuerImageUrl":{"type":"string","nullable":true},"issuerName":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"token":{"type":"string","format":"guid","nullable":true},"plexoExtendedResponse":{"type":"string","nullable":true},"optionalUniqueID":{"type":"string","nullable":true}}},"ClientDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","nullable":true},"legalName":{"type":"string","nullable":true},"legalId":{"type":"string","nullable":true},"recurringPaymentUrl":{"type":"string","nullable":true},"plexoCommerceId":{"type":"integer","format":"int32"},"taxPercentage":{"type":"number","format":"decimal"},"admin":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ClientAdmin"}},"subscriptionTypesDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionTypeDto"}},"commercesDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/CommerceDto"}},"subscriptorsDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptorDto"}},"retriesConfiguration":{"$ref":"#/components/schemas/RetriesConfigurationEnum"},"notificationPermissionsDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NotificationPermissionsDto"}]}}},"ClientAdmin":{"type":"object","additionalProperties":false,"properties":{"userId":{"type":"string","nullable":true},"userName":{"type":"string","nullable":true},"clientId":{"type":"string","format":"guid"}}},"SubscriptionTypeDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"frequence":{"$ref":"#/components/schemas/Frequence"},"subscriptionBaseCost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"recurrence":{"type":"integer","format":"int32"},"regularType":{"type":"boolean"},"taxPercentage":{"type":"string","nullable":true}}},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"CommerceDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"issuer":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/IssuerDto"}]},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"fields":{"type":"object","nullable":true,"additionalProperties":{"type":"string"}}}},"IssuerDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"issuerImageUrl":{"type":"string","nullable":true},"fields":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FieldInfo"}}}},"FieldInfo":{"type":"object","additionalProperties":false,"properties":{"labelName":{"type":"string","nullable":true},"fieldType":{"$ref":"#/components/schemas/FieldType"},"required":{"type":"boolean"}}},"FieldType":{"type":"integer","description":"","enum":[257,258,259,260,261,262,263,264,265,266,267,268,269,270,271,272,273,274,513,514,515,516,517,518,519,520,521,522,523,524,525,526,527,528,529,530,531,532,533,534,535,1025,1281,1282,1283,1284,1285,1286,1287,1288,1289,1296,1297,1298,2049,2050,2051,2052,2053,2054,2055,2056,2057,2058,2059,2060,2061,2062,2063,2064,2065,2066,2067,2068,2069,2070,2071,2072,2073,2074,2075,2076,2077,2078,2079,2080,2081,2082,2083,2084,2085,2305,2306,2307,2308,2309,2310,2311,2312,2313,2320,33025,33026,33027,33028,33153,33154]},"RetriesConfigurationEnum":{"type":"integer","description":"","enum":[0,1]},"NotificationPermissionsDto":{"type":"object","additionalProperties":false,"properties":{"transactionCancellation":{"type":"boolean"},"subscriptionCancellation":{"type":"boolean"},"subscriptorFields":{"type":"boolean"},"paymentSuccess":{"type":"boolean"},"paymentFailed":{"type":"boolean"}}},"SubscriptionDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"token":{"type":"string","nullable":true},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"subscriptionDate":{"type":"string","format":"date-time"},"subscriptionStatus":{"$ref":"#/components/schemas/SubscriptionStatus"},"subscriptionLastPaymentDate":{"type":"string","format":"date-time"},"validUntil":{"type":"string","format":"date-time"},"remainingRecurrences":{"type":"integer","format":"int32","nullable":true},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionDto"}}}},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"subscriptionDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"amount":{"type":"number","format":"decimal"},"taxAmount":{"type":"number","format":"decimal"},"taxedAmount":{"type":"number","format":"decimal"},"createdAt":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/TransactionStatus"},"currency":{"$ref":"#/components/schemas/Currency"},"instrumentDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentDto"}]},"subscriptorDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"subscriptionTypeDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"transactionItemDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionItemDto"}]},"authorization":{"type":"string","nullable":true},"errorText":{"type":"string","nullable":true},"plexoClientReference":{"type":"string","nullable":true},"plexoTransactionId":{"type":"string","nullable":true}}},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"LinkDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"externalId":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"canUpdateSubscriptorData":{"type":"boolean"},"status":{"$ref":"#/components/schemas/LinkStatusEnum"},"subscriptorDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]}}},"LinkStatusEnum":{"type":"integer","description":"","enum":[1,2,3]}}}}
```
## Débitos por suscriptor
> Obtiene las transacciones de débito automático de un suscriptor.
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"tags":[{"name":"Transacciones","description":"Endpoints para consultar y gestionar transacciones y archivos de débito automático."}],"servers":[{"url":"https://suscripcionestest.handsoft.com.uy"}],"paths":{"/subscriptions/api/Transactions/debits/{subscriptorId}":{"get":{"tags":["Transacciones"],"summary":"Débitos por suscriptor","description":"Obtiene las transacciones de débito automático de un suscriptor.","operationId":"Transacciones_DebitosPorSuscriptor","parameters":[{"name":"subscriptorId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Éxito","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TransactionDto"}}}}},"400":{"description":"Solicitud incorrecta"}}}}},"components":{"schemas":{"TransactionDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"subscriptionDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"amount":{"type":"number","format":"decimal"},"taxAmount":{"type":"number","format":"decimal"},"taxedAmount":{"type":"number","format":"decimal"},"createdAt":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/TransactionStatus"},"currency":{"$ref":"#/components/schemas/Currency"},"instrumentDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentDto"}]},"subscriptorDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"subscriptionTypeDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"transactionItemDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionItemDto"}]},"authorization":{"type":"string","nullable":true},"errorText":{"type":"string","nullable":true},"plexoClientReference":{"type":"string","nullable":true},"plexoTransactionId":{"type":"string","nullable":true}}},"SubscriptionDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"token":{"type":"string","nullable":true},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"subscriptionDate":{"type":"string","format":"date-time"},"subscriptionStatus":{"$ref":"#/components/schemas/SubscriptionStatus"},"subscriptionLastPaymentDate":{"type":"string","format":"date-time"},"validUntil":{"type":"string","format":"date-time"},"remainingRecurrences":{"type":"integer","format":"int32","nullable":true},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionDto"}}}},"SubscriptionTypeDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"frequence":{"$ref":"#/components/schemas/Frequence"},"subscriptionBaseCost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"recurrence":{"type":"integer","format":"int32"},"regularType":{"type":"boolean"},"taxPercentage":{"type":"string","nullable":true}}},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"ClientDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","nullable":true},"legalName":{"type":"string","nullable":true},"legalId":{"type":"string","nullable":true},"recurringPaymentUrl":{"type":"string","nullable":true},"plexoCommerceId":{"type":"integer","format":"int32"},"taxPercentage":{"type":"number","format":"decimal"},"admin":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ClientAdmin"}},"subscriptionTypesDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionTypeDto"}},"commercesDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/CommerceDto"}},"subscriptorsDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptorDto"}},"retriesConfiguration":{"$ref":"#/components/schemas/RetriesConfigurationEnum"},"notificationPermissionsDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NotificationPermissionsDto"}]}}},"ClientAdmin":{"type":"object","additionalProperties":false,"properties":{"userId":{"type":"string","nullable":true},"userName":{"type":"string","nullable":true},"clientId":{"type":"string","format":"guid"}}},"CommerceDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"issuer":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/IssuerDto"}]},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"fields":{"type":"object","nullable":true,"additionalProperties":{"type":"string"}}}},"IssuerDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"issuerImageUrl":{"type":"string","nullable":true},"fields":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FieldInfo"}}}},"FieldInfo":{"type":"object","additionalProperties":false,"properties":{"labelName":{"type":"string","nullable":true},"fieldType":{"$ref":"#/components/schemas/FieldType"},"required":{"type":"boolean"}}},"FieldType":{"type":"integer","description":"","enum":[257,258,259,260,261,262,263,264,265,266,267,268,269,270,271,272,273,274,513,514,515,516,517,518,519,520,521,522,523,524,525,526,527,528,529,530,531,532,533,534,535,1025,1281,1282,1283,1284,1285,1286,1287,1288,1289,1296,1297,1298,2049,2050,2051,2052,2053,2054,2055,2056,2057,2058,2059,2060,2061,2062,2063,2064,2065,2066,2067,2068,2069,2070,2071,2072,2073,2074,2075,2076,2077,2078,2079,2080,2081,2082,2083,2084,2085,2305,2306,2307,2308,2309,2310,2311,2312,2313,2320,33025,33026,33027,33028,33153,33154]},"SubscriptorDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"fullName":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionDto"}},"firstSubscribed":{"type":"string","format":"date-time","nullable":true},"links":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LinkDto"}}}},"InstrumentDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"expiration":{"type":"string","format":"date-time"},"issuerImageUrl":{"type":"string","nullable":true},"issuerName":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"token":{"type":"string","format":"guid","nullable":true},"plexoExtendedResponse":{"type":"string","nullable":true},"optionalUniqueID":{"type":"string","nullable":true}}},"LinkDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"externalId":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"canUpdateSubscriptorData":{"type":"boolean"},"status":{"$ref":"#/components/schemas/LinkStatusEnum"},"subscriptorDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]}}},"LinkStatusEnum":{"type":"integer","description":"","enum":[1,2,3]},"RetriesConfigurationEnum":{"type":"integer","description":"","enum":[0,1]},"NotificationPermissionsDto":{"type":"object","additionalProperties":false,"properties":{"transactionCancellation":{"type":"boolean"},"subscriptionCancellation":{"type":"boolean"},"subscriptorFields":{"type":"boolean"},"paymentSuccess":{"type":"boolean"},"paymentFailed":{"type":"boolean"}}},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionItemDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"amount":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"paymentRequestItemStatus":{"$ref":"#/components/schemas/PaymentRequestItemStatus"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionDto"}}}},"PaymentRequestItemStatus":{"type":"integer","description":"","enum":[1,2,3]}}}}
```
# Models
## The AccountStrings object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"AccountStrings":{"type":"object","additionalProperties":false,"properties":{"recurringPaymentCallback":{"type":"string","nullable":true}}}}}}
```
## The ErrorResponse object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"ErrorResponse":{"type":"object","additionalProperties":false,"properties":{"code":{"$ref":"#/components/schemas/HttpStatusCode"},"message":{"type":"string","nullable":true},"subCode":{"type":"integer","format":"int32"}}},"HttpStatusCode":{"type":"integer","description":"包含針對 HTTP 所定義的狀態碼值。","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,300,301,301,302,302,303,303,304,305,306,307,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511]}}}}
```
## The HttpStatusCode object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"HttpStatusCode":{"type":"integer","description":"包含針對 HTTP 所定義的狀態碼值。","enum":[100,101,102,103,200,201,202,203,204,205,206,207,208,226,300,300,301,301,302,302,303,303,304,305,306,307,307,308,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,421,422,423,424,426,428,429,431,451,500,501,502,503,504,505,506,507,508,510,511]}}}}
```
## The CommerceDto object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"CommerceDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"issuer":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/IssuerDto"}]},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"fields":{"type":"object","nullable":true,"additionalProperties":{"type":"string"}}}},"IssuerDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"issuerImageUrl":{"type":"string","nullable":true},"fields":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FieldInfo"}}}},"FieldInfo":{"type":"object","additionalProperties":false,"properties":{"labelName":{"type":"string","nullable":true},"fieldType":{"$ref":"#/components/schemas/FieldType"},"required":{"type":"boolean"}}},"FieldType":{"type":"integer","description":"","enum":[257,258,259,260,261,262,263,264,265,266,267,268,269,270,271,272,273,274,513,514,515,516,517,518,519,520,521,522,523,524,525,526,527,528,529,530,531,532,533,534,535,1025,1281,1282,1283,1284,1285,1286,1287,1288,1289,1296,1297,1298,2049,2050,2051,2052,2053,2054,2055,2056,2057,2058,2059,2060,2061,2062,2063,2064,2065,2066,2067,2068,2069,2070,2071,2072,2073,2074,2075,2076,2077,2078,2079,2080,2081,2082,2083,2084,2085,2305,2306,2307,2308,2309,2310,2311,2312,2313,2320,33025,33026,33027,33028,33153,33154]},"ClientDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","nullable":true},"legalName":{"type":"string","nullable":true},"legalId":{"type":"string","nullable":true},"recurringPaymentUrl":{"type":"string","nullable":true},"plexoCommerceId":{"type":"integer","format":"int32"},"taxPercentage":{"type":"number","format":"decimal"},"admin":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ClientAdmin"}},"subscriptionTypesDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionTypeDto"}},"commercesDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/CommerceDto"}},"subscriptorsDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptorDto"}},"retriesConfiguration":{"$ref":"#/components/schemas/RetriesConfigurationEnum"},"notificationPermissionsDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NotificationPermissionsDto"}]}}},"ClientAdmin":{"type":"object","additionalProperties":false,"properties":{"userId":{"type":"string","nullable":true},"userName":{"type":"string","nullable":true},"clientId":{"type":"string","format":"guid"}}},"SubscriptionTypeDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"frequence":{"$ref":"#/components/schemas/Frequence"},"subscriptionBaseCost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"recurrence":{"type":"integer","format":"int32"},"regularType":{"type":"boolean"},"taxPercentage":{"type":"string","nullable":true}}},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"SubscriptorDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"fullName":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionDto"}},"firstSubscribed":{"type":"string","format":"date-time","nullable":true},"links":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LinkDto"}}}},"InstrumentDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"expiration":{"type":"string","format":"date-time"},"issuerImageUrl":{"type":"string","nullable":true},"issuerName":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"token":{"type":"string","format":"guid","nullable":true},"plexoExtendedResponse":{"type":"string","nullable":true},"optionalUniqueID":{"type":"string","nullable":true}}},"SubscriptionDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"token":{"type":"string","nullable":true},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"subscriptionDate":{"type":"string","format":"date-time"},"subscriptionStatus":{"$ref":"#/components/schemas/SubscriptionStatus"},"subscriptionLastPaymentDate":{"type":"string","format":"date-time"},"validUntil":{"type":"string","format":"date-time"},"remainingRecurrences":{"type":"integer","format":"int32","nullable":true},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionDto"}}}},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"subscriptionDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"amount":{"type":"number","format":"decimal"},"taxAmount":{"type":"number","format":"decimal"},"taxedAmount":{"type":"number","format":"decimal"},"createdAt":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/TransactionStatus"},"currency":{"$ref":"#/components/schemas/Currency"},"instrumentDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentDto"}]},"subscriptorDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"subscriptionTypeDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"transactionItemDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionItemDto"}]},"authorization":{"type":"string","nullable":true},"errorText":{"type":"string","nullable":true},"plexoClientReference":{"type":"string","nullable":true},"plexoTransactionId":{"type":"string","nullable":true}}},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionItemDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"amount":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"paymentRequestItemStatus":{"$ref":"#/components/schemas/PaymentRequestItemStatus"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionDto"}}}},"PaymentRequestItemStatus":{"type":"integer","description":"","enum":[1,2,3]},"LinkDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"externalId":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"canUpdateSubscriptorData":{"type":"boolean"},"status":{"$ref":"#/components/schemas/LinkStatusEnum"},"subscriptorDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]}}},"LinkStatusEnum":{"type":"integer","description":"","enum":[1,2,3]},"RetriesConfigurationEnum":{"type":"integer","description":"","enum":[0,1]},"NotificationPermissionsDto":{"type":"object","additionalProperties":false,"properties":{"transactionCancellation":{"type":"boolean"},"subscriptionCancellation":{"type":"boolean"},"subscriptorFields":{"type":"boolean"},"paymentSuccess":{"type":"boolean"},"paymentFailed":{"type":"boolean"}}}}}}
```
## The IssuerDto object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"IssuerDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"issuerImageUrl":{"type":"string","nullable":true},"fields":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FieldInfo"}}}},"FieldInfo":{"type":"object","additionalProperties":false,"properties":{"labelName":{"type":"string","nullable":true},"fieldType":{"$ref":"#/components/schemas/FieldType"},"required":{"type":"boolean"}}},"FieldType":{"type":"integer","description":"","enum":[257,258,259,260,261,262,263,264,265,266,267,268,269,270,271,272,273,274,513,514,515,516,517,518,519,520,521,522,523,524,525,526,527,528,529,530,531,532,533,534,535,1025,1281,1282,1283,1284,1285,1286,1287,1288,1289,1296,1297,1298,2049,2050,2051,2052,2053,2054,2055,2056,2057,2058,2059,2060,2061,2062,2063,2064,2065,2066,2067,2068,2069,2070,2071,2072,2073,2074,2075,2076,2077,2078,2079,2080,2081,2082,2083,2084,2085,2305,2306,2307,2308,2309,2310,2311,2312,2313,2320,33025,33026,33027,33028,33153,33154]}}}}
```
## The FieldInfo object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"FieldInfo":{"type":"object","additionalProperties":false,"properties":{"labelName":{"type":"string","nullable":true},"fieldType":{"$ref":"#/components/schemas/FieldType"},"required":{"type":"boolean"}}},"FieldType":{"type":"integer","description":"","enum":[257,258,259,260,261,262,263,264,265,266,267,268,269,270,271,272,273,274,513,514,515,516,517,518,519,520,521,522,523,524,525,526,527,528,529,530,531,532,533,534,535,1025,1281,1282,1283,1284,1285,1286,1287,1288,1289,1296,1297,1298,2049,2050,2051,2052,2053,2054,2055,2056,2057,2058,2059,2060,2061,2062,2063,2064,2065,2066,2067,2068,2069,2070,2071,2072,2073,2074,2075,2076,2077,2078,2079,2080,2081,2082,2083,2084,2085,2305,2306,2307,2308,2309,2310,2311,2312,2313,2320,33025,33026,33027,33028,33153,33154]}}}}
```
## The FieldType object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"FieldType":{"type":"integer","description":"","enum":[257,258,259,260,261,262,263,264,265,266,267,268,269,270,271,272,273,274,513,514,515,516,517,518,519,520,521,522,523,524,525,526,527,528,529,530,531,532,533,534,535,1025,1281,1282,1283,1284,1285,1286,1287,1288,1289,1296,1297,1298,2049,2050,2051,2052,2053,2054,2055,2056,2057,2058,2059,2060,2061,2062,2063,2064,2065,2066,2067,2068,2069,2070,2071,2072,2073,2074,2075,2076,2077,2078,2079,2080,2081,2082,2083,2084,2085,2305,2306,2307,2308,2309,2310,2311,2312,2313,2320,33025,33026,33027,33028,33153,33154]}}}}
```
## The ClientDto object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"ClientDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","nullable":true},"legalName":{"type":"string","nullable":true},"legalId":{"type":"string","nullable":true},"recurringPaymentUrl":{"type":"string","nullable":true},"plexoCommerceId":{"type":"integer","format":"int32"},"taxPercentage":{"type":"number","format":"decimal"},"admin":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ClientAdmin"}},"subscriptionTypesDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionTypeDto"}},"commercesDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/CommerceDto"}},"subscriptorsDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptorDto"}},"retriesConfiguration":{"$ref":"#/components/schemas/RetriesConfigurationEnum"},"notificationPermissionsDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NotificationPermissionsDto"}]}}},"ClientAdmin":{"type":"object","additionalProperties":false,"properties":{"userId":{"type":"string","nullable":true},"userName":{"type":"string","nullable":true},"clientId":{"type":"string","format":"guid"}}},"SubscriptionTypeDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"frequence":{"$ref":"#/components/schemas/Frequence"},"subscriptionBaseCost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"recurrence":{"type":"integer","format":"int32"},"regularType":{"type":"boolean"},"taxPercentage":{"type":"string","nullable":true}}},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"CommerceDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"issuer":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/IssuerDto"}]},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"fields":{"type":"object","nullable":true,"additionalProperties":{"type":"string"}}}},"IssuerDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"issuerImageUrl":{"type":"string","nullable":true},"fields":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FieldInfo"}}}},"FieldInfo":{"type":"object","additionalProperties":false,"properties":{"labelName":{"type":"string","nullable":true},"fieldType":{"$ref":"#/components/schemas/FieldType"},"required":{"type":"boolean"}}},"FieldType":{"type":"integer","description":"","enum":[257,258,259,260,261,262,263,264,265,266,267,268,269,270,271,272,273,274,513,514,515,516,517,518,519,520,521,522,523,524,525,526,527,528,529,530,531,532,533,534,535,1025,1281,1282,1283,1284,1285,1286,1287,1288,1289,1296,1297,1298,2049,2050,2051,2052,2053,2054,2055,2056,2057,2058,2059,2060,2061,2062,2063,2064,2065,2066,2067,2068,2069,2070,2071,2072,2073,2074,2075,2076,2077,2078,2079,2080,2081,2082,2083,2084,2085,2305,2306,2307,2308,2309,2310,2311,2312,2313,2320,33025,33026,33027,33028,33153,33154]},"SubscriptorDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"fullName":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionDto"}},"firstSubscribed":{"type":"string","format":"date-time","nullable":true},"links":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LinkDto"}}}},"InstrumentDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"expiration":{"type":"string","format":"date-time"},"issuerImageUrl":{"type":"string","nullable":true},"issuerName":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"token":{"type":"string","format":"guid","nullable":true},"plexoExtendedResponse":{"type":"string","nullable":true},"optionalUniqueID":{"type":"string","nullable":true}}},"SubscriptionDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"token":{"type":"string","nullable":true},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"subscriptionDate":{"type":"string","format":"date-time"},"subscriptionStatus":{"$ref":"#/components/schemas/SubscriptionStatus"},"subscriptionLastPaymentDate":{"type":"string","format":"date-time"},"validUntil":{"type":"string","format":"date-time"},"remainingRecurrences":{"type":"integer","format":"int32","nullable":true},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionDto"}}}},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"subscriptionDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"amount":{"type":"number","format":"decimal"},"taxAmount":{"type":"number","format":"decimal"},"taxedAmount":{"type":"number","format":"decimal"},"createdAt":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/TransactionStatus"},"currency":{"$ref":"#/components/schemas/Currency"},"instrumentDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentDto"}]},"subscriptorDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"subscriptionTypeDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"transactionItemDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionItemDto"}]},"authorization":{"type":"string","nullable":true},"errorText":{"type":"string","nullable":true},"plexoClientReference":{"type":"string","nullable":true},"plexoTransactionId":{"type":"string","nullable":true}}},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionItemDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"amount":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"paymentRequestItemStatus":{"$ref":"#/components/schemas/PaymentRequestItemStatus"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionDto"}}}},"PaymentRequestItemStatus":{"type":"integer","description":"","enum":[1,2,3]},"LinkDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"externalId":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"canUpdateSubscriptorData":{"type":"boolean"},"status":{"$ref":"#/components/schemas/LinkStatusEnum"},"subscriptorDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]}}},"LinkStatusEnum":{"type":"integer","description":"","enum":[1,2,3]},"RetriesConfigurationEnum":{"type":"integer","description":"","enum":[0,1]},"NotificationPermissionsDto":{"type":"object","additionalProperties":false,"properties":{"transactionCancellation":{"type":"boolean"},"subscriptionCancellation":{"type":"boolean"},"subscriptorFields":{"type":"boolean"},"paymentSuccess":{"type":"boolean"},"paymentFailed":{"type":"boolean"}}}}}}
```
## The ClientAdmin object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"ClientAdmin":{"type":"object","additionalProperties":false,"properties":{"userId":{"type":"string","nullable":true},"userName":{"type":"string","nullable":true},"clientId":{"type":"string","format":"guid"}}}}}}
```
## The SubscriptionTypeDto object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"SubscriptionTypeDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"frequence":{"$ref":"#/components/schemas/Frequence"},"subscriptionBaseCost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"recurrence":{"type":"integer","format":"int32"},"regularType":{"type":"boolean"},"taxPercentage":{"type":"string","nullable":true}}},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]}}}}
```
## The Frequence object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]}}}}
```
## The Currency object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"Currency":{"type":"integer","description":"","enum":[1,2]}}}}
```
## The SubscriptorDto object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"SubscriptorDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"fullName":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionDto"}},"firstSubscribed":{"type":"string","format":"date-time","nullable":true},"links":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LinkDto"}}}},"InstrumentDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"expiration":{"type":"string","format":"date-time"},"issuerImageUrl":{"type":"string","nullable":true},"issuerName":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"token":{"type":"string","format":"guid","nullable":true},"plexoExtendedResponse":{"type":"string","nullable":true},"optionalUniqueID":{"type":"string","nullable":true}}},"ClientDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","nullable":true},"legalName":{"type":"string","nullable":true},"legalId":{"type":"string","nullable":true},"recurringPaymentUrl":{"type":"string","nullable":true},"plexoCommerceId":{"type":"integer","format":"int32"},"taxPercentage":{"type":"number","format":"decimal"},"admin":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ClientAdmin"}},"subscriptionTypesDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionTypeDto"}},"commercesDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/CommerceDto"}},"subscriptorsDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptorDto"}},"retriesConfiguration":{"$ref":"#/components/schemas/RetriesConfigurationEnum"},"notificationPermissionsDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NotificationPermissionsDto"}]}}},"ClientAdmin":{"type":"object","additionalProperties":false,"properties":{"userId":{"type":"string","nullable":true},"userName":{"type":"string","nullable":true},"clientId":{"type":"string","format":"guid"}}},"SubscriptionTypeDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"frequence":{"$ref":"#/components/schemas/Frequence"},"subscriptionBaseCost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"recurrence":{"type":"integer","format":"int32"},"regularType":{"type":"boolean"},"taxPercentage":{"type":"string","nullable":true}}},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"CommerceDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"issuer":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/IssuerDto"}]},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"fields":{"type":"object","nullable":true,"additionalProperties":{"type":"string"}}}},"IssuerDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"issuerImageUrl":{"type":"string","nullable":true},"fields":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FieldInfo"}}}},"FieldInfo":{"type":"object","additionalProperties":false,"properties":{"labelName":{"type":"string","nullable":true},"fieldType":{"$ref":"#/components/schemas/FieldType"},"required":{"type":"boolean"}}},"FieldType":{"type":"integer","description":"","enum":[257,258,259,260,261,262,263,264,265,266,267,268,269,270,271,272,273,274,513,514,515,516,517,518,519,520,521,522,523,524,525,526,527,528,529,530,531,532,533,534,535,1025,1281,1282,1283,1284,1285,1286,1287,1288,1289,1296,1297,1298,2049,2050,2051,2052,2053,2054,2055,2056,2057,2058,2059,2060,2061,2062,2063,2064,2065,2066,2067,2068,2069,2070,2071,2072,2073,2074,2075,2076,2077,2078,2079,2080,2081,2082,2083,2084,2085,2305,2306,2307,2308,2309,2310,2311,2312,2313,2320,33025,33026,33027,33028,33153,33154]},"SubscriptionDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"token":{"type":"string","nullable":true},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"subscriptionDate":{"type":"string","format":"date-time"},"subscriptionStatus":{"$ref":"#/components/schemas/SubscriptionStatus"},"subscriptionLastPaymentDate":{"type":"string","format":"date-time"},"validUntil":{"type":"string","format":"date-time"},"remainingRecurrences":{"type":"integer","format":"int32","nullable":true},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionDto"}}}},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"subscriptionDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"amount":{"type":"number","format":"decimal"},"taxAmount":{"type":"number","format":"decimal"},"taxedAmount":{"type":"number","format":"decimal"},"createdAt":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/TransactionStatus"},"currency":{"$ref":"#/components/schemas/Currency"},"instrumentDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentDto"}]},"subscriptorDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"subscriptionTypeDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"transactionItemDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionItemDto"}]},"authorization":{"type":"string","nullable":true},"errorText":{"type":"string","nullable":true},"plexoClientReference":{"type":"string","nullable":true},"plexoTransactionId":{"type":"string","nullable":true}}},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionItemDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"amount":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"paymentRequestItemStatus":{"$ref":"#/components/schemas/PaymentRequestItemStatus"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionDto"}}}},"PaymentRequestItemStatus":{"type":"integer","description":"","enum":[1,2,3]},"LinkDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"externalId":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"canUpdateSubscriptorData":{"type":"boolean"},"status":{"$ref":"#/components/schemas/LinkStatusEnum"},"subscriptorDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]}}},"LinkStatusEnum":{"type":"integer","description":"","enum":[1,2,3]},"RetriesConfigurationEnum":{"type":"integer","description":"","enum":[0,1]},"NotificationPermissionsDto":{"type":"object","additionalProperties":false,"properties":{"transactionCancellation":{"type":"boolean"},"subscriptionCancellation":{"type":"boolean"},"subscriptorFields":{"type":"boolean"},"paymentSuccess":{"type":"boolean"},"paymentFailed":{"type":"boolean"}}}}}}
```
## The InstrumentDto object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"InstrumentDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"expiration":{"type":"string","format":"date-time"},"issuerImageUrl":{"type":"string","nullable":true},"issuerName":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"token":{"type":"string","format":"guid","nullable":true},"plexoExtendedResponse":{"type":"string","nullable":true},"optionalUniqueID":{"type":"string","nullable":true}}}}}}
```
## The SubscriptionDto object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"SubscriptionDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"token":{"type":"string","nullable":true},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"subscriptionDate":{"type":"string","format":"date-time"},"subscriptionStatus":{"$ref":"#/components/schemas/SubscriptionStatus"},"subscriptionLastPaymentDate":{"type":"string","format":"date-time"},"validUntil":{"type":"string","format":"date-time"},"remainingRecurrences":{"type":"integer","format":"int32","nullable":true},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionDto"}}}},"SubscriptionTypeDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"frequence":{"$ref":"#/components/schemas/Frequence"},"subscriptionBaseCost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"recurrence":{"type":"integer","format":"int32"},"regularType":{"type":"boolean"},"taxPercentage":{"type":"string","nullable":true}}},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"subscriptionDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"amount":{"type":"number","format":"decimal"},"taxAmount":{"type":"number","format":"decimal"},"taxedAmount":{"type":"number","format":"decimal"},"createdAt":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/TransactionStatus"},"currency":{"$ref":"#/components/schemas/Currency"},"instrumentDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentDto"}]},"subscriptorDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"subscriptionTypeDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"transactionItemDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionItemDto"}]},"authorization":{"type":"string","nullable":true},"errorText":{"type":"string","nullable":true},"plexoClientReference":{"type":"string","nullable":true},"plexoTransactionId":{"type":"string","nullable":true}}},"ClientDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","nullable":true},"legalName":{"type":"string","nullable":true},"legalId":{"type":"string","nullable":true},"recurringPaymentUrl":{"type":"string","nullable":true},"plexoCommerceId":{"type":"integer","format":"int32"},"taxPercentage":{"type":"number","format":"decimal"},"admin":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ClientAdmin"}},"subscriptionTypesDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionTypeDto"}},"commercesDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/CommerceDto"}},"subscriptorsDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptorDto"}},"retriesConfiguration":{"$ref":"#/components/schemas/RetriesConfigurationEnum"},"notificationPermissionsDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NotificationPermissionsDto"}]}}},"ClientAdmin":{"type":"object","additionalProperties":false,"properties":{"userId":{"type":"string","nullable":true},"userName":{"type":"string","nullable":true},"clientId":{"type":"string","format":"guid"}}},"CommerceDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"issuer":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/IssuerDto"}]},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"fields":{"type":"object","nullable":true,"additionalProperties":{"type":"string"}}}},"IssuerDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"issuerImageUrl":{"type":"string","nullable":true},"fields":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FieldInfo"}}}},"FieldInfo":{"type":"object","additionalProperties":false,"properties":{"labelName":{"type":"string","nullable":true},"fieldType":{"$ref":"#/components/schemas/FieldType"},"required":{"type":"boolean"}}},"FieldType":{"type":"integer","description":"","enum":[257,258,259,260,261,262,263,264,265,266,267,268,269,270,271,272,273,274,513,514,515,516,517,518,519,520,521,522,523,524,525,526,527,528,529,530,531,532,533,534,535,1025,1281,1282,1283,1284,1285,1286,1287,1288,1289,1296,1297,1298,2049,2050,2051,2052,2053,2054,2055,2056,2057,2058,2059,2060,2061,2062,2063,2064,2065,2066,2067,2068,2069,2070,2071,2072,2073,2074,2075,2076,2077,2078,2079,2080,2081,2082,2083,2084,2085,2305,2306,2307,2308,2309,2310,2311,2312,2313,2320,33025,33026,33027,33028,33153,33154]},"SubscriptorDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"fullName":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionDto"}},"firstSubscribed":{"type":"string","format":"date-time","nullable":true},"links":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LinkDto"}}}},"InstrumentDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"expiration":{"type":"string","format":"date-time"},"issuerImageUrl":{"type":"string","nullable":true},"issuerName":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"token":{"type":"string","format":"guid","nullable":true},"plexoExtendedResponse":{"type":"string","nullable":true},"optionalUniqueID":{"type":"string","nullable":true}}},"LinkDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"externalId":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"canUpdateSubscriptorData":{"type":"boolean"},"status":{"$ref":"#/components/schemas/LinkStatusEnum"},"subscriptorDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]}}},"LinkStatusEnum":{"type":"integer","description":"","enum":[1,2,3]},"RetriesConfigurationEnum":{"type":"integer","description":"","enum":[0,1]},"NotificationPermissionsDto":{"type":"object","additionalProperties":false,"properties":{"transactionCancellation":{"type":"boolean"},"subscriptionCancellation":{"type":"boolean"},"subscriptorFields":{"type":"boolean"},"paymentSuccess":{"type":"boolean"},"paymentFailed":{"type":"boolean"}}},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionItemDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"amount":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"paymentRequestItemStatus":{"$ref":"#/components/schemas/PaymentRequestItemStatus"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionDto"}}}},"PaymentRequestItemStatus":{"type":"integer","description":"","enum":[1,2,3]}}}}
```
## The SubscriptionStatus object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]}}}}
```
## The TransactionDto object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"TransactionDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"subscriptionDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"amount":{"type":"number","format":"decimal"},"taxAmount":{"type":"number","format":"decimal"},"taxedAmount":{"type":"number","format":"decimal"},"createdAt":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/TransactionStatus"},"currency":{"$ref":"#/components/schemas/Currency"},"instrumentDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentDto"}]},"subscriptorDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"subscriptionTypeDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"transactionItemDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionItemDto"}]},"authorization":{"type":"string","nullable":true},"errorText":{"type":"string","nullable":true},"plexoClientReference":{"type":"string","nullable":true},"plexoTransactionId":{"type":"string","nullable":true}}},"SubscriptionDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"token":{"type":"string","nullable":true},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"subscriptionDate":{"type":"string","format":"date-time"},"subscriptionStatus":{"$ref":"#/components/schemas/SubscriptionStatus"},"subscriptionLastPaymentDate":{"type":"string","format":"date-time"},"validUntil":{"type":"string","format":"date-time"},"remainingRecurrences":{"type":"integer","format":"int32","nullable":true},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionDto"}}}},"SubscriptionTypeDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"frequence":{"$ref":"#/components/schemas/Frequence"},"subscriptionBaseCost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"recurrence":{"type":"integer","format":"int32"},"regularType":{"type":"boolean"},"taxPercentage":{"type":"string","nullable":true}}},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"ClientDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","nullable":true},"legalName":{"type":"string","nullable":true},"legalId":{"type":"string","nullable":true},"recurringPaymentUrl":{"type":"string","nullable":true},"plexoCommerceId":{"type":"integer","format":"int32"},"taxPercentage":{"type":"number","format":"decimal"},"admin":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ClientAdmin"}},"subscriptionTypesDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionTypeDto"}},"commercesDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/CommerceDto"}},"subscriptorsDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptorDto"}},"retriesConfiguration":{"$ref":"#/components/schemas/RetriesConfigurationEnum"},"notificationPermissionsDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NotificationPermissionsDto"}]}}},"ClientAdmin":{"type":"object","additionalProperties":false,"properties":{"userId":{"type":"string","nullable":true},"userName":{"type":"string","nullable":true},"clientId":{"type":"string","format":"guid"}}},"CommerceDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"issuer":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/IssuerDto"}]},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"fields":{"type":"object","nullable":true,"additionalProperties":{"type":"string"}}}},"IssuerDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"issuerImageUrl":{"type":"string","nullable":true},"fields":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FieldInfo"}}}},"FieldInfo":{"type":"object","additionalProperties":false,"properties":{"labelName":{"type":"string","nullable":true},"fieldType":{"$ref":"#/components/schemas/FieldType"},"required":{"type":"boolean"}}},"FieldType":{"type":"integer","description":"","enum":[257,258,259,260,261,262,263,264,265,266,267,268,269,270,271,272,273,274,513,514,515,516,517,518,519,520,521,522,523,524,525,526,527,528,529,530,531,532,533,534,535,1025,1281,1282,1283,1284,1285,1286,1287,1288,1289,1296,1297,1298,2049,2050,2051,2052,2053,2054,2055,2056,2057,2058,2059,2060,2061,2062,2063,2064,2065,2066,2067,2068,2069,2070,2071,2072,2073,2074,2075,2076,2077,2078,2079,2080,2081,2082,2083,2084,2085,2305,2306,2307,2308,2309,2310,2311,2312,2313,2320,33025,33026,33027,33028,33153,33154]},"SubscriptorDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"fullName":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionDto"}},"firstSubscribed":{"type":"string","format":"date-time","nullable":true},"links":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LinkDto"}}}},"InstrumentDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"expiration":{"type":"string","format":"date-time"},"issuerImageUrl":{"type":"string","nullable":true},"issuerName":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"token":{"type":"string","format":"guid","nullable":true},"plexoExtendedResponse":{"type":"string","nullable":true},"optionalUniqueID":{"type":"string","nullable":true}}},"LinkDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"externalId":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"canUpdateSubscriptorData":{"type":"boolean"},"status":{"$ref":"#/components/schemas/LinkStatusEnum"},"subscriptorDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]}}},"LinkStatusEnum":{"type":"integer","description":"","enum":[1,2,3]},"RetriesConfigurationEnum":{"type":"integer","description":"","enum":[0,1]},"NotificationPermissionsDto":{"type":"object","additionalProperties":false,"properties":{"transactionCancellation":{"type":"boolean"},"subscriptionCancellation":{"type":"boolean"},"subscriptorFields":{"type":"boolean"},"paymentSuccess":{"type":"boolean"},"paymentFailed":{"type":"boolean"}}},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionItemDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"amount":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"paymentRequestItemStatus":{"$ref":"#/components/schemas/PaymentRequestItemStatus"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionDto"}}}},"PaymentRequestItemStatus":{"type":"integer","description":"","enum":[1,2,3]}}}}
```
## The TransactionStatus object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]}}}}
```
## The TransactionItemDto object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"TransactionItemDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"amount":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"paymentRequestItemStatus":{"$ref":"#/components/schemas/PaymentRequestItemStatus"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionDto"}}}},"Currency":{"type":"integer","description":"","enum":[1,2]},"PaymentRequestItemStatus":{"type":"integer","description":"","enum":[1,2,3]},"SubscriptorDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"fullName":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionDto"}},"firstSubscribed":{"type":"string","format":"date-time","nullable":true},"links":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LinkDto"}}}},"InstrumentDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"expiration":{"type":"string","format":"date-time"},"issuerImageUrl":{"type":"string","nullable":true},"issuerName":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"token":{"type":"string","format":"guid","nullable":true},"plexoExtendedResponse":{"type":"string","nullable":true},"optionalUniqueID":{"type":"string","nullable":true}}},"ClientDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","nullable":true},"legalName":{"type":"string","nullable":true},"legalId":{"type":"string","nullable":true},"recurringPaymentUrl":{"type":"string","nullable":true},"plexoCommerceId":{"type":"integer","format":"int32"},"taxPercentage":{"type":"number","format":"decimal"},"admin":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ClientAdmin"}},"subscriptionTypesDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionTypeDto"}},"commercesDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/CommerceDto"}},"subscriptorsDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptorDto"}},"retriesConfiguration":{"$ref":"#/components/schemas/RetriesConfigurationEnum"},"notificationPermissionsDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NotificationPermissionsDto"}]}}},"ClientAdmin":{"type":"object","additionalProperties":false,"properties":{"userId":{"type":"string","nullable":true},"userName":{"type":"string","nullable":true},"clientId":{"type":"string","format":"guid"}}},"SubscriptionTypeDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"frequence":{"$ref":"#/components/schemas/Frequence"},"subscriptionBaseCost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"recurrence":{"type":"integer","format":"int32"},"regularType":{"type":"boolean"},"taxPercentage":{"type":"string","nullable":true}}},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"CommerceDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"issuer":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/IssuerDto"}]},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"fields":{"type":"object","nullable":true,"additionalProperties":{"type":"string"}}}},"IssuerDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"issuerImageUrl":{"type":"string","nullable":true},"fields":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FieldInfo"}}}},"FieldInfo":{"type":"object","additionalProperties":false,"properties":{"labelName":{"type":"string","nullable":true},"fieldType":{"$ref":"#/components/schemas/FieldType"},"required":{"type":"boolean"}}},"FieldType":{"type":"integer","description":"","enum":[257,258,259,260,261,262,263,264,265,266,267,268,269,270,271,272,273,274,513,514,515,516,517,518,519,520,521,522,523,524,525,526,527,528,529,530,531,532,533,534,535,1025,1281,1282,1283,1284,1285,1286,1287,1288,1289,1296,1297,1298,2049,2050,2051,2052,2053,2054,2055,2056,2057,2058,2059,2060,2061,2062,2063,2064,2065,2066,2067,2068,2069,2070,2071,2072,2073,2074,2075,2076,2077,2078,2079,2080,2081,2082,2083,2084,2085,2305,2306,2307,2308,2309,2310,2311,2312,2313,2320,33025,33026,33027,33028,33153,33154]},"RetriesConfigurationEnum":{"type":"integer","description":"","enum":[0,1]},"NotificationPermissionsDto":{"type":"object","additionalProperties":false,"properties":{"transactionCancellation":{"type":"boolean"},"subscriptionCancellation":{"type":"boolean"},"subscriptorFields":{"type":"boolean"},"paymentSuccess":{"type":"boolean"},"paymentFailed":{"type":"boolean"}}},"SubscriptionDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"token":{"type":"string","nullable":true},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"subscriptionDate":{"type":"string","format":"date-time"},"subscriptionStatus":{"$ref":"#/components/schemas/SubscriptionStatus"},"subscriptionLastPaymentDate":{"type":"string","format":"date-time"},"validUntil":{"type":"string","format":"date-time"},"remainingRecurrences":{"type":"integer","format":"int32","nullable":true},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionDto"}}}},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"subscriptionDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"amount":{"type":"number","format":"decimal"},"taxAmount":{"type":"number","format":"decimal"},"taxedAmount":{"type":"number","format":"decimal"},"createdAt":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/TransactionStatus"},"currency":{"$ref":"#/components/schemas/Currency"},"instrumentDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentDto"}]},"subscriptorDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"subscriptionTypeDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"transactionItemDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionItemDto"}]},"authorization":{"type":"string","nullable":true},"errorText":{"type":"string","nullable":true},"plexoClientReference":{"type":"string","nullable":true},"plexoTransactionId":{"type":"string","nullable":true}}},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"LinkDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"externalId":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"canUpdateSubscriptorData":{"type":"boolean"},"status":{"$ref":"#/components/schemas/LinkStatusEnum"},"subscriptorDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]}}},"LinkStatusEnum":{"type":"integer","description":"","enum":[1,2,3]}}}}
```
## The PaymentRequestItemStatus object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"PaymentRequestItemStatus":{"type":"integer","description":"","enum":[1,2,3]}}}}
```
## The LinkDto object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"LinkDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"externalId":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"canUpdateSubscriptorData":{"type":"boolean"},"status":{"$ref":"#/components/schemas/LinkStatusEnum"},"subscriptorDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]}}},"LinkStatusEnum":{"type":"integer","description":"","enum":[1,2,3]},"SubscriptorDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"fullName":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionDto"}},"firstSubscribed":{"type":"string","format":"date-time","nullable":true},"links":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LinkDto"}}}},"InstrumentDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"expiration":{"type":"string","format":"date-time"},"issuerImageUrl":{"type":"string","nullable":true},"issuerName":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"token":{"type":"string","format":"guid","nullable":true},"plexoExtendedResponse":{"type":"string","nullable":true},"optionalUniqueID":{"type":"string","nullable":true}}},"ClientDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","nullable":true},"legalName":{"type":"string","nullable":true},"legalId":{"type":"string","nullable":true},"recurringPaymentUrl":{"type":"string","nullable":true},"plexoCommerceId":{"type":"integer","format":"int32"},"taxPercentage":{"type":"number","format":"decimal"},"admin":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ClientAdmin"}},"subscriptionTypesDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionTypeDto"}},"commercesDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/CommerceDto"}},"subscriptorsDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptorDto"}},"retriesConfiguration":{"$ref":"#/components/schemas/RetriesConfigurationEnum"},"notificationPermissionsDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NotificationPermissionsDto"}]}}},"ClientAdmin":{"type":"object","additionalProperties":false,"properties":{"userId":{"type":"string","nullable":true},"userName":{"type":"string","nullable":true},"clientId":{"type":"string","format":"guid"}}},"SubscriptionTypeDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"frequence":{"$ref":"#/components/schemas/Frequence"},"subscriptionBaseCost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"recurrence":{"type":"integer","format":"int32"},"regularType":{"type":"boolean"},"taxPercentage":{"type":"string","nullable":true}}},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"CommerceDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"issuer":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/IssuerDto"}]},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"fields":{"type":"object","nullable":true,"additionalProperties":{"type":"string"}}}},"IssuerDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"issuerImageUrl":{"type":"string","nullable":true},"fields":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FieldInfo"}}}},"FieldInfo":{"type":"object","additionalProperties":false,"properties":{"labelName":{"type":"string","nullable":true},"fieldType":{"$ref":"#/components/schemas/FieldType"},"required":{"type":"boolean"}}},"FieldType":{"type":"integer","description":"","enum":[257,258,259,260,261,262,263,264,265,266,267,268,269,270,271,272,273,274,513,514,515,516,517,518,519,520,521,522,523,524,525,526,527,528,529,530,531,532,533,534,535,1025,1281,1282,1283,1284,1285,1286,1287,1288,1289,1296,1297,1298,2049,2050,2051,2052,2053,2054,2055,2056,2057,2058,2059,2060,2061,2062,2063,2064,2065,2066,2067,2068,2069,2070,2071,2072,2073,2074,2075,2076,2077,2078,2079,2080,2081,2082,2083,2084,2085,2305,2306,2307,2308,2309,2310,2311,2312,2313,2320,33025,33026,33027,33028,33153,33154]},"RetriesConfigurationEnum":{"type":"integer","description":"","enum":[0,1]},"NotificationPermissionsDto":{"type":"object","additionalProperties":false,"properties":{"transactionCancellation":{"type":"boolean"},"subscriptionCancellation":{"type":"boolean"},"subscriptorFields":{"type":"boolean"},"paymentSuccess":{"type":"boolean"},"paymentFailed":{"type":"boolean"}}},"SubscriptionDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"token":{"type":"string","nullable":true},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"subscriptionDate":{"type":"string","format":"date-time"},"subscriptionStatus":{"$ref":"#/components/schemas/SubscriptionStatus"},"subscriptionLastPaymentDate":{"type":"string","format":"date-time"},"validUntil":{"type":"string","format":"date-time"},"remainingRecurrences":{"type":"integer","format":"int32","nullable":true},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionDto"}}}},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"subscriptionDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"amount":{"type":"number","format":"decimal"},"taxAmount":{"type":"number","format":"decimal"},"taxedAmount":{"type":"number","format":"decimal"},"createdAt":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/TransactionStatus"},"currency":{"$ref":"#/components/schemas/Currency"},"instrumentDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentDto"}]},"subscriptorDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"subscriptionTypeDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"transactionItemDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionItemDto"}]},"authorization":{"type":"string","nullable":true},"errorText":{"type":"string","nullable":true},"plexoClientReference":{"type":"string","nullable":true},"plexoTransactionId":{"type":"string","nullable":true}}},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionItemDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"amount":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"paymentRequestItemStatus":{"$ref":"#/components/schemas/PaymentRequestItemStatus"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionDto"}}}},"PaymentRequestItemStatus":{"type":"integer","description":"","enum":[1,2,3]}}}}
```
## The LinkStatusEnum object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"LinkStatusEnum":{"type":"integer","description":"","enum":[1,2,3]}}}}
```
## The RetriesConfigurationEnum object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"RetriesConfigurationEnum":{"type":"integer","description":"","enum":[0,1]}}}}
```
## The NotificationPermissionsDto object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"NotificationPermissionsDto":{"type":"object","additionalProperties":false,"properties":{"transactionCancellation":{"type":"boolean"},"subscriptionCancellation":{"type":"boolean"},"subscriptorFields":{"type":"boolean"},"paymentSuccess":{"type":"boolean"},"paymentFailed":{"type":"boolean"}}}}}}
```
## The AddCommerceRequest object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"AddCommerceRequest":{"type":"object","additionalProperties":false,"properties":{"softDescriptor":{"type":"string","nullable":true},"commerceNumber":{"type":"string","nullable":true},"terminalNumber":{"type":"string","nullable":true},"issuerId":{"type":"integer","format":"int32"},"clientId":{"type":"string","format":"guid"},"availableBanks":{"type":"string","nullable":true},"acquirer":{"type":"string","nullable":true},"accountNumber":{"type":"string","nullable":true},"crossBankTransfers":{"type":"string","nullable":true},"merchantCategoryCode":{"type":"string","nullable":true},"rut":{"type":"string","nullable":true}}}}}}
```
## The AddPFCommerceRequest object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"AddPFCommerceRequest":{"type":"object","additionalProperties":false,"properties":{"commerceName":{"type":"string","nullable":true},"commerceNumber":{"type":"string","nullable":true},"commerceTerminalNumber":{"type":"string","nullable":true},"issuerId":{"type":"integer","format":"int32"},"paymentFacilitatorPlexoCommerceId":{"type":"integer","format":"int32","nullable":true},"pfId":{"type":"string","nullable":true}}}}}}
```
## The HomeDto object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"HomeDto":{"type":"object","additionalProperties":false,"properties":{"totalRegularSubscriptions":{"type":"integer","format":"int32"},"almostFinishSubscription":{"type":"integer","format":"int32"},"totalPagossuccess":{"type":"integer","format":"int32"},"totalPagoserror":{"type":"integer","format":"int32"},"historicTotalSubscriptors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/HistoricDataDto"}},"errorCategories":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ErrorCategoryDto"}},"currentMonthRevenue":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/CurrencyRevenueDto"}},"previousMonthRevenue":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/CurrencyRevenueDto"}}}},"HistoricDataDto":{"type":"object","additionalProperties":false,"properties":{"date":{"type":"string","format":"date-time"},"count":{"type":"integer","format":"int32"}}},"ErrorCategoryDto":{"type":"object","additionalProperties":false,"properties":{"category":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64"}}},"CurrencyRevenueDto":{"type":"object","additionalProperties":false,"properties":{"currency":{"$ref":"#/components/schemas/Currency"},"amount":{"type":"number","format":"decimal"}}},"Currency":{"type":"integer","description":"","enum":[1,2]}}}}
```
## The HistoricDataDto object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"HistoricDataDto":{"type":"object","additionalProperties":false,"properties":{"date":{"type":"string","format":"date-time"},"count":{"type":"integer","format":"int32"}}}}}}
```
## The ErrorCategoryDto object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"ErrorCategoryDto":{"type":"object","additionalProperties":false,"properties":{"category":{"type":"string","nullable":true},"count":{"type":"integer","format":"int64"}}}}}}
```
## The CurrencyRevenueDto object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"CurrencyRevenueDto":{"type":"object","additionalProperties":false,"properties":{"currency":{"$ref":"#/components/schemas/Currency"},"amount":{"type":"number","format":"decimal"}}},"Currency":{"type":"integer","description":"","enum":[1,2]}}}}
```
## The RegisterInstrumentResponse object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"RegisterInstrumentResponse":{"type":"object","additionalProperties":false,"properties":{"url":{"type":"string","nullable":true}}}}}}
```
## The RegisterInstrumentRequest object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"RegisterInstrumentRequest":{"type":"object","additionalProperties":false,"properties":{"callbackUrl":{"type":"string","nullable":true},"populateData":{"type":"boolean"}}}}}}
```
## The InstrumentResponse object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"InstrumentResponse":{"type":"object","additionalProperties":false,"properties":{"expiration":{"type":"string","format":"date-time"},"instrumentId":{"type":"string","nullable":true},"issuerImageUrl":{"type":"string","nullable":true},"issuerName":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"optionalUniqueID":{"type":"string","nullable":true}}}}}}
```
## The RegisterInstrumentLinkRequest object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"RegisterInstrumentLinkRequest":{"type":"object","additionalProperties":false,"properties":{"linkId":{"type":"string","format":"guid"},"clientId":{"type":"string","format":"guid"},"externalId":{"type":"string","nullable":true},"redirectUrl":{"type":"string","nullable":true},"callbackUrl":{"type":"string","nullable":true},"populateData":{"type":"boolean"}}}}}}
```
## The IssuerInfo object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"IssuerInfo":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","nullable":true},"issuerId":{"type":"integer","format":"int32"},"variationId":{"type":"integer","format":"int32"},"issuer":{"type":"string","nullable":true},"bank":{"type":"string","nullable":true},"variation":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"mayHaveAsyncPayments":{"type":"boolean"},"supportsReserve":{"type":"boolean"},"mayHavePaymentsLimits":{"type":"boolean"},"fields":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FieldInfo"}}}},"FieldInfo":{"type":"object","additionalProperties":false,"properties":{"labelName":{"type":"string","nullable":true},"fieldType":{"$ref":"#/components/schemas/FieldType"},"required":{"type":"boolean"}}},"FieldType":{"type":"integer","description":"","enum":[257,258,259,260,261,262,263,264,265,266,267,268,269,270,271,272,273,274,513,514,515,516,517,518,519,520,521,522,523,524,525,526,527,528,529,530,531,532,533,534,535,1025,1281,1282,1283,1284,1285,1286,1287,1288,1289,1296,1297,1298,2049,2050,2051,2052,2053,2054,2055,2056,2057,2058,2059,2060,2061,2062,2063,2064,2065,2066,2067,2068,2069,2070,2071,2072,2073,2074,2075,2076,2077,2078,2079,2080,2081,2082,2083,2084,2085,2305,2306,2307,2308,2309,2310,2311,2312,2313,2320,33025,33026,33027,33028,33153,33154]}}}}
```
## The CreateLinkRequest object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"CreateLinkRequest":{"type":"object","additionalProperties":false,"properties":{"externalId":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"canUpdateSubscriptorData":{"type":"boolean"},"subscriptionTypeId":{"type":"string","nullable":true}}}}}}
```
## The SubscriptionType object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"SubscriptionType":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","description","frequence","cost","currency","status","recurrence"],"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","maxLength":50,"minLength":0},"description":{"type":"string","maxLength":120,"minLength":0},"frequence":{"$ref":"#/components/schemas/Frequence"},"cost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"status":{"$ref":"#/components/schemas/SubscriptionTypeStatus"},"recurrence":{"type":"integer","format":"int32","default":0},"taxPercentage":{"type":"number","format":"decimal","nullable":true}}}]},"BaseEntity":{"type":"object","additionalProperties":false},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"SubscriptionTypeStatus":{"type":"integer","description":"","enum":[0,99]}}}}
```
## The SubscriptionTypeStatus object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"SubscriptionTypeStatus":{"type":"integer","description":"","enum":[0,99]}}}}
```
## The BaseEntity object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"BaseEntity":{"type":"object","additionalProperties":false}}}}
```
## The AddSubscriptionTypeRequest object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"AddSubscriptionTypeRequest":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"frequence":{"$ref":"#/components/schemas/Frequence"},"subscriptionCost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"recurrence":{"type":"integer","format":"int32"},"taxPercentage":{"type":"number","format":"decimal","nullable":true}}},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]}}}}
```
## The UpdateSubscriptionTypeRequest object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"UpdateSubscriptionTypeRequest":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"subscriptionCost":{"type":"number","format":"decimal"},"taxPercentage":{"type":"string","nullable":true}}}}}}
```
## The SubscriptorResponse object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"SubscriptorResponse":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"fullName":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentResponse"}]},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionResponse"}},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionResponse"}},"firstSubscribed":{"type":"string","format":"date-time"}}},"InstrumentResponse":{"type":"object","additionalProperties":false,"properties":{"expiration":{"type":"string","format":"date-time"},"instrumentId":{"type":"string","nullable":true},"issuerImageUrl":{"type":"string","nullable":true},"issuerName":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"optionalUniqueID":{"type":"string","nullable":true}}},"SubscriptionResponse":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","nullable":true},"token":{"type":"string","nullable":true},"subscriptionDate":{"type":"string","format":"date-time","nullable":true},"subscriptionLastPaymentDate":{"type":"string","format":"date-time"},"subscriptionStatus":{"$ref":"#/components/schemas/SubscriptionStatus"},"validUntil":{"type":"string","format":"date-time"},"legalId":{"type":"string","nullable":true},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"backgroundJobId":{"type":"string","nullable":true}}},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"SubscriptionTypeDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"frequence":{"$ref":"#/components/schemas/Frequence"},"subscriptionBaseCost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"recurrence":{"type":"integer","format":"int32"},"regularType":{"type":"boolean"},"taxPercentage":{"type":"string","nullable":true}}},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"TransactionResponse":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"subscription":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionResponse"}]},"amount":{"type":"number","format":"decimal"},"createdAt":{"type":"string","format":"date-time"},"state":{"$ref":"#/components/schemas/TransactionStatus"},"currency":{"$ref":"#/components/schemas/Currency"},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentResponse"}]},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorResponse"}]}}},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]}}}}
```
## The SubscriptionResponse object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"SubscriptionResponse":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","nullable":true},"token":{"type":"string","nullable":true},"subscriptionDate":{"type":"string","format":"date-time","nullable":true},"subscriptionLastPaymentDate":{"type":"string","format":"date-time"},"subscriptionStatus":{"$ref":"#/components/schemas/SubscriptionStatus"},"validUntil":{"type":"string","format":"date-time"},"legalId":{"type":"string","nullable":true},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"backgroundJobId":{"type":"string","nullable":true}}},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"SubscriptionTypeDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"frequence":{"$ref":"#/components/schemas/Frequence"},"subscriptionBaseCost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"recurrence":{"type":"integer","format":"int32"},"regularType":{"type":"boolean"},"taxPercentage":{"type":"string","nullable":true}}},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]}}}}
```
## The TransactionResponse object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"TransactionResponse":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"subscription":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionResponse"}]},"amount":{"type":"number","format":"decimal"},"createdAt":{"type":"string","format":"date-time"},"state":{"$ref":"#/components/schemas/TransactionStatus"},"currency":{"$ref":"#/components/schemas/Currency"},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentResponse"}]},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorResponse"}]}}},"SubscriptionResponse":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","nullable":true},"token":{"type":"string","nullable":true},"subscriptionDate":{"type":"string","format":"date-time","nullable":true},"subscriptionLastPaymentDate":{"type":"string","format":"date-time"},"subscriptionStatus":{"$ref":"#/components/schemas/SubscriptionStatus"},"validUntil":{"type":"string","format":"date-time"},"legalId":{"type":"string","nullable":true},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"backgroundJobId":{"type":"string","nullable":true}}},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"SubscriptionTypeDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"frequence":{"$ref":"#/components/schemas/Frequence"},"subscriptionBaseCost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"recurrence":{"type":"integer","format":"int32"},"regularType":{"type":"boolean"},"taxPercentage":{"type":"string","nullable":true}}},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"InstrumentResponse":{"type":"object","additionalProperties":false,"properties":{"expiration":{"type":"string","format":"date-time"},"instrumentId":{"type":"string","nullable":true},"issuerImageUrl":{"type":"string","nullable":true},"issuerName":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"optionalUniqueID":{"type":"string","nullable":true}}},"SubscriptorResponse":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"fullName":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentResponse"}]},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionResponse"}},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionResponse"}},"firstSubscribed":{"type":"string","format":"date-time"}}}}}}
```
## The Subscriptor object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"Subscriptor":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["externalId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","maxLength":100,"minLength":0},"email":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"name":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"fullName":{"type":"string","maxLength":150,"minLength":0,"nullable":true},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"instruments":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Instrument"}},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscription"}},"links":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Link"}}}}]},"BaseEntity":{"type":"object","additionalProperties":false},"Client":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","legalName","legalId","clientSecret","plexoCommerceId","admin","taxPercentage"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"legalName":{"type":"string","maxLength":150,"minLength":1},"legalId":{"type":"string","maxLength":12,"minLength":1},"clientSecret":{"type":"string","maxLength":50,"minLength":1},"plexoCommerceId":{"type":"integer","format":"int32"},"recurringPaymentUrl":{"type":"string","maxLength":100,"nullable":true},"admin":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationUser"}},"taxPercentage":{"type":"number","format":"decimal","default":22},"subscriptionTypes":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionType"}},"clientIssuers":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ClientIssuer"}},"subscriptors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscriptor"}},"historicData":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/HistoricData"}},"retriesConfiguration":{"$ref":"#/components/schemas/RetriesConfigurationEnum"},"notificationPermissionsId":{"type":"integer","format":"int32"},"notificationPermissions":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NotificationPermissions"}]}}}]},"ApplicationUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUser"},{"type":"object","additionalProperties":false,"properties":{"userType":{"$ref":"#/components/schemas/UserType"},"clientID":{"type":"string","format":"guid"}}}]},"IdentityUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUserOfString"},{"type":"object","description":"The default implementation of IdentityUser`1 which uses a string as a primary key.","additionalProperties":false}]},"IdentityUserOfString":{"type":"object","description":"Represents a user in the identity system","additionalProperties":false,"properties":{"id":{"type":"string","description":"Gets or sets the primary key for this user.","nullable":true},"userName":{"type":"string","description":"Gets or sets the user name for this user.","nullable":true},"normalizedUserName":{"type":"string","description":"Gets or sets the normalized user name for this user.","nullable":true},"email":{"type":"string","description":"Gets or sets the email address for this user.","nullable":true},"normalizedEmail":{"type":"string","description":"Gets or sets the normalized email address for this user.","nullable":true},"emailConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their email address."},"passwordHash":{"type":"string","description":"Gets or sets a salted and hashed representation of the password for this user.","nullable":true},"securityStamp":{"type":"string","description":"A random value that must change whenever a users credentials change (password changed, login removed)","nullable":true},"concurrencyStamp":{"type":"string","description":"A random value that must change whenever a user is persisted to the store","nullable":true},"phoneNumber":{"type":"string","description":"Gets or sets a telephone number for the user.","nullable":true},"phoneNumberConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their telephone address."},"twoFactorEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if two factor authentication is enabled for this user."},"lockoutEnd":{"type":"string","description":"Gets or sets the date and time, in UTC, when any user lockout ends.","format":"date-time","nullable":true},"lockoutEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if the user could be locked out."},"accessFailedCount":{"type":"integer","description":"Gets or sets the number of failed login attempts for the current user.","format":"int32"}}},"UserType":{"type":"integer","description":"","enum":[0,1,2]},"SubscriptionType":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","description","frequence","cost","currency","status","recurrence"],"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","maxLength":50,"minLength":0},"description":{"type":"string","maxLength":120,"minLength":0},"frequence":{"$ref":"#/components/schemas/Frequence"},"cost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"status":{"$ref":"#/components/schemas/SubscriptionTypeStatus"},"recurrence":{"type":"integer","format":"int32","default":0},"taxPercentage":{"type":"number","format":"decimal","nullable":true}}}]},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"SubscriptionTypeStatus":{"type":"integer","description":"","enum":[0,99]},"ClientIssuer":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["issuerId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"issuerId":{"type":"integer","format":"int32"},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]}}}]},"Instrument":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["subscriptorId","instrumentToken","name","issuerName","issuerImageUrl","expiration","status"],"properties":{"id":{"type":"string","format":"guid"},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"instrumentToken":{"type":"string","format":"guid","minLength":1},"name":{"type":"string","maxLength":50,"minLength":1},"issuerName":{"type":"string","maxLength":50,"minLength":1},"issuerImageUrl":{"type":"string","maxLength":200,"minLength":1},"expiration":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/InstrumentStatus"},"uniqueID":{"type":"string","maxLength":200,"nullable":true},"plexoExtendedResponse":{"type":"string","nullable":true}}}]},"InstrumentStatus":{"type":"integer","description":"","enum":[0,99]},"Subscription":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["token","subscriptionTypeId","date","status","lastPaymentDate","validToDate","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"token":{"type":"string","minLength":1},"subscriptionTypeId":{"type":"integer","format":"int32"},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionType"}]},"date":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/SubscriptionStatus"},"lastPaymentDate":{"type":"string","format":"date","minLength":1},"validToDate":{"type":"string","format":"date","minLength":1},"backgroundJobId":{"type":"string","nullable":true},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"suspendedBy":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SuspendedByEnum"}]},"suspendedDate":{"type":"string","format":"date","nullable":true},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"remainingRecurrences":{"type":"integer","format":"int32","nullable":true}}}]},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"SuspendedByEnum":{"type":"integer","description":"","enum":[0,1]},"Transaction":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["currency","amount","taxedAmount","taxAmount","date","status","retryAttempt","type","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"currency":{"$ref":"#/components/schemas/Currency"},"amount":{"type":"number","format":"decimal"},"taxedAmount":{"type":"number","format":"decimal"},"taxAmount":{"type":"number","format":"decimal"},"date":{"type":"string","format":"date-time","minLength":1},"status":{"$ref":"#/components/schemas/TransactionStatus"},"authorization":{"type":"string","nullable":true},"plexoReferenceId":{"type":"string","nullable":true},"errorText":{"type":"string","nullable":true},"retryAttempt":{"type":"integer","format":"int32","default":1},"plexoClientReference":{"type":"string","nullable":true},"ticket":{"type":"string","nullable":true},"type":{"default":1,"oneOf":[{"$ref":"#/components/schemas/TransactionType"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItemId":{"type":"string","format":"guid","nullable":true},"transactionRequestItem":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestItem"}]},"subscriptionId":{"type":"string","format":"guid","nullable":true},"subscription":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscription"}]},"instrumentId":{"type":"string","format":"guid","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Instrument"}]},"electronicBillingId":{"type":"integer","format":"int32","nullable":true},"electronicBilling":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ElectronicBill"}]}}}]},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionType":{"type":"integer","description":"","enum":[1,2]},"TransactionRequestItem":{"type":"object","additionalProperties":false,"required":["amount","currency","paymentRequestItemStatus","transactionRequestFileId","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"amount":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"paymentRequestItemStatus":{"$ref":"#/components/schemas/PaymentRequestItemStatus"},"transactionRequestFileId":{"type":"string","format":"guid","minLength":1},"transactionRequestFile":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestFile"}]},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"jobId":{"type":"string","nullable":true}}},"PaymentRequestItemStatus":{"type":"integer","description":"","enum":[1,2,3]},"TransactionRequestFile":{"type":"object","additionalProperties":false,"required":["name","url","clientId"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"url":{"type":"string","maxLength":200,"minLength":1},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItems":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionRequestItem"}},"date":{"type":"string","format":"date-time"}}},"ElectronicBill":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["internalId","caeNumber","series","number"],"properties":{"id":{"type":"integer","format":"int32"},"internalId":{"type":"integer","format":"int32"},"caeNumber":{"type":"string","minLength":1},"series":{"type":"string","minLength":1},"number":{"type":"integer","format":"int32"}}}]},"Link":{"type":"object","additionalProperties":false,"required":["externalId","status","clientId","canUpdateSubscriptorData"],"properties":{"id":{"type":"string","format":"guid"},"externalId":{"type":"string","maxLength":150,"minLength":1},"firstName":{"type":"string","maxLength":50,"nullable":true},"lastName":{"type":"string","maxLength":50,"nullable":true},"email":{"type":"string","maxLength":150,"nullable":true},"status":{"default":1,"oneOf":[{"$ref":"#/components/schemas/LinkStatusEnum"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"subscriptorId":{"type":"integer","format":"int32","nullable":true},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"canUpdateSubscriptorData":{"type":"boolean","default":true},"subscriptionTypeId":{"type":"string","nullable":true}}},"LinkStatusEnum":{"type":"integer","description":"","enum":[1,2,3]},"HistoricData":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"date":{"type":"string","format":"date"},"totalSubscriptors":{"type":"integer","format":"int32"}}},"RetriesConfigurationEnum":{"type":"integer","description":"","enum":[0,1]},"NotificationPermissions":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["id"],"properties":{"id":{"type":"integer","format":"int32"},"transactionCancellation":{"type":"boolean"},"subscriptionCancellation":{"type":"boolean"},"subscriptorFields":{"type":"boolean"},"paymentSuccess":{"type":"boolean"},"paymentFailed":{"type":"boolean"},"subcriptioninactiveByPaymentFailure":{"type":"boolean"}}}]}}}}
```
## The Client object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"Client":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","legalName","legalId","clientSecret","plexoCommerceId","admin","taxPercentage"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"legalName":{"type":"string","maxLength":150,"minLength":1},"legalId":{"type":"string","maxLength":12,"minLength":1},"clientSecret":{"type":"string","maxLength":50,"minLength":1},"plexoCommerceId":{"type":"integer","format":"int32"},"recurringPaymentUrl":{"type":"string","maxLength":100,"nullable":true},"admin":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationUser"}},"taxPercentage":{"type":"number","format":"decimal","default":22},"subscriptionTypes":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionType"}},"clientIssuers":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ClientIssuer"}},"subscriptors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscriptor"}},"historicData":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/HistoricData"}},"retriesConfiguration":{"$ref":"#/components/schemas/RetriesConfigurationEnum"},"notificationPermissionsId":{"type":"integer","format":"int32"},"notificationPermissions":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NotificationPermissions"}]}}}]},"BaseEntity":{"type":"object","additionalProperties":false},"ApplicationUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUser"},{"type":"object","additionalProperties":false,"properties":{"userType":{"$ref":"#/components/schemas/UserType"},"clientID":{"type":"string","format":"guid"}}}]},"IdentityUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUserOfString"},{"type":"object","description":"The default implementation of IdentityUser`1 which uses a string as a primary key.","additionalProperties":false}]},"IdentityUserOfString":{"type":"object","description":"Represents a user in the identity system","additionalProperties":false,"properties":{"id":{"type":"string","description":"Gets or sets the primary key for this user.","nullable":true},"userName":{"type":"string","description":"Gets or sets the user name for this user.","nullable":true},"normalizedUserName":{"type":"string","description":"Gets or sets the normalized user name for this user.","nullable":true},"email":{"type":"string","description":"Gets or sets the email address for this user.","nullable":true},"normalizedEmail":{"type":"string","description":"Gets or sets the normalized email address for this user.","nullable":true},"emailConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their email address."},"passwordHash":{"type":"string","description":"Gets or sets a salted and hashed representation of the password for this user.","nullable":true},"securityStamp":{"type":"string","description":"A random value that must change whenever a users credentials change (password changed, login removed)","nullable":true},"concurrencyStamp":{"type":"string","description":"A random value that must change whenever a user is persisted to the store","nullable":true},"phoneNumber":{"type":"string","description":"Gets or sets a telephone number for the user.","nullable":true},"phoneNumberConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their telephone address."},"twoFactorEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if two factor authentication is enabled for this user."},"lockoutEnd":{"type":"string","description":"Gets or sets the date and time, in UTC, when any user lockout ends.","format":"date-time","nullable":true},"lockoutEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if the user could be locked out."},"accessFailedCount":{"type":"integer","description":"Gets or sets the number of failed login attempts for the current user.","format":"int32"}}},"UserType":{"type":"integer","description":"","enum":[0,1,2]},"SubscriptionType":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","description","frequence","cost","currency","status","recurrence"],"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","maxLength":50,"minLength":0},"description":{"type":"string","maxLength":120,"minLength":0},"frequence":{"$ref":"#/components/schemas/Frequence"},"cost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"status":{"$ref":"#/components/schemas/SubscriptionTypeStatus"},"recurrence":{"type":"integer","format":"int32","default":0},"taxPercentage":{"type":"number","format":"decimal","nullable":true}}}]},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"SubscriptionTypeStatus":{"type":"integer","description":"","enum":[0,99]},"ClientIssuer":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["issuerId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"issuerId":{"type":"integer","format":"int32"},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]}}}]},"Subscriptor":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["externalId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","maxLength":100,"minLength":0},"email":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"name":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"fullName":{"type":"string","maxLength":150,"minLength":0,"nullable":true},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"instruments":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Instrument"}},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscription"}},"links":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Link"}}}}]},"Instrument":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["subscriptorId","instrumentToken","name","issuerName","issuerImageUrl","expiration","status"],"properties":{"id":{"type":"string","format":"guid"},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"instrumentToken":{"type":"string","format":"guid","minLength":1},"name":{"type":"string","maxLength":50,"minLength":1},"issuerName":{"type":"string","maxLength":50,"minLength":1},"issuerImageUrl":{"type":"string","maxLength":200,"minLength":1},"expiration":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/InstrumentStatus"},"uniqueID":{"type":"string","maxLength":200,"nullable":true},"plexoExtendedResponse":{"type":"string","nullable":true}}}]},"InstrumentStatus":{"type":"integer","description":"","enum":[0,99]},"Subscription":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["token","subscriptionTypeId","date","status","lastPaymentDate","validToDate","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"token":{"type":"string","minLength":1},"subscriptionTypeId":{"type":"integer","format":"int32"},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionType"}]},"date":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/SubscriptionStatus"},"lastPaymentDate":{"type":"string","format":"date","minLength":1},"validToDate":{"type":"string","format":"date","minLength":1},"backgroundJobId":{"type":"string","nullable":true},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"suspendedBy":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SuspendedByEnum"}]},"suspendedDate":{"type":"string","format":"date","nullable":true},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"remainingRecurrences":{"type":"integer","format":"int32","nullable":true}}}]},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"SuspendedByEnum":{"type":"integer","description":"","enum":[0,1]},"Transaction":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["currency","amount","taxedAmount","taxAmount","date","status","retryAttempt","type","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"currency":{"$ref":"#/components/schemas/Currency"},"amount":{"type":"number","format":"decimal"},"taxedAmount":{"type":"number","format":"decimal"},"taxAmount":{"type":"number","format":"decimal"},"date":{"type":"string","format":"date-time","minLength":1},"status":{"$ref":"#/components/schemas/TransactionStatus"},"authorization":{"type":"string","nullable":true},"plexoReferenceId":{"type":"string","nullable":true},"errorText":{"type":"string","nullable":true},"retryAttempt":{"type":"integer","format":"int32","default":1},"plexoClientReference":{"type":"string","nullable":true},"ticket":{"type":"string","nullable":true},"type":{"default":1,"oneOf":[{"$ref":"#/components/schemas/TransactionType"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItemId":{"type":"string","format":"guid","nullable":true},"transactionRequestItem":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestItem"}]},"subscriptionId":{"type":"string","format":"guid","nullable":true},"subscription":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscription"}]},"instrumentId":{"type":"string","format":"guid","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Instrument"}]},"electronicBillingId":{"type":"integer","format":"int32","nullable":true},"electronicBilling":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ElectronicBill"}]}}}]},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionType":{"type":"integer","description":"","enum":[1,2]},"TransactionRequestItem":{"type":"object","additionalProperties":false,"required":["amount","currency","paymentRequestItemStatus","transactionRequestFileId","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"amount":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"paymentRequestItemStatus":{"$ref":"#/components/schemas/PaymentRequestItemStatus"},"transactionRequestFileId":{"type":"string","format":"guid","minLength":1},"transactionRequestFile":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestFile"}]},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"jobId":{"type":"string","nullable":true}}},"PaymentRequestItemStatus":{"type":"integer","description":"","enum":[1,2,3]},"TransactionRequestFile":{"type":"object","additionalProperties":false,"required":["name","url","clientId"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"url":{"type":"string","maxLength":200,"minLength":1},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItems":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionRequestItem"}},"date":{"type":"string","format":"date-time"}}},"ElectronicBill":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["internalId","caeNumber","series","number"],"properties":{"id":{"type":"integer","format":"int32"},"internalId":{"type":"integer","format":"int32"},"caeNumber":{"type":"string","minLength":1},"series":{"type":"string","minLength":1},"number":{"type":"integer","format":"int32"}}}]},"Link":{"type":"object","additionalProperties":false,"required":["externalId","status","clientId","canUpdateSubscriptorData"],"properties":{"id":{"type":"string","format":"guid"},"externalId":{"type":"string","maxLength":150,"minLength":1},"firstName":{"type":"string","maxLength":50,"nullable":true},"lastName":{"type":"string","maxLength":50,"nullable":true},"email":{"type":"string","maxLength":150,"nullable":true},"status":{"default":1,"oneOf":[{"$ref":"#/components/schemas/LinkStatusEnum"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"subscriptorId":{"type":"integer","format":"int32","nullable":true},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"canUpdateSubscriptorData":{"type":"boolean","default":true},"subscriptionTypeId":{"type":"string","nullable":true}}},"LinkStatusEnum":{"type":"integer","description":"","enum":[1,2,3]},"HistoricData":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"date":{"type":"string","format":"date"},"totalSubscriptors":{"type":"integer","format":"int32"}}},"RetriesConfigurationEnum":{"type":"integer","description":"","enum":[0,1]},"NotificationPermissions":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["id"],"properties":{"id":{"type":"integer","format":"int32"},"transactionCancellation":{"type":"boolean"},"subscriptionCancellation":{"type":"boolean"},"subscriptorFields":{"type":"boolean"},"paymentSuccess":{"type":"boolean"},"paymentFailed":{"type":"boolean"},"subcriptioninactiveByPaymentFailure":{"type":"boolean"}}}]}}}}
```
## The ApplicationUser object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"ApplicationUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUser"},{"type":"object","additionalProperties":false,"properties":{"userType":{"$ref":"#/components/schemas/UserType"},"clientID":{"type":"string","format":"guid"}}}]},"IdentityUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUserOfString"},{"type":"object","description":"The default implementation of IdentityUser`1 which uses a string as a primary key.","additionalProperties":false}]},"IdentityUserOfString":{"type":"object","description":"Represents a user in the identity system","additionalProperties":false,"properties":{"id":{"type":"string","description":"Gets or sets the primary key for this user.","nullable":true},"userName":{"type":"string","description":"Gets or sets the user name for this user.","nullable":true},"normalizedUserName":{"type":"string","description":"Gets or sets the normalized user name for this user.","nullable":true},"email":{"type":"string","description":"Gets or sets the email address for this user.","nullable":true},"normalizedEmail":{"type":"string","description":"Gets or sets the normalized email address for this user.","nullable":true},"emailConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their email address."},"passwordHash":{"type":"string","description":"Gets or sets a salted and hashed representation of the password for this user.","nullable":true},"securityStamp":{"type":"string","description":"A random value that must change whenever a users credentials change (password changed, login removed)","nullable":true},"concurrencyStamp":{"type":"string","description":"A random value that must change whenever a user is persisted to the store","nullable":true},"phoneNumber":{"type":"string","description":"Gets or sets a telephone number for the user.","nullable":true},"phoneNumberConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their telephone address."},"twoFactorEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if two factor authentication is enabled for this user."},"lockoutEnd":{"type":"string","description":"Gets or sets the date and time, in UTC, when any user lockout ends.","format":"date-time","nullable":true},"lockoutEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if the user could be locked out."},"accessFailedCount":{"type":"integer","description":"Gets or sets the number of failed login attempts for the current user.","format":"int32"}}},"UserType":{"type":"integer","description":"","enum":[0,1,2]}}}}
```
## The UserType object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"UserType":{"type":"integer","description":"","enum":[0,1,2]}}}}
```
## The IdentityUser object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"IdentityUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUserOfString"},{"type":"object","description":"The default implementation of IdentityUser`1 which uses a string as a primary key.","additionalProperties":false}]},"IdentityUserOfString":{"type":"object","description":"Represents a user in the identity system","additionalProperties":false,"properties":{"id":{"type":"string","description":"Gets or sets the primary key for this user.","nullable":true},"userName":{"type":"string","description":"Gets or sets the user name for this user.","nullable":true},"normalizedUserName":{"type":"string","description":"Gets or sets the normalized user name for this user.","nullable":true},"email":{"type":"string","description":"Gets or sets the email address for this user.","nullable":true},"normalizedEmail":{"type":"string","description":"Gets or sets the normalized email address for this user.","nullable":true},"emailConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their email address."},"passwordHash":{"type":"string","description":"Gets or sets a salted and hashed representation of the password for this user.","nullable":true},"securityStamp":{"type":"string","description":"A random value that must change whenever a users credentials change (password changed, login removed)","nullable":true},"concurrencyStamp":{"type":"string","description":"A random value that must change whenever a user is persisted to the store","nullable":true},"phoneNumber":{"type":"string","description":"Gets or sets a telephone number for the user.","nullable":true},"phoneNumberConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their telephone address."},"twoFactorEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if two factor authentication is enabled for this user."},"lockoutEnd":{"type":"string","description":"Gets or sets the date and time, in UTC, when any user lockout ends.","format":"date-time","nullable":true},"lockoutEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if the user could be locked out."},"accessFailedCount":{"type":"integer","description":"Gets or sets the number of failed login attempts for the current user.","format":"int32"}}}}}}
```
## The IdentityUserOfString object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"IdentityUserOfString":{"type":"object","description":"Represents a user in the identity system","additionalProperties":false,"properties":{"id":{"type":"string","description":"Gets or sets the primary key for this user.","nullable":true},"userName":{"type":"string","description":"Gets or sets the user name for this user.","nullable":true},"normalizedUserName":{"type":"string","description":"Gets or sets the normalized user name for this user.","nullable":true},"email":{"type":"string","description":"Gets or sets the email address for this user.","nullable":true},"normalizedEmail":{"type":"string","description":"Gets or sets the normalized email address for this user.","nullable":true},"emailConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their email address."},"passwordHash":{"type":"string","description":"Gets or sets a salted and hashed representation of the password for this user.","nullable":true},"securityStamp":{"type":"string","description":"A random value that must change whenever a users credentials change (password changed, login removed)","nullable":true},"concurrencyStamp":{"type":"string","description":"A random value that must change whenever a user is persisted to the store","nullable":true},"phoneNumber":{"type":"string","description":"Gets or sets a telephone number for the user.","nullable":true},"phoneNumberConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their telephone address."},"twoFactorEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if two factor authentication is enabled for this user."},"lockoutEnd":{"type":"string","description":"Gets or sets the date and time, in UTC, when any user lockout ends.","format":"date-time","nullable":true},"lockoutEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if the user could be locked out."},"accessFailedCount":{"type":"integer","description":"Gets or sets the number of failed login attempts for the current user.","format":"int32"}}}}}}
```
## The ClientIssuer object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"ClientIssuer":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["issuerId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"issuerId":{"type":"integer","format":"int32"},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]}}}]},"BaseEntity":{"type":"object","additionalProperties":false},"Client":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","legalName","legalId","clientSecret","plexoCommerceId","admin","taxPercentage"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"legalName":{"type":"string","maxLength":150,"minLength":1},"legalId":{"type":"string","maxLength":12,"minLength":1},"clientSecret":{"type":"string","maxLength":50,"minLength":1},"plexoCommerceId":{"type":"integer","format":"int32"},"recurringPaymentUrl":{"type":"string","maxLength":100,"nullable":true},"admin":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationUser"}},"taxPercentage":{"type":"number","format":"decimal","default":22},"subscriptionTypes":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionType"}},"clientIssuers":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ClientIssuer"}},"subscriptors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscriptor"}},"historicData":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/HistoricData"}},"retriesConfiguration":{"$ref":"#/components/schemas/RetriesConfigurationEnum"},"notificationPermissionsId":{"type":"integer","format":"int32"},"notificationPermissions":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NotificationPermissions"}]}}}]},"ApplicationUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUser"},{"type":"object","additionalProperties":false,"properties":{"userType":{"$ref":"#/components/schemas/UserType"},"clientID":{"type":"string","format":"guid"}}}]},"IdentityUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUserOfString"},{"type":"object","description":"The default implementation of IdentityUser`1 which uses a string as a primary key.","additionalProperties":false}]},"IdentityUserOfString":{"type":"object","description":"Represents a user in the identity system","additionalProperties":false,"properties":{"id":{"type":"string","description":"Gets or sets the primary key for this user.","nullable":true},"userName":{"type":"string","description":"Gets or sets the user name for this user.","nullable":true},"normalizedUserName":{"type":"string","description":"Gets or sets the normalized user name for this user.","nullable":true},"email":{"type":"string","description":"Gets or sets the email address for this user.","nullable":true},"normalizedEmail":{"type":"string","description":"Gets or sets the normalized email address for this user.","nullable":true},"emailConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their email address."},"passwordHash":{"type":"string","description":"Gets or sets a salted and hashed representation of the password for this user.","nullable":true},"securityStamp":{"type":"string","description":"A random value that must change whenever a users credentials change (password changed, login removed)","nullable":true},"concurrencyStamp":{"type":"string","description":"A random value that must change whenever a user is persisted to the store","nullable":true},"phoneNumber":{"type":"string","description":"Gets or sets a telephone number for the user.","nullable":true},"phoneNumberConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their telephone address."},"twoFactorEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if two factor authentication is enabled for this user."},"lockoutEnd":{"type":"string","description":"Gets or sets the date and time, in UTC, when any user lockout ends.","format":"date-time","nullable":true},"lockoutEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if the user could be locked out."},"accessFailedCount":{"type":"integer","description":"Gets or sets the number of failed login attempts for the current user.","format":"int32"}}},"UserType":{"type":"integer","description":"","enum":[0,1,2]},"SubscriptionType":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","description","frequence","cost","currency","status","recurrence"],"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","maxLength":50,"minLength":0},"description":{"type":"string","maxLength":120,"minLength":0},"frequence":{"$ref":"#/components/schemas/Frequence"},"cost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"status":{"$ref":"#/components/schemas/SubscriptionTypeStatus"},"recurrence":{"type":"integer","format":"int32","default":0},"taxPercentage":{"type":"number","format":"decimal","nullable":true}}}]},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"SubscriptionTypeStatus":{"type":"integer","description":"","enum":[0,99]},"Subscriptor":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["externalId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","maxLength":100,"minLength":0},"email":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"name":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"fullName":{"type":"string","maxLength":150,"minLength":0,"nullable":true},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"instruments":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Instrument"}},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscription"}},"links":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Link"}}}}]},"Instrument":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["subscriptorId","instrumentToken","name","issuerName","issuerImageUrl","expiration","status"],"properties":{"id":{"type":"string","format":"guid"},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"instrumentToken":{"type":"string","format":"guid","minLength":1},"name":{"type":"string","maxLength":50,"minLength":1},"issuerName":{"type":"string","maxLength":50,"minLength":1},"issuerImageUrl":{"type":"string","maxLength":200,"minLength":1},"expiration":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/InstrumentStatus"},"uniqueID":{"type":"string","maxLength":200,"nullable":true},"plexoExtendedResponse":{"type":"string","nullable":true}}}]},"InstrumentStatus":{"type":"integer","description":"","enum":[0,99]},"Subscription":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["token","subscriptionTypeId","date","status","lastPaymentDate","validToDate","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"token":{"type":"string","minLength":1},"subscriptionTypeId":{"type":"integer","format":"int32"},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionType"}]},"date":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/SubscriptionStatus"},"lastPaymentDate":{"type":"string","format":"date","minLength":1},"validToDate":{"type":"string","format":"date","minLength":1},"backgroundJobId":{"type":"string","nullable":true},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"suspendedBy":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SuspendedByEnum"}]},"suspendedDate":{"type":"string","format":"date","nullable":true},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"remainingRecurrences":{"type":"integer","format":"int32","nullable":true}}}]},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"SuspendedByEnum":{"type":"integer","description":"","enum":[0,1]},"Transaction":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["currency","amount","taxedAmount","taxAmount","date","status","retryAttempt","type","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"currency":{"$ref":"#/components/schemas/Currency"},"amount":{"type":"number","format":"decimal"},"taxedAmount":{"type":"number","format":"decimal"},"taxAmount":{"type":"number","format":"decimal"},"date":{"type":"string","format":"date-time","minLength":1},"status":{"$ref":"#/components/schemas/TransactionStatus"},"authorization":{"type":"string","nullable":true},"plexoReferenceId":{"type":"string","nullable":true},"errorText":{"type":"string","nullable":true},"retryAttempt":{"type":"integer","format":"int32","default":1},"plexoClientReference":{"type":"string","nullable":true},"ticket":{"type":"string","nullable":true},"type":{"default":1,"oneOf":[{"$ref":"#/components/schemas/TransactionType"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItemId":{"type":"string","format":"guid","nullable":true},"transactionRequestItem":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestItem"}]},"subscriptionId":{"type":"string","format":"guid","nullable":true},"subscription":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscription"}]},"instrumentId":{"type":"string","format":"guid","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Instrument"}]},"electronicBillingId":{"type":"integer","format":"int32","nullable":true},"electronicBilling":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ElectronicBill"}]}}}]},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionType":{"type":"integer","description":"","enum":[1,2]},"TransactionRequestItem":{"type":"object","additionalProperties":false,"required":["amount","currency","paymentRequestItemStatus","transactionRequestFileId","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"amount":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"paymentRequestItemStatus":{"$ref":"#/components/schemas/PaymentRequestItemStatus"},"transactionRequestFileId":{"type":"string","format":"guid","minLength":1},"transactionRequestFile":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestFile"}]},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"jobId":{"type":"string","nullable":true}}},"PaymentRequestItemStatus":{"type":"integer","description":"","enum":[1,2,3]},"TransactionRequestFile":{"type":"object","additionalProperties":false,"required":["name","url","clientId"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"url":{"type":"string","maxLength":200,"minLength":1},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItems":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionRequestItem"}},"date":{"type":"string","format":"date-time"}}},"ElectronicBill":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["internalId","caeNumber","series","number"],"properties":{"id":{"type":"integer","format":"int32"},"internalId":{"type":"integer","format":"int32"},"caeNumber":{"type":"string","minLength":1},"series":{"type":"string","minLength":1},"number":{"type":"integer","format":"int32"}}}]},"Link":{"type":"object","additionalProperties":false,"required":["externalId","status","clientId","canUpdateSubscriptorData"],"properties":{"id":{"type":"string","format":"guid"},"externalId":{"type":"string","maxLength":150,"minLength":1},"firstName":{"type":"string","maxLength":50,"nullable":true},"lastName":{"type":"string","maxLength":50,"nullable":true},"email":{"type":"string","maxLength":150,"nullable":true},"status":{"default":1,"oneOf":[{"$ref":"#/components/schemas/LinkStatusEnum"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"subscriptorId":{"type":"integer","format":"int32","nullable":true},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"canUpdateSubscriptorData":{"type":"boolean","default":true},"subscriptionTypeId":{"type":"string","nullable":true}}},"LinkStatusEnum":{"type":"integer","description":"","enum":[1,2,3]},"HistoricData":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"date":{"type":"string","format":"date"},"totalSubscriptors":{"type":"integer","format":"int32"}}},"RetriesConfigurationEnum":{"type":"integer","description":"","enum":[0,1]},"NotificationPermissions":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["id"],"properties":{"id":{"type":"integer","format":"int32"},"transactionCancellation":{"type":"boolean"},"subscriptionCancellation":{"type":"boolean"},"subscriptorFields":{"type":"boolean"},"paymentSuccess":{"type":"boolean"},"paymentFailed":{"type":"boolean"},"subcriptioninactiveByPaymentFailure":{"type":"boolean"}}}]}}}}
```
## The HistoricData object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"HistoricData":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"date":{"type":"string","format":"date"},"totalSubscriptors":{"type":"integer","format":"int32"}}}}}}
```
## The NotificationPermissions object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"NotificationPermissions":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["id"],"properties":{"id":{"type":"integer","format":"int32"},"transactionCancellation":{"type":"boolean"},"subscriptionCancellation":{"type":"boolean"},"subscriptorFields":{"type":"boolean"},"paymentSuccess":{"type":"boolean"},"paymentFailed":{"type":"boolean"},"subcriptioninactiveByPaymentFailure":{"type":"boolean"}}}]},"BaseEntity":{"type":"object","additionalProperties":false}}}}
```
## The Instrument object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"Instrument":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["subscriptorId","instrumentToken","name","issuerName","issuerImageUrl","expiration","status"],"properties":{"id":{"type":"string","format":"guid"},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"instrumentToken":{"type":"string","format":"guid","minLength":1},"name":{"type":"string","maxLength":50,"minLength":1},"issuerName":{"type":"string","maxLength":50,"minLength":1},"issuerImageUrl":{"type":"string","maxLength":200,"minLength":1},"expiration":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/InstrumentStatus"},"uniqueID":{"type":"string","maxLength":200,"nullable":true},"plexoExtendedResponse":{"type":"string","nullable":true}}}]},"BaseEntity":{"type":"object","additionalProperties":false},"Subscriptor":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["externalId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","maxLength":100,"minLength":0},"email":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"name":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"fullName":{"type":"string","maxLength":150,"minLength":0,"nullable":true},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"instruments":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Instrument"}},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscription"}},"links":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Link"}}}}]},"Client":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","legalName","legalId","clientSecret","plexoCommerceId","admin","taxPercentage"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"legalName":{"type":"string","maxLength":150,"minLength":1},"legalId":{"type":"string","maxLength":12,"minLength":1},"clientSecret":{"type":"string","maxLength":50,"minLength":1},"plexoCommerceId":{"type":"integer","format":"int32"},"recurringPaymentUrl":{"type":"string","maxLength":100,"nullable":true},"admin":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationUser"}},"taxPercentage":{"type":"number","format":"decimal","default":22},"subscriptionTypes":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionType"}},"clientIssuers":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ClientIssuer"}},"subscriptors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscriptor"}},"historicData":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/HistoricData"}},"retriesConfiguration":{"$ref":"#/components/schemas/RetriesConfigurationEnum"},"notificationPermissionsId":{"type":"integer","format":"int32"},"notificationPermissions":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NotificationPermissions"}]}}}]},"ApplicationUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUser"},{"type":"object","additionalProperties":false,"properties":{"userType":{"$ref":"#/components/schemas/UserType"},"clientID":{"type":"string","format":"guid"}}}]},"IdentityUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUserOfString"},{"type":"object","description":"The default implementation of IdentityUser`1 which uses a string as a primary key.","additionalProperties":false}]},"IdentityUserOfString":{"type":"object","description":"Represents a user in the identity system","additionalProperties":false,"properties":{"id":{"type":"string","description":"Gets or sets the primary key for this user.","nullable":true},"userName":{"type":"string","description":"Gets or sets the user name for this user.","nullable":true},"normalizedUserName":{"type":"string","description":"Gets or sets the normalized user name for this user.","nullable":true},"email":{"type":"string","description":"Gets or sets the email address for this user.","nullable":true},"normalizedEmail":{"type":"string","description":"Gets or sets the normalized email address for this user.","nullable":true},"emailConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their email address."},"passwordHash":{"type":"string","description":"Gets or sets a salted and hashed representation of the password for this user.","nullable":true},"securityStamp":{"type":"string","description":"A random value that must change whenever a users credentials change (password changed, login removed)","nullable":true},"concurrencyStamp":{"type":"string","description":"A random value that must change whenever a user is persisted to the store","nullable":true},"phoneNumber":{"type":"string","description":"Gets or sets a telephone number for the user.","nullable":true},"phoneNumberConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their telephone address."},"twoFactorEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if two factor authentication is enabled for this user."},"lockoutEnd":{"type":"string","description":"Gets or sets the date and time, in UTC, when any user lockout ends.","format":"date-time","nullable":true},"lockoutEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if the user could be locked out."},"accessFailedCount":{"type":"integer","description":"Gets or sets the number of failed login attempts for the current user.","format":"int32"}}},"UserType":{"type":"integer","description":"","enum":[0,1,2]},"SubscriptionType":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","description","frequence","cost","currency","status","recurrence"],"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","maxLength":50,"minLength":0},"description":{"type":"string","maxLength":120,"minLength":0},"frequence":{"$ref":"#/components/schemas/Frequence"},"cost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"status":{"$ref":"#/components/schemas/SubscriptionTypeStatus"},"recurrence":{"type":"integer","format":"int32","default":0},"taxPercentage":{"type":"number","format":"decimal","nullable":true}}}]},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"SubscriptionTypeStatus":{"type":"integer","description":"","enum":[0,99]},"ClientIssuer":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["issuerId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"issuerId":{"type":"integer","format":"int32"},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]}}}]},"HistoricData":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"date":{"type":"string","format":"date"},"totalSubscriptors":{"type":"integer","format":"int32"}}},"RetriesConfigurationEnum":{"type":"integer","description":"","enum":[0,1]},"NotificationPermissions":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["id"],"properties":{"id":{"type":"integer","format":"int32"},"transactionCancellation":{"type":"boolean"},"subscriptionCancellation":{"type":"boolean"},"subscriptorFields":{"type":"boolean"},"paymentSuccess":{"type":"boolean"},"paymentFailed":{"type":"boolean"},"subcriptioninactiveByPaymentFailure":{"type":"boolean"}}}]},"InstrumentStatus":{"type":"integer","description":"","enum":[0,99]},"Subscription":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["token","subscriptionTypeId","date","status","lastPaymentDate","validToDate","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"token":{"type":"string","minLength":1},"subscriptionTypeId":{"type":"integer","format":"int32"},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionType"}]},"date":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/SubscriptionStatus"},"lastPaymentDate":{"type":"string","format":"date","minLength":1},"validToDate":{"type":"string","format":"date","minLength":1},"backgroundJobId":{"type":"string","nullable":true},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"suspendedBy":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SuspendedByEnum"}]},"suspendedDate":{"type":"string","format":"date","nullable":true},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"remainingRecurrences":{"type":"integer","format":"int32","nullable":true}}}]},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"SuspendedByEnum":{"type":"integer","description":"","enum":[0,1]},"Transaction":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["currency","amount","taxedAmount","taxAmount","date","status","retryAttempt","type","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"currency":{"$ref":"#/components/schemas/Currency"},"amount":{"type":"number","format":"decimal"},"taxedAmount":{"type":"number","format":"decimal"},"taxAmount":{"type":"number","format":"decimal"},"date":{"type":"string","format":"date-time","minLength":1},"status":{"$ref":"#/components/schemas/TransactionStatus"},"authorization":{"type":"string","nullable":true},"plexoReferenceId":{"type":"string","nullable":true},"errorText":{"type":"string","nullable":true},"retryAttempt":{"type":"integer","format":"int32","default":1},"plexoClientReference":{"type":"string","nullable":true},"ticket":{"type":"string","nullable":true},"type":{"default":1,"oneOf":[{"$ref":"#/components/schemas/TransactionType"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItemId":{"type":"string","format":"guid","nullable":true},"transactionRequestItem":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestItem"}]},"subscriptionId":{"type":"string","format":"guid","nullable":true},"subscription":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscription"}]},"instrumentId":{"type":"string","format":"guid","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Instrument"}]},"electronicBillingId":{"type":"integer","format":"int32","nullable":true},"electronicBilling":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ElectronicBill"}]}}}]},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionType":{"type":"integer","description":"","enum":[1,2]},"TransactionRequestItem":{"type":"object","additionalProperties":false,"required":["amount","currency","paymentRequestItemStatus","transactionRequestFileId","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"amount":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"paymentRequestItemStatus":{"$ref":"#/components/schemas/PaymentRequestItemStatus"},"transactionRequestFileId":{"type":"string","format":"guid","minLength":1},"transactionRequestFile":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestFile"}]},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"jobId":{"type":"string","nullable":true}}},"PaymentRequestItemStatus":{"type":"integer","description":"","enum":[1,2,3]},"TransactionRequestFile":{"type":"object","additionalProperties":false,"required":["name","url","clientId"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"url":{"type":"string","maxLength":200,"minLength":1},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItems":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionRequestItem"}},"date":{"type":"string","format":"date-time"}}},"ElectronicBill":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["internalId","caeNumber","series","number"],"properties":{"id":{"type":"integer","format":"int32"},"internalId":{"type":"integer","format":"int32"},"caeNumber":{"type":"string","minLength":1},"series":{"type":"string","minLength":1},"number":{"type":"integer","format":"int32"}}}]},"Link":{"type":"object","additionalProperties":false,"required":["externalId","status","clientId","canUpdateSubscriptorData"],"properties":{"id":{"type":"string","format":"guid"},"externalId":{"type":"string","maxLength":150,"minLength":1},"firstName":{"type":"string","maxLength":50,"nullable":true},"lastName":{"type":"string","maxLength":50,"nullable":true},"email":{"type":"string","maxLength":150,"nullable":true},"status":{"default":1,"oneOf":[{"$ref":"#/components/schemas/LinkStatusEnum"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"subscriptorId":{"type":"integer","format":"int32","nullable":true},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"canUpdateSubscriptorData":{"type":"boolean","default":true},"subscriptionTypeId":{"type":"string","nullable":true}}},"LinkStatusEnum":{"type":"integer","description":"","enum":[1,2,3]}}}}
```
## The InstrumentStatus object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"InstrumentStatus":{"type":"integer","description":"","enum":[0,99]}}}}
```
## The Subscription object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"Subscription":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["token","subscriptionTypeId","date","status","lastPaymentDate","validToDate","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"token":{"type":"string","minLength":1},"subscriptionTypeId":{"type":"integer","format":"int32"},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionType"}]},"date":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/SubscriptionStatus"},"lastPaymentDate":{"type":"string","format":"date","minLength":1},"validToDate":{"type":"string","format":"date","minLength":1},"backgroundJobId":{"type":"string","nullable":true},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"suspendedBy":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SuspendedByEnum"}]},"suspendedDate":{"type":"string","format":"date","nullable":true},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"remainingRecurrences":{"type":"integer","format":"int32","nullable":true}}}]},"BaseEntity":{"type":"object","additionalProperties":false},"SubscriptionType":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","description","frequence","cost","currency","status","recurrence"],"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","maxLength":50,"minLength":0},"description":{"type":"string","maxLength":120,"minLength":0},"frequence":{"$ref":"#/components/schemas/Frequence"},"cost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"status":{"$ref":"#/components/schemas/SubscriptionTypeStatus"},"recurrence":{"type":"integer","format":"int32","default":0},"taxPercentage":{"type":"number","format":"decimal","nullable":true}}}]},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"SubscriptionTypeStatus":{"type":"integer","description":"","enum":[0,99]},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"Subscriptor":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["externalId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","maxLength":100,"minLength":0},"email":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"name":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"fullName":{"type":"string","maxLength":150,"minLength":0,"nullable":true},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"instruments":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Instrument"}},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscription"}},"links":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Link"}}}}]},"Client":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","legalName","legalId","clientSecret","plexoCommerceId","admin","taxPercentage"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"legalName":{"type":"string","maxLength":150,"minLength":1},"legalId":{"type":"string","maxLength":12,"minLength":1},"clientSecret":{"type":"string","maxLength":50,"minLength":1},"plexoCommerceId":{"type":"integer","format":"int32"},"recurringPaymentUrl":{"type":"string","maxLength":100,"nullable":true},"admin":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationUser"}},"taxPercentage":{"type":"number","format":"decimal","default":22},"subscriptionTypes":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionType"}},"clientIssuers":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ClientIssuer"}},"subscriptors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscriptor"}},"historicData":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/HistoricData"}},"retriesConfiguration":{"$ref":"#/components/schemas/RetriesConfigurationEnum"},"notificationPermissionsId":{"type":"integer","format":"int32"},"notificationPermissions":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NotificationPermissions"}]}}}]},"ApplicationUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUser"},{"type":"object","additionalProperties":false,"properties":{"userType":{"$ref":"#/components/schemas/UserType"},"clientID":{"type":"string","format":"guid"}}}]},"IdentityUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUserOfString"},{"type":"object","description":"The default implementation of IdentityUser`1 which uses a string as a primary key.","additionalProperties":false}]},"IdentityUserOfString":{"type":"object","description":"Represents a user in the identity system","additionalProperties":false,"properties":{"id":{"type":"string","description":"Gets or sets the primary key for this user.","nullable":true},"userName":{"type":"string","description":"Gets or sets the user name for this user.","nullable":true},"normalizedUserName":{"type":"string","description":"Gets or sets the normalized user name for this user.","nullable":true},"email":{"type":"string","description":"Gets or sets the email address for this user.","nullable":true},"normalizedEmail":{"type":"string","description":"Gets or sets the normalized email address for this user.","nullable":true},"emailConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their email address."},"passwordHash":{"type":"string","description":"Gets or sets a salted and hashed representation of the password for this user.","nullable":true},"securityStamp":{"type":"string","description":"A random value that must change whenever a users credentials change (password changed, login removed)","nullable":true},"concurrencyStamp":{"type":"string","description":"A random value that must change whenever a user is persisted to the store","nullable":true},"phoneNumber":{"type":"string","description":"Gets or sets a telephone number for the user.","nullable":true},"phoneNumberConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their telephone address."},"twoFactorEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if two factor authentication is enabled for this user."},"lockoutEnd":{"type":"string","description":"Gets or sets the date and time, in UTC, when any user lockout ends.","format":"date-time","nullable":true},"lockoutEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if the user could be locked out."},"accessFailedCount":{"type":"integer","description":"Gets or sets the number of failed login attempts for the current user.","format":"int32"}}},"UserType":{"type":"integer","description":"","enum":[0,1,2]},"ClientIssuer":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["issuerId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"issuerId":{"type":"integer","format":"int32"},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]}}}]},"HistoricData":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"date":{"type":"string","format":"date"},"totalSubscriptors":{"type":"integer","format":"int32"}}},"RetriesConfigurationEnum":{"type":"integer","description":"","enum":[0,1]},"NotificationPermissions":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["id"],"properties":{"id":{"type":"integer","format":"int32"},"transactionCancellation":{"type":"boolean"},"subscriptionCancellation":{"type":"boolean"},"subscriptorFields":{"type":"boolean"},"paymentSuccess":{"type":"boolean"},"paymentFailed":{"type":"boolean"},"subcriptioninactiveByPaymentFailure":{"type":"boolean"}}}]},"Instrument":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["subscriptorId","instrumentToken","name","issuerName","issuerImageUrl","expiration","status"],"properties":{"id":{"type":"string","format":"guid"},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"instrumentToken":{"type":"string","format":"guid","minLength":1},"name":{"type":"string","maxLength":50,"minLength":1},"issuerName":{"type":"string","maxLength":50,"minLength":1},"issuerImageUrl":{"type":"string","maxLength":200,"minLength":1},"expiration":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/InstrumentStatus"},"uniqueID":{"type":"string","maxLength":200,"nullable":true},"plexoExtendedResponse":{"type":"string","nullable":true}}}]},"InstrumentStatus":{"type":"integer","description":"","enum":[0,99]},"SuspendedByEnum":{"type":"integer","description":"","enum":[0,1]},"Transaction":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["currency","amount","taxedAmount","taxAmount","date","status","retryAttempt","type","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"currency":{"$ref":"#/components/schemas/Currency"},"amount":{"type":"number","format":"decimal"},"taxedAmount":{"type":"number","format":"decimal"},"taxAmount":{"type":"number","format":"decimal"},"date":{"type":"string","format":"date-time","minLength":1},"status":{"$ref":"#/components/schemas/TransactionStatus"},"authorization":{"type":"string","nullable":true},"plexoReferenceId":{"type":"string","nullable":true},"errorText":{"type":"string","nullable":true},"retryAttempt":{"type":"integer","format":"int32","default":1},"plexoClientReference":{"type":"string","nullable":true},"ticket":{"type":"string","nullable":true},"type":{"default":1,"oneOf":[{"$ref":"#/components/schemas/TransactionType"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItemId":{"type":"string","format":"guid","nullable":true},"transactionRequestItem":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestItem"}]},"subscriptionId":{"type":"string","format":"guid","nullable":true},"subscription":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscription"}]},"instrumentId":{"type":"string","format":"guid","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Instrument"}]},"electronicBillingId":{"type":"integer","format":"int32","nullable":true},"electronicBilling":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ElectronicBill"}]}}}]},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionType":{"type":"integer","description":"","enum":[1,2]},"TransactionRequestItem":{"type":"object","additionalProperties":false,"required":["amount","currency","paymentRequestItemStatus","transactionRequestFileId","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"amount":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"paymentRequestItemStatus":{"$ref":"#/components/schemas/PaymentRequestItemStatus"},"transactionRequestFileId":{"type":"string","format":"guid","minLength":1},"transactionRequestFile":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestFile"}]},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"jobId":{"type":"string","nullable":true}}},"PaymentRequestItemStatus":{"type":"integer","description":"","enum":[1,2,3]},"TransactionRequestFile":{"type":"object","additionalProperties":false,"required":["name","url","clientId"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"url":{"type":"string","maxLength":200,"minLength":1},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItems":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionRequestItem"}},"date":{"type":"string","format":"date-time"}}},"ElectronicBill":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["internalId","caeNumber","series","number"],"properties":{"id":{"type":"integer","format":"int32"},"internalId":{"type":"integer","format":"int32"},"caeNumber":{"type":"string","minLength":1},"series":{"type":"string","minLength":1},"number":{"type":"integer","format":"int32"}}}]},"Link":{"type":"object","additionalProperties":false,"required":["externalId","status","clientId","canUpdateSubscriptorData"],"properties":{"id":{"type":"string","format":"guid"},"externalId":{"type":"string","maxLength":150,"minLength":1},"firstName":{"type":"string","maxLength":50,"nullable":true},"lastName":{"type":"string","maxLength":50,"nullable":true},"email":{"type":"string","maxLength":150,"nullable":true},"status":{"default":1,"oneOf":[{"$ref":"#/components/schemas/LinkStatusEnum"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"subscriptorId":{"type":"integer","format":"int32","nullable":true},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"canUpdateSubscriptorData":{"type":"boolean","default":true},"subscriptionTypeId":{"type":"string","nullable":true}}},"LinkStatusEnum":{"type":"integer","description":"","enum":[1,2,3]}}}}
```
## The SuspendedByEnum object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"SuspendedByEnum":{"type":"integer","description":"","enum":[0,1]}}}}
```
## The Transaction object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"Transaction":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["currency","amount","taxedAmount","taxAmount","date","status","retryAttempt","type","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"currency":{"$ref":"#/components/schemas/Currency"},"amount":{"type":"number","format":"decimal"},"taxedAmount":{"type":"number","format":"decimal"},"taxAmount":{"type":"number","format":"decimal"},"date":{"type":"string","format":"date-time","minLength":1},"status":{"$ref":"#/components/schemas/TransactionStatus"},"authorization":{"type":"string","nullable":true},"plexoReferenceId":{"type":"string","nullable":true},"errorText":{"type":"string","nullable":true},"retryAttempt":{"type":"integer","format":"int32","default":1},"plexoClientReference":{"type":"string","nullable":true},"ticket":{"type":"string","nullable":true},"type":{"default":1,"oneOf":[{"$ref":"#/components/schemas/TransactionType"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItemId":{"type":"string","format":"guid","nullable":true},"transactionRequestItem":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestItem"}]},"subscriptionId":{"type":"string","format":"guid","nullable":true},"subscription":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscription"}]},"instrumentId":{"type":"string","format":"guid","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Instrument"}]},"electronicBillingId":{"type":"integer","format":"int32","nullable":true},"electronicBilling":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ElectronicBill"}]}}}]},"BaseEntity":{"type":"object","additionalProperties":false},"Currency":{"type":"integer","description":"","enum":[1,2]},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionType":{"type":"integer","description":"","enum":[1,2]},"Client":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","legalName","legalId","clientSecret","plexoCommerceId","admin","taxPercentage"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"legalName":{"type":"string","maxLength":150,"minLength":1},"legalId":{"type":"string","maxLength":12,"minLength":1},"clientSecret":{"type":"string","maxLength":50,"minLength":1},"plexoCommerceId":{"type":"integer","format":"int32"},"recurringPaymentUrl":{"type":"string","maxLength":100,"nullable":true},"admin":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationUser"}},"taxPercentage":{"type":"number","format":"decimal","default":22},"subscriptionTypes":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionType"}},"clientIssuers":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ClientIssuer"}},"subscriptors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscriptor"}},"historicData":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/HistoricData"}},"retriesConfiguration":{"$ref":"#/components/schemas/RetriesConfigurationEnum"},"notificationPermissionsId":{"type":"integer","format":"int32"},"notificationPermissions":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NotificationPermissions"}]}}}]},"ApplicationUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUser"},{"type":"object","additionalProperties":false,"properties":{"userType":{"$ref":"#/components/schemas/UserType"},"clientID":{"type":"string","format":"guid"}}}]},"IdentityUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUserOfString"},{"type":"object","description":"The default implementation of IdentityUser`1 which uses a string as a primary key.","additionalProperties":false}]},"IdentityUserOfString":{"type":"object","description":"Represents a user in the identity system","additionalProperties":false,"properties":{"id":{"type":"string","description":"Gets or sets the primary key for this user.","nullable":true},"userName":{"type":"string","description":"Gets or sets the user name for this user.","nullable":true},"normalizedUserName":{"type":"string","description":"Gets or sets the normalized user name for this user.","nullable":true},"email":{"type":"string","description":"Gets or sets the email address for this user.","nullable":true},"normalizedEmail":{"type":"string","description":"Gets or sets the normalized email address for this user.","nullable":true},"emailConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their email address."},"passwordHash":{"type":"string","description":"Gets or sets a salted and hashed representation of the password for this user.","nullable":true},"securityStamp":{"type":"string","description":"A random value that must change whenever a users credentials change (password changed, login removed)","nullable":true},"concurrencyStamp":{"type":"string","description":"A random value that must change whenever a user is persisted to the store","nullable":true},"phoneNumber":{"type":"string","description":"Gets or sets a telephone number for the user.","nullable":true},"phoneNumberConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their telephone address."},"twoFactorEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if two factor authentication is enabled for this user."},"lockoutEnd":{"type":"string","description":"Gets or sets the date and time, in UTC, when any user lockout ends.","format":"date-time","nullable":true},"lockoutEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if the user could be locked out."},"accessFailedCount":{"type":"integer","description":"Gets or sets the number of failed login attempts for the current user.","format":"int32"}}},"UserType":{"type":"integer","description":"","enum":[0,1,2]},"SubscriptionType":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","description","frequence","cost","currency","status","recurrence"],"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","maxLength":50,"minLength":0},"description":{"type":"string","maxLength":120,"minLength":0},"frequence":{"$ref":"#/components/schemas/Frequence"},"cost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"status":{"$ref":"#/components/schemas/SubscriptionTypeStatus"},"recurrence":{"type":"integer","format":"int32","default":0},"taxPercentage":{"type":"number","format":"decimal","nullable":true}}}]},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"SubscriptionTypeStatus":{"type":"integer","description":"","enum":[0,99]},"ClientIssuer":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["issuerId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"issuerId":{"type":"integer","format":"int32"},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]}}}]},"Subscriptor":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["externalId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","maxLength":100,"minLength":0},"email":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"name":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"fullName":{"type":"string","maxLength":150,"minLength":0,"nullable":true},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"instruments":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Instrument"}},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscription"}},"links":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Link"}}}}]},"Instrument":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["subscriptorId","instrumentToken","name","issuerName","issuerImageUrl","expiration","status"],"properties":{"id":{"type":"string","format":"guid"},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"instrumentToken":{"type":"string","format":"guid","minLength":1},"name":{"type":"string","maxLength":50,"minLength":1},"issuerName":{"type":"string","maxLength":50,"minLength":1},"issuerImageUrl":{"type":"string","maxLength":200,"minLength":1},"expiration":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/InstrumentStatus"},"uniqueID":{"type":"string","maxLength":200,"nullable":true},"plexoExtendedResponse":{"type":"string","nullable":true}}}]},"InstrumentStatus":{"type":"integer","description":"","enum":[0,99]},"Subscription":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["token","subscriptionTypeId","date","status","lastPaymentDate","validToDate","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"token":{"type":"string","minLength":1},"subscriptionTypeId":{"type":"integer","format":"int32"},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionType"}]},"date":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/SubscriptionStatus"},"lastPaymentDate":{"type":"string","format":"date","minLength":1},"validToDate":{"type":"string","format":"date","minLength":1},"backgroundJobId":{"type":"string","nullable":true},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"suspendedBy":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SuspendedByEnum"}]},"suspendedDate":{"type":"string","format":"date","nullable":true},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"remainingRecurrences":{"type":"integer","format":"int32","nullable":true}}}]},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"SuspendedByEnum":{"type":"integer","description":"","enum":[0,1]},"TransactionRequestItem":{"type":"object","additionalProperties":false,"required":["amount","currency","paymentRequestItemStatus","transactionRequestFileId","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"amount":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"paymentRequestItemStatus":{"$ref":"#/components/schemas/PaymentRequestItemStatus"},"transactionRequestFileId":{"type":"string","format":"guid","minLength":1},"transactionRequestFile":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestFile"}]},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"jobId":{"type":"string","nullable":true}}},"PaymentRequestItemStatus":{"type":"integer","description":"","enum":[1,2,3]},"TransactionRequestFile":{"type":"object","additionalProperties":false,"required":["name","url","clientId"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"url":{"type":"string","maxLength":200,"minLength":1},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItems":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionRequestItem"}},"date":{"type":"string","format":"date-time"}}},"ElectronicBill":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["internalId","caeNumber","series","number"],"properties":{"id":{"type":"integer","format":"int32"},"internalId":{"type":"integer","format":"int32"},"caeNumber":{"type":"string","minLength":1},"series":{"type":"string","minLength":1},"number":{"type":"integer","format":"int32"}}}]},"Link":{"type":"object","additionalProperties":false,"required":["externalId","status","clientId","canUpdateSubscriptorData"],"properties":{"id":{"type":"string","format":"guid"},"externalId":{"type":"string","maxLength":150,"minLength":1},"firstName":{"type":"string","maxLength":50,"nullable":true},"lastName":{"type":"string","maxLength":50,"nullable":true},"email":{"type":"string","maxLength":150,"nullable":true},"status":{"default":1,"oneOf":[{"$ref":"#/components/schemas/LinkStatusEnum"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"subscriptorId":{"type":"integer","format":"int32","nullable":true},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"canUpdateSubscriptorData":{"type":"boolean","default":true},"subscriptionTypeId":{"type":"string","nullable":true}}},"LinkStatusEnum":{"type":"integer","description":"","enum":[1,2,3]},"HistoricData":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"date":{"type":"string","format":"date"},"totalSubscriptors":{"type":"integer","format":"int32"}}},"RetriesConfigurationEnum":{"type":"integer","description":"","enum":[0,1]},"NotificationPermissions":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["id"],"properties":{"id":{"type":"integer","format":"int32"},"transactionCancellation":{"type":"boolean"},"subscriptionCancellation":{"type":"boolean"},"subscriptorFields":{"type":"boolean"},"paymentSuccess":{"type":"boolean"},"paymentFailed":{"type":"boolean"},"subcriptioninactiveByPaymentFailure":{"type":"boolean"}}}]}}}}
```
## The TransactionType object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"TransactionType":{"type":"integer","description":"","enum":[1,2]}}}}
```
## The TransactionRequestItem object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"TransactionRequestItem":{"type":"object","additionalProperties":false,"required":["amount","currency","paymentRequestItemStatus","transactionRequestFileId","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"amount":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"paymentRequestItemStatus":{"$ref":"#/components/schemas/PaymentRequestItemStatus"},"transactionRequestFileId":{"type":"string","format":"guid","minLength":1},"transactionRequestFile":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestFile"}]},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"jobId":{"type":"string","nullable":true}}},"Currency":{"type":"integer","description":"","enum":[1,2]},"PaymentRequestItemStatus":{"type":"integer","description":"","enum":[1,2,3]},"TransactionRequestFile":{"type":"object","additionalProperties":false,"required":["name","url","clientId"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"url":{"type":"string","maxLength":200,"minLength":1},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItems":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionRequestItem"}},"date":{"type":"string","format":"date-time"}}},"Client":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","legalName","legalId","clientSecret","plexoCommerceId","admin","taxPercentage"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"legalName":{"type":"string","maxLength":150,"minLength":1},"legalId":{"type":"string","maxLength":12,"minLength":1},"clientSecret":{"type":"string","maxLength":50,"minLength":1},"plexoCommerceId":{"type":"integer","format":"int32"},"recurringPaymentUrl":{"type":"string","maxLength":100,"nullable":true},"admin":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationUser"}},"taxPercentage":{"type":"number","format":"decimal","default":22},"subscriptionTypes":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionType"}},"clientIssuers":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ClientIssuer"}},"subscriptors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscriptor"}},"historicData":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/HistoricData"}},"retriesConfiguration":{"$ref":"#/components/schemas/RetriesConfigurationEnum"},"notificationPermissionsId":{"type":"integer","format":"int32"},"notificationPermissions":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NotificationPermissions"}]}}}]},"BaseEntity":{"type":"object","additionalProperties":false},"ApplicationUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUser"},{"type":"object","additionalProperties":false,"properties":{"userType":{"$ref":"#/components/schemas/UserType"},"clientID":{"type":"string","format":"guid"}}}]},"IdentityUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUserOfString"},{"type":"object","description":"The default implementation of IdentityUser`1 which uses a string as a primary key.","additionalProperties":false}]},"IdentityUserOfString":{"type":"object","description":"Represents a user in the identity system","additionalProperties":false,"properties":{"id":{"type":"string","description":"Gets or sets the primary key for this user.","nullable":true},"userName":{"type":"string","description":"Gets or sets the user name for this user.","nullable":true},"normalizedUserName":{"type":"string","description":"Gets or sets the normalized user name for this user.","nullable":true},"email":{"type":"string","description":"Gets or sets the email address for this user.","nullable":true},"normalizedEmail":{"type":"string","description":"Gets or sets the normalized email address for this user.","nullable":true},"emailConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their email address."},"passwordHash":{"type":"string","description":"Gets or sets a salted and hashed representation of the password for this user.","nullable":true},"securityStamp":{"type":"string","description":"A random value that must change whenever a users credentials change (password changed, login removed)","nullable":true},"concurrencyStamp":{"type":"string","description":"A random value that must change whenever a user is persisted to the store","nullable":true},"phoneNumber":{"type":"string","description":"Gets or sets a telephone number for the user.","nullable":true},"phoneNumberConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their telephone address."},"twoFactorEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if two factor authentication is enabled for this user."},"lockoutEnd":{"type":"string","description":"Gets or sets the date and time, in UTC, when any user lockout ends.","format":"date-time","nullable":true},"lockoutEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if the user could be locked out."},"accessFailedCount":{"type":"integer","description":"Gets or sets the number of failed login attempts for the current user.","format":"int32"}}},"UserType":{"type":"integer","description":"","enum":[0,1,2]},"SubscriptionType":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","description","frequence","cost","currency","status","recurrence"],"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","maxLength":50,"minLength":0},"description":{"type":"string","maxLength":120,"minLength":0},"frequence":{"$ref":"#/components/schemas/Frequence"},"cost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"status":{"$ref":"#/components/schemas/SubscriptionTypeStatus"},"recurrence":{"type":"integer","format":"int32","default":0},"taxPercentage":{"type":"number","format":"decimal","nullable":true}}}]},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"SubscriptionTypeStatus":{"type":"integer","description":"","enum":[0,99]},"ClientIssuer":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["issuerId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"issuerId":{"type":"integer","format":"int32"},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]}}}]},"Subscriptor":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["externalId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","maxLength":100,"minLength":0},"email":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"name":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"fullName":{"type":"string","maxLength":150,"minLength":0,"nullable":true},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"instruments":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Instrument"}},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscription"}},"links":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Link"}}}}]},"Instrument":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["subscriptorId","instrumentToken","name","issuerName","issuerImageUrl","expiration","status"],"properties":{"id":{"type":"string","format":"guid"},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"instrumentToken":{"type":"string","format":"guid","minLength":1},"name":{"type":"string","maxLength":50,"minLength":1},"issuerName":{"type":"string","maxLength":50,"minLength":1},"issuerImageUrl":{"type":"string","maxLength":200,"minLength":1},"expiration":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/InstrumentStatus"},"uniqueID":{"type":"string","maxLength":200,"nullable":true},"plexoExtendedResponse":{"type":"string","nullable":true}}}]},"InstrumentStatus":{"type":"integer","description":"","enum":[0,99]},"Subscription":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["token","subscriptionTypeId","date","status","lastPaymentDate","validToDate","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"token":{"type":"string","minLength":1},"subscriptionTypeId":{"type":"integer","format":"int32"},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionType"}]},"date":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/SubscriptionStatus"},"lastPaymentDate":{"type":"string","format":"date","minLength":1},"validToDate":{"type":"string","format":"date","minLength":1},"backgroundJobId":{"type":"string","nullable":true},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"suspendedBy":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SuspendedByEnum"}]},"suspendedDate":{"type":"string","format":"date","nullable":true},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"remainingRecurrences":{"type":"integer","format":"int32","nullable":true}}}]},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"SuspendedByEnum":{"type":"integer","description":"","enum":[0,1]},"Transaction":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["currency","amount","taxedAmount","taxAmount","date","status","retryAttempt","type","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"currency":{"$ref":"#/components/schemas/Currency"},"amount":{"type":"number","format":"decimal"},"taxedAmount":{"type":"number","format":"decimal"},"taxAmount":{"type":"number","format":"decimal"},"date":{"type":"string","format":"date-time","minLength":1},"status":{"$ref":"#/components/schemas/TransactionStatus"},"authorization":{"type":"string","nullable":true},"plexoReferenceId":{"type":"string","nullable":true},"errorText":{"type":"string","nullable":true},"retryAttempt":{"type":"integer","format":"int32","default":1},"plexoClientReference":{"type":"string","nullable":true},"ticket":{"type":"string","nullable":true},"type":{"default":1,"oneOf":[{"$ref":"#/components/schemas/TransactionType"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItemId":{"type":"string","format":"guid","nullable":true},"transactionRequestItem":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestItem"}]},"subscriptionId":{"type":"string","format":"guid","nullable":true},"subscription":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscription"}]},"instrumentId":{"type":"string","format":"guid","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Instrument"}]},"electronicBillingId":{"type":"integer","format":"int32","nullable":true},"electronicBilling":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ElectronicBill"}]}}}]},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionType":{"type":"integer","description":"","enum":[1,2]},"ElectronicBill":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["internalId","caeNumber","series","number"],"properties":{"id":{"type":"integer","format":"int32"},"internalId":{"type":"integer","format":"int32"},"caeNumber":{"type":"string","minLength":1},"series":{"type":"string","minLength":1},"number":{"type":"integer","format":"int32"}}}]},"Link":{"type":"object","additionalProperties":false,"required":["externalId","status","clientId","canUpdateSubscriptorData"],"properties":{"id":{"type":"string","format":"guid"},"externalId":{"type":"string","maxLength":150,"minLength":1},"firstName":{"type":"string","maxLength":50,"nullable":true},"lastName":{"type":"string","maxLength":50,"nullable":true},"email":{"type":"string","maxLength":150,"nullable":true},"status":{"default":1,"oneOf":[{"$ref":"#/components/schemas/LinkStatusEnum"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"subscriptorId":{"type":"integer","format":"int32","nullable":true},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"canUpdateSubscriptorData":{"type":"boolean","default":true},"subscriptionTypeId":{"type":"string","nullable":true}}},"LinkStatusEnum":{"type":"integer","description":"","enum":[1,2,3]},"HistoricData":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"date":{"type":"string","format":"date"},"totalSubscriptors":{"type":"integer","format":"int32"}}},"RetriesConfigurationEnum":{"type":"integer","description":"","enum":[0,1]},"NotificationPermissions":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["id"],"properties":{"id":{"type":"integer","format":"int32"},"transactionCancellation":{"type":"boolean"},"subscriptionCancellation":{"type":"boolean"},"subscriptorFields":{"type":"boolean"},"paymentSuccess":{"type":"boolean"},"paymentFailed":{"type":"boolean"},"subcriptioninactiveByPaymentFailure":{"type":"boolean"}}}]}}}}
```
## The TransactionRequestFile object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"TransactionRequestFile":{"type":"object","additionalProperties":false,"required":["name","url","clientId"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"url":{"type":"string","maxLength":200,"minLength":1},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItems":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionRequestItem"}},"date":{"type":"string","format":"date-time"}}},"Client":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","legalName","legalId","clientSecret","plexoCommerceId","admin","taxPercentage"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"legalName":{"type":"string","maxLength":150,"minLength":1},"legalId":{"type":"string","maxLength":12,"minLength":1},"clientSecret":{"type":"string","maxLength":50,"minLength":1},"plexoCommerceId":{"type":"integer","format":"int32"},"recurringPaymentUrl":{"type":"string","maxLength":100,"nullable":true},"admin":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationUser"}},"taxPercentage":{"type":"number","format":"decimal","default":22},"subscriptionTypes":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionType"}},"clientIssuers":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ClientIssuer"}},"subscriptors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscriptor"}},"historicData":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/HistoricData"}},"retriesConfiguration":{"$ref":"#/components/schemas/RetriesConfigurationEnum"},"notificationPermissionsId":{"type":"integer","format":"int32"},"notificationPermissions":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NotificationPermissions"}]}}}]},"BaseEntity":{"type":"object","additionalProperties":false},"ApplicationUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUser"},{"type":"object","additionalProperties":false,"properties":{"userType":{"$ref":"#/components/schemas/UserType"},"clientID":{"type":"string","format":"guid"}}}]},"IdentityUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUserOfString"},{"type":"object","description":"The default implementation of IdentityUser`1 which uses a string as a primary key.","additionalProperties":false}]},"IdentityUserOfString":{"type":"object","description":"Represents a user in the identity system","additionalProperties":false,"properties":{"id":{"type":"string","description":"Gets or sets the primary key for this user.","nullable":true},"userName":{"type":"string","description":"Gets or sets the user name for this user.","nullable":true},"normalizedUserName":{"type":"string","description":"Gets or sets the normalized user name for this user.","nullable":true},"email":{"type":"string","description":"Gets or sets the email address for this user.","nullable":true},"normalizedEmail":{"type":"string","description":"Gets or sets the normalized email address for this user.","nullable":true},"emailConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their email address."},"passwordHash":{"type":"string","description":"Gets or sets a salted and hashed representation of the password for this user.","nullable":true},"securityStamp":{"type":"string","description":"A random value that must change whenever a users credentials change (password changed, login removed)","nullable":true},"concurrencyStamp":{"type":"string","description":"A random value that must change whenever a user is persisted to the store","nullable":true},"phoneNumber":{"type":"string","description":"Gets or sets a telephone number for the user.","nullable":true},"phoneNumberConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their telephone address."},"twoFactorEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if two factor authentication is enabled for this user."},"lockoutEnd":{"type":"string","description":"Gets or sets the date and time, in UTC, when any user lockout ends.","format":"date-time","nullable":true},"lockoutEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if the user could be locked out."},"accessFailedCount":{"type":"integer","description":"Gets or sets the number of failed login attempts for the current user.","format":"int32"}}},"UserType":{"type":"integer","description":"","enum":[0,1,2]},"SubscriptionType":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","description","frequence","cost","currency","status","recurrence"],"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","maxLength":50,"minLength":0},"description":{"type":"string","maxLength":120,"minLength":0},"frequence":{"$ref":"#/components/schemas/Frequence"},"cost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"status":{"$ref":"#/components/schemas/SubscriptionTypeStatus"},"recurrence":{"type":"integer","format":"int32","default":0},"taxPercentage":{"type":"number","format":"decimal","nullable":true}}}]},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"SubscriptionTypeStatus":{"type":"integer","description":"","enum":[0,99]},"ClientIssuer":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["issuerId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"issuerId":{"type":"integer","format":"int32"},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]}}}]},"Subscriptor":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["externalId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","maxLength":100,"minLength":0},"email":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"name":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"fullName":{"type":"string","maxLength":150,"minLength":0,"nullable":true},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"instruments":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Instrument"}},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscription"}},"links":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Link"}}}}]},"Instrument":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["subscriptorId","instrumentToken","name","issuerName","issuerImageUrl","expiration","status"],"properties":{"id":{"type":"string","format":"guid"},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"instrumentToken":{"type":"string","format":"guid","minLength":1},"name":{"type":"string","maxLength":50,"minLength":1},"issuerName":{"type":"string","maxLength":50,"minLength":1},"issuerImageUrl":{"type":"string","maxLength":200,"minLength":1},"expiration":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/InstrumentStatus"},"uniqueID":{"type":"string","maxLength":200,"nullable":true},"plexoExtendedResponse":{"type":"string","nullable":true}}}]},"InstrumentStatus":{"type":"integer","description":"","enum":[0,99]},"Subscription":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["token","subscriptionTypeId","date","status","lastPaymentDate","validToDate","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"token":{"type":"string","minLength":1},"subscriptionTypeId":{"type":"integer","format":"int32"},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionType"}]},"date":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/SubscriptionStatus"},"lastPaymentDate":{"type":"string","format":"date","minLength":1},"validToDate":{"type":"string","format":"date","minLength":1},"backgroundJobId":{"type":"string","nullable":true},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"suspendedBy":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SuspendedByEnum"}]},"suspendedDate":{"type":"string","format":"date","nullable":true},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"remainingRecurrences":{"type":"integer","format":"int32","nullable":true}}}]},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"SuspendedByEnum":{"type":"integer","description":"","enum":[0,1]},"Transaction":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["currency","amount","taxedAmount","taxAmount","date","status","retryAttempt","type","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"currency":{"$ref":"#/components/schemas/Currency"},"amount":{"type":"number","format":"decimal"},"taxedAmount":{"type":"number","format":"decimal"},"taxAmount":{"type":"number","format":"decimal"},"date":{"type":"string","format":"date-time","minLength":1},"status":{"$ref":"#/components/schemas/TransactionStatus"},"authorization":{"type":"string","nullable":true},"plexoReferenceId":{"type":"string","nullable":true},"errorText":{"type":"string","nullable":true},"retryAttempt":{"type":"integer","format":"int32","default":1},"plexoClientReference":{"type":"string","nullable":true},"ticket":{"type":"string","nullable":true},"type":{"default":1,"oneOf":[{"$ref":"#/components/schemas/TransactionType"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItemId":{"type":"string","format":"guid","nullable":true},"transactionRequestItem":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestItem"}]},"subscriptionId":{"type":"string","format":"guid","nullable":true},"subscription":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscription"}]},"instrumentId":{"type":"string","format":"guid","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Instrument"}]},"electronicBillingId":{"type":"integer","format":"int32","nullable":true},"electronicBilling":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ElectronicBill"}]}}}]},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionType":{"type":"integer","description":"","enum":[1,2]},"TransactionRequestItem":{"type":"object","additionalProperties":false,"required":["amount","currency","paymentRequestItemStatus","transactionRequestFileId","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"amount":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"paymentRequestItemStatus":{"$ref":"#/components/schemas/PaymentRequestItemStatus"},"transactionRequestFileId":{"type":"string","format":"guid","minLength":1},"transactionRequestFile":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestFile"}]},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"jobId":{"type":"string","nullable":true}}},"PaymentRequestItemStatus":{"type":"integer","description":"","enum":[1,2,3]},"ElectronicBill":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["internalId","caeNumber","series","number"],"properties":{"id":{"type":"integer","format":"int32"},"internalId":{"type":"integer","format":"int32"},"caeNumber":{"type":"string","minLength":1},"series":{"type":"string","minLength":1},"number":{"type":"integer","format":"int32"}}}]},"Link":{"type":"object","additionalProperties":false,"required":["externalId","status","clientId","canUpdateSubscriptorData"],"properties":{"id":{"type":"string","format":"guid"},"externalId":{"type":"string","maxLength":150,"minLength":1},"firstName":{"type":"string","maxLength":50,"nullable":true},"lastName":{"type":"string","maxLength":50,"nullable":true},"email":{"type":"string","maxLength":150,"nullable":true},"status":{"default":1,"oneOf":[{"$ref":"#/components/schemas/LinkStatusEnum"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"subscriptorId":{"type":"integer","format":"int32","nullable":true},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"canUpdateSubscriptorData":{"type":"boolean","default":true},"subscriptionTypeId":{"type":"string","nullable":true}}},"LinkStatusEnum":{"type":"integer","description":"","enum":[1,2,3]},"HistoricData":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"date":{"type":"string","format":"date"},"totalSubscriptors":{"type":"integer","format":"int32"}}},"RetriesConfigurationEnum":{"type":"integer","description":"","enum":[0,1]},"NotificationPermissions":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["id"],"properties":{"id":{"type":"integer","format":"int32"},"transactionCancellation":{"type":"boolean"},"subscriptionCancellation":{"type":"boolean"},"subscriptorFields":{"type":"boolean"},"paymentSuccess":{"type":"boolean"},"paymentFailed":{"type":"boolean"},"subcriptioninactiveByPaymentFailure":{"type":"boolean"}}}]}}}}
```
## The ElectronicBill object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"ElectronicBill":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["internalId","caeNumber","series","number"],"properties":{"id":{"type":"integer","format":"int32"},"internalId":{"type":"integer","format":"int32"},"caeNumber":{"type":"string","minLength":1},"series":{"type":"string","minLength":1},"number":{"type":"integer","format":"int32"}}}]},"BaseEntity":{"type":"object","additionalProperties":false}}}}
```
## The Link object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"Link":{"type":"object","additionalProperties":false,"required":["externalId","status","clientId","canUpdateSubscriptorData"],"properties":{"id":{"type":"string","format":"guid"},"externalId":{"type":"string","maxLength":150,"minLength":1},"firstName":{"type":"string","maxLength":50,"nullable":true},"lastName":{"type":"string","maxLength":50,"nullable":true},"email":{"type":"string","maxLength":150,"nullable":true},"status":{"default":1,"oneOf":[{"$ref":"#/components/schemas/LinkStatusEnum"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"subscriptorId":{"type":"integer","format":"int32","nullable":true},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"canUpdateSubscriptorData":{"type":"boolean","default":true},"subscriptionTypeId":{"type":"string","nullable":true}}},"LinkStatusEnum":{"type":"integer","description":"","enum":[1,2,3]},"Client":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","legalName","legalId","clientSecret","plexoCommerceId","admin","taxPercentage"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"legalName":{"type":"string","maxLength":150,"minLength":1},"legalId":{"type":"string","maxLength":12,"minLength":1},"clientSecret":{"type":"string","maxLength":50,"minLength":1},"plexoCommerceId":{"type":"integer","format":"int32"},"recurringPaymentUrl":{"type":"string","maxLength":100,"nullable":true},"admin":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationUser"}},"taxPercentage":{"type":"number","format":"decimal","default":22},"subscriptionTypes":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionType"}},"clientIssuers":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ClientIssuer"}},"subscriptors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscriptor"}},"historicData":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/HistoricData"}},"retriesConfiguration":{"$ref":"#/components/schemas/RetriesConfigurationEnum"},"notificationPermissionsId":{"type":"integer","format":"int32"},"notificationPermissions":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NotificationPermissions"}]}}}]},"BaseEntity":{"type":"object","additionalProperties":false},"ApplicationUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUser"},{"type":"object","additionalProperties":false,"properties":{"userType":{"$ref":"#/components/schemas/UserType"},"clientID":{"type":"string","format":"guid"}}}]},"IdentityUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUserOfString"},{"type":"object","description":"The default implementation of IdentityUser`1 which uses a string as a primary key.","additionalProperties":false}]},"IdentityUserOfString":{"type":"object","description":"Represents a user in the identity system","additionalProperties":false,"properties":{"id":{"type":"string","description":"Gets or sets the primary key for this user.","nullable":true},"userName":{"type":"string","description":"Gets or sets the user name for this user.","nullable":true},"normalizedUserName":{"type":"string","description":"Gets or sets the normalized user name for this user.","nullable":true},"email":{"type":"string","description":"Gets or sets the email address for this user.","nullable":true},"normalizedEmail":{"type":"string","description":"Gets or sets the normalized email address for this user.","nullable":true},"emailConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their email address."},"passwordHash":{"type":"string","description":"Gets or sets a salted and hashed representation of the password for this user.","nullable":true},"securityStamp":{"type":"string","description":"A random value that must change whenever a users credentials change (password changed, login removed)","nullable":true},"concurrencyStamp":{"type":"string","description":"A random value that must change whenever a user is persisted to the store","nullable":true},"phoneNumber":{"type":"string","description":"Gets or sets a telephone number for the user.","nullable":true},"phoneNumberConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their telephone address."},"twoFactorEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if two factor authentication is enabled for this user."},"lockoutEnd":{"type":"string","description":"Gets or sets the date and time, in UTC, when any user lockout ends.","format":"date-time","nullable":true},"lockoutEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if the user could be locked out."},"accessFailedCount":{"type":"integer","description":"Gets or sets the number of failed login attempts for the current user.","format":"int32"}}},"UserType":{"type":"integer","description":"","enum":[0,1,2]},"SubscriptionType":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","description","frequence","cost","currency","status","recurrence"],"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","maxLength":50,"minLength":0},"description":{"type":"string","maxLength":120,"minLength":0},"frequence":{"$ref":"#/components/schemas/Frequence"},"cost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"status":{"$ref":"#/components/schemas/SubscriptionTypeStatus"},"recurrence":{"type":"integer","format":"int32","default":0},"taxPercentage":{"type":"number","format":"decimal","nullable":true}}}]},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"SubscriptionTypeStatus":{"type":"integer","description":"","enum":[0,99]},"ClientIssuer":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["issuerId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"issuerId":{"type":"integer","format":"int32"},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]}}}]},"Subscriptor":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["externalId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","maxLength":100,"minLength":0},"email":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"name":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"fullName":{"type":"string","maxLength":150,"minLength":0,"nullable":true},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"instruments":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Instrument"}},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscription"}},"links":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Link"}}}}]},"Instrument":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["subscriptorId","instrumentToken","name","issuerName","issuerImageUrl","expiration","status"],"properties":{"id":{"type":"string","format":"guid"},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"instrumentToken":{"type":"string","format":"guid","minLength":1},"name":{"type":"string","maxLength":50,"minLength":1},"issuerName":{"type":"string","maxLength":50,"minLength":1},"issuerImageUrl":{"type":"string","maxLength":200,"minLength":1},"expiration":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/InstrumentStatus"},"uniqueID":{"type":"string","maxLength":200,"nullable":true},"plexoExtendedResponse":{"type":"string","nullable":true}}}]},"InstrumentStatus":{"type":"integer","description":"","enum":[0,99]},"Subscription":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["token","subscriptionTypeId","date","status","lastPaymentDate","validToDate","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"token":{"type":"string","minLength":1},"subscriptionTypeId":{"type":"integer","format":"int32"},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionType"}]},"date":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/SubscriptionStatus"},"lastPaymentDate":{"type":"string","format":"date","minLength":1},"validToDate":{"type":"string","format":"date","minLength":1},"backgroundJobId":{"type":"string","nullable":true},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"suspendedBy":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SuspendedByEnum"}]},"suspendedDate":{"type":"string","format":"date","nullable":true},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"remainingRecurrences":{"type":"integer","format":"int32","nullable":true}}}]},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"SuspendedByEnum":{"type":"integer","description":"","enum":[0,1]},"Transaction":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["currency","amount","taxedAmount","taxAmount","date","status","retryAttempt","type","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"currency":{"$ref":"#/components/schemas/Currency"},"amount":{"type":"number","format":"decimal"},"taxedAmount":{"type":"number","format":"decimal"},"taxAmount":{"type":"number","format":"decimal"},"date":{"type":"string","format":"date-time","minLength":1},"status":{"$ref":"#/components/schemas/TransactionStatus"},"authorization":{"type":"string","nullable":true},"plexoReferenceId":{"type":"string","nullable":true},"errorText":{"type":"string","nullable":true},"retryAttempt":{"type":"integer","format":"int32","default":1},"plexoClientReference":{"type":"string","nullable":true},"ticket":{"type":"string","nullable":true},"type":{"default":1,"oneOf":[{"$ref":"#/components/schemas/TransactionType"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItemId":{"type":"string","format":"guid","nullable":true},"transactionRequestItem":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestItem"}]},"subscriptionId":{"type":"string","format":"guid","nullable":true},"subscription":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscription"}]},"instrumentId":{"type":"string","format":"guid","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Instrument"}]},"electronicBillingId":{"type":"integer","format":"int32","nullable":true},"electronicBilling":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ElectronicBill"}]}}}]},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionType":{"type":"integer","description":"","enum":[1,2]},"TransactionRequestItem":{"type":"object","additionalProperties":false,"required":["amount","currency","paymentRequestItemStatus","transactionRequestFileId","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"amount":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"paymentRequestItemStatus":{"$ref":"#/components/schemas/PaymentRequestItemStatus"},"transactionRequestFileId":{"type":"string","format":"guid","minLength":1},"transactionRequestFile":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestFile"}]},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"jobId":{"type":"string","nullable":true}}},"PaymentRequestItemStatus":{"type":"integer","description":"","enum":[1,2,3]},"TransactionRequestFile":{"type":"object","additionalProperties":false,"required":["name","url","clientId"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"url":{"type":"string","maxLength":200,"minLength":1},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItems":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionRequestItem"}},"date":{"type":"string","format":"date-time"}}},"ElectronicBill":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["internalId","caeNumber","series","number"],"properties":{"id":{"type":"integer","format":"int32"},"internalId":{"type":"integer","format":"int32"},"caeNumber":{"type":"string","minLength":1},"series":{"type":"string","minLength":1},"number":{"type":"integer","format":"int32"}}}]},"HistoricData":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"date":{"type":"string","format":"date"},"totalSubscriptors":{"type":"integer","format":"int32"}}},"RetriesConfigurationEnum":{"type":"integer","description":"","enum":[0,1]},"NotificationPermissions":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["id"],"properties":{"id":{"type":"integer","format":"int32"},"transactionCancellation":{"type":"boolean"},"subscriptionCancellation":{"type":"boolean"},"subscriptorFields":{"type":"boolean"},"paymentSuccess":{"type":"boolean"},"paymentFailed":{"type":"boolean"},"subcriptioninactiveByPaymentFailure":{"type":"boolean"}}}]}}}}
```
## The AddSubscriptorRequest object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"AddSubscriptorRequest":{"type":"object","additionalProperties":false,"properties":{"externalId":{"type":"string","description":"El externalId es el Id del suscriptor dentro del sistema del cliente.","maxLength":100,"nullable":true},"email":{"type":"string","format":"email","maxLength":50,"nullable":true},"name":{"type":"string","maxLength":50,"nullable":true},"fullName":{"type":"string","maxLength":150,"nullable":true},"linkId":{"type":"string","format":"guid","nullable":true}}}}}}
```
## The AddSubscriptorLinkRequest object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"AddSubscriptorLinkRequest":{"type":"object","additionalProperties":false,"properties":{"externalId":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"fullName":{"type":"string","nullable":true},"linkId":{"type":"string","format":"guid"}}}}}}
```
## The UpdateSubscriptorRequest object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"UpdateSubscriptorRequest":{"type":"object","additionalProperties":false,"properties":{"email":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"fullName":{"type":"string","nullable":true}}}}}}
```
## The PagedResultOfSubscriptor object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"PagedResultOfSubscriptor":{"allOf":[{"$ref":"#/components/schemas/PagedResultBase"},{"type":"object","additionalProperties":false,"properties":{"results":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscriptor"}}}}]},"PagedResultBase":{"type":"object","additionalProperties":false,"properties":{"currentPage":{"type":"integer","format":"int32"},"pageCount":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"rowCount":{"type":"integer","format":"int32"},"totalPeso":{"type":"number","format":"decimal"},"totalDollar":{"type":"number","format":"decimal"},"totalPesoFailed":{"type":"number","format":"decimal"},"totalDollarFailed":{"type":"number","format":"decimal"},"firstRowOnPage":{"type":"integer","format":"int32"},"lastRowOnPage":{"type":"integer","format":"int32"}}},"Subscriptor":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["externalId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","maxLength":100,"minLength":0},"email":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"name":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"fullName":{"type":"string","maxLength":150,"minLength":0,"nullable":true},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"instruments":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Instrument"}},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscription"}},"links":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Link"}}}}]},"BaseEntity":{"type":"object","additionalProperties":false},"Client":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","legalName","legalId","clientSecret","plexoCommerceId","admin","taxPercentage"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"legalName":{"type":"string","maxLength":150,"minLength":1},"legalId":{"type":"string","maxLength":12,"minLength":1},"clientSecret":{"type":"string","maxLength":50,"minLength":1},"plexoCommerceId":{"type":"integer","format":"int32"},"recurringPaymentUrl":{"type":"string","maxLength":100,"nullable":true},"admin":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationUser"}},"taxPercentage":{"type":"number","format":"decimal","default":22},"subscriptionTypes":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionType"}},"clientIssuers":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ClientIssuer"}},"subscriptors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscriptor"}},"historicData":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/HistoricData"}},"retriesConfiguration":{"$ref":"#/components/schemas/RetriesConfigurationEnum"},"notificationPermissionsId":{"type":"integer","format":"int32"},"notificationPermissions":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NotificationPermissions"}]}}}]},"ApplicationUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUser"},{"type":"object","additionalProperties":false,"properties":{"userType":{"$ref":"#/components/schemas/UserType"},"clientID":{"type":"string","format":"guid"}}}]},"IdentityUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUserOfString"},{"type":"object","description":"The default implementation of IdentityUser`1 which uses a string as a primary key.","additionalProperties":false}]},"IdentityUserOfString":{"type":"object","description":"Represents a user in the identity system","additionalProperties":false,"properties":{"id":{"type":"string","description":"Gets or sets the primary key for this user.","nullable":true},"userName":{"type":"string","description":"Gets or sets the user name for this user.","nullable":true},"normalizedUserName":{"type":"string","description":"Gets or sets the normalized user name for this user.","nullable":true},"email":{"type":"string","description":"Gets or sets the email address for this user.","nullable":true},"normalizedEmail":{"type":"string","description":"Gets or sets the normalized email address for this user.","nullable":true},"emailConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their email address."},"passwordHash":{"type":"string","description":"Gets or sets a salted and hashed representation of the password for this user.","nullable":true},"securityStamp":{"type":"string","description":"A random value that must change whenever a users credentials change (password changed, login removed)","nullable":true},"concurrencyStamp":{"type":"string","description":"A random value that must change whenever a user is persisted to the store","nullable":true},"phoneNumber":{"type":"string","description":"Gets or sets a telephone number for the user.","nullable":true},"phoneNumberConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their telephone address."},"twoFactorEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if two factor authentication is enabled for this user."},"lockoutEnd":{"type":"string","description":"Gets or sets the date and time, in UTC, when any user lockout ends.","format":"date-time","nullable":true},"lockoutEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if the user could be locked out."},"accessFailedCount":{"type":"integer","description":"Gets or sets the number of failed login attempts for the current user.","format":"int32"}}},"UserType":{"type":"integer","description":"","enum":[0,1,2]},"SubscriptionType":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","description","frequence","cost","currency","status","recurrence"],"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","maxLength":50,"minLength":0},"description":{"type":"string","maxLength":120,"minLength":0},"frequence":{"$ref":"#/components/schemas/Frequence"},"cost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"status":{"$ref":"#/components/schemas/SubscriptionTypeStatus"},"recurrence":{"type":"integer","format":"int32","default":0},"taxPercentage":{"type":"number","format":"decimal","nullable":true}}}]},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"SubscriptionTypeStatus":{"type":"integer","description":"","enum":[0,99]},"ClientIssuer":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["issuerId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"issuerId":{"type":"integer","format":"int32"},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]}}}]},"HistoricData":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"date":{"type":"string","format":"date"},"totalSubscriptors":{"type":"integer","format":"int32"}}},"RetriesConfigurationEnum":{"type":"integer","description":"","enum":[0,1]},"NotificationPermissions":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["id"],"properties":{"id":{"type":"integer","format":"int32"},"transactionCancellation":{"type":"boolean"},"subscriptionCancellation":{"type":"boolean"},"subscriptorFields":{"type":"boolean"},"paymentSuccess":{"type":"boolean"},"paymentFailed":{"type":"boolean"},"subcriptioninactiveByPaymentFailure":{"type":"boolean"}}}]},"Instrument":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["subscriptorId","instrumentToken","name","issuerName","issuerImageUrl","expiration","status"],"properties":{"id":{"type":"string","format":"guid"},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"instrumentToken":{"type":"string","format":"guid","minLength":1},"name":{"type":"string","maxLength":50,"minLength":1},"issuerName":{"type":"string","maxLength":50,"minLength":1},"issuerImageUrl":{"type":"string","maxLength":200,"minLength":1},"expiration":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/InstrumentStatus"},"uniqueID":{"type":"string","maxLength":200,"nullable":true},"plexoExtendedResponse":{"type":"string","nullable":true}}}]},"InstrumentStatus":{"type":"integer","description":"","enum":[0,99]},"Subscription":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["token","subscriptionTypeId","date","status","lastPaymentDate","validToDate","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"token":{"type":"string","minLength":1},"subscriptionTypeId":{"type":"integer","format":"int32"},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionType"}]},"date":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/SubscriptionStatus"},"lastPaymentDate":{"type":"string","format":"date","minLength":1},"validToDate":{"type":"string","format":"date","minLength":1},"backgroundJobId":{"type":"string","nullable":true},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"suspendedBy":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SuspendedByEnum"}]},"suspendedDate":{"type":"string","format":"date","nullable":true},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"remainingRecurrences":{"type":"integer","format":"int32","nullable":true}}}]},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"SuspendedByEnum":{"type":"integer","description":"","enum":[0,1]},"Transaction":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["currency","amount","taxedAmount","taxAmount","date","status","retryAttempt","type","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"currency":{"$ref":"#/components/schemas/Currency"},"amount":{"type":"number","format":"decimal"},"taxedAmount":{"type":"number","format":"decimal"},"taxAmount":{"type":"number","format":"decimal"},"date":{"type":"string","format":"date-time","minLength":1},"status":{"$ref":"#/components/schemas/TransactionStatus"},"authorization":{"type":"string","nullable":true},"plexoReferenceId":{"type":"string","nullable":true},"errorText":{"type":"string","nullable":true},"retryAttempt":{"type":"integer","format":"int32","default":1},"plexoClientReference":{"type":"string","nullable":true},"ticket":{"type":"string","nullable":true},"type":{"default":1,"oneOf":[{"$ref":"#/components/schemas/TransactionType"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItemId":{"type":"string","format":"guid","nullable":true},"transactionRequestItem":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestItem"}]},"subscriptionId":{"type":"string","format":"guid","nullable":true},"subscription":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscription"}]},"instrumentId":{"type":"string","format":"guid","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Instrument"}]},"electronicBillingId":{"type":"integer","format":"int32","nullable":true},"electronicBilling":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ElectronicBill"}]}}}]},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionType":{"type":"integer","description":"","enum":[1,2]},"TransactionRequestItem":{"type":"object","additionalProperties":false,"required":["amount","currency","paymentRequestItemStatus","transactionRequestFileId","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"amount":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"paymentRequestItemStatus":{"$ref":"#/components/schemas/PaymentRequestItemStatus"},"transactionRequestFileId":{"type":"string","format":"guid","minLength":1},"transactionRequestFile":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestFile"}]},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"jobId":{"type":"string","nullable":true}}},"PaymentRequestItemStatus":{"type":"integer","description":"","enum":[1,2,3]},"TransactionRequestFile":{"type":"object","additionalProperties":false,"required":["name","url","clientId"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"url":{"type":"string","maxLength":200,"minLength":1},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItems":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionRequestItem"}},"date":{"type":"string","format":"date-time"}}},"ElectronicBill":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["internalId","caeNumber","series","number"],"properties":{"id":{"type":"integer","format":"int32"},"internalId":{"type":"integer","format":"int32"},"caeNumber":{"type":"string","minLength":1},"series":{"type":"string","minLength":1},"number":{"type":"integer","format":"int32"}}}]},"Link":{"type":"object","additionalProperties":false,"required":["externalId","status","clientId","canUpdateSubscriptorData"],"properties":{"id":{"type":"string","format":"guid"},"externalId":{"type":"string","maxLength":150,"minLength":1},"firstName":{"type":"string","maxLength":50,"nullable":true},"lastName":{"type":"string","maxLength":50,"nullable":true},"email":{"type":"string","maxLength":150,"nullable":true},"status":{"default":1,"oneOf":[{"$ref":"#/components/schemas/LinkStatusEnum"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"subscriptorId":{"type":"integer","format":"int32","nullable":true},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"canUpdateSubscriptorData":{"type":"boolean","default":true},"subscriptionTypeId":{"type":"string","nullable":true}}},"LinkStatusEnum":{"type":"integer","description":"","enum":[1,2,3]}}}}
```
## The PagedResultBase object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"PagedResultBase":{"type":"object","additionalProperties":false,"properties":{"currentPage":{"type":"integer","format":"int32"},"pageCount":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"rowCount":{"type":"integer","format":"int32"},"totalPeso":{"type":"number","format":"decimal"},"totalDollar":{"type":"number","format":"decimal"},"totalPesoFailed":{"type":"number","format":"decimal"},"totalDollarFailed":{"type":"number","format":"decimal"},"firstRowOnPage":{"type":"integer","format":"int32"},"lastRowOnPage":{"type":"integer","format":"int32"}}}}}}
```
## The SubscriptorsQueryState object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"SubscriptorsQueryState":{"type":"integer","description":"","enum":[0,1,2]}}}}
```
## The SubscriptionStateResponse object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"SubscriptionStateResponse":{"type":"object","additionalProperties":false,"properties":{"valid":{"type":"boolean"},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeResponse"}]},"activeUntil":{"type":"string","format":"date-time","nullable":true},"subscriptionStatus":{"$ref":"#/components/schemas/SubscriptionStatus"}}},"SubscriptionTypeResponse":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"frequence":{"$ref":"#/components/schemas/Frequence"},"currency":{"$ref":"#/components/schemas/Currency"},"subscriptionBaseCost":{"type":"number","format":"decimal"},"recurrence":{"type":"integer","format":"int32"}}},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]}}}}
```
## The SubscriptionTypeResponse object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"SubscriptionTypeResponse":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"frequence":{"$ref":"#/components/schemas/Frequence"},"currency":{"$ref":"#/components/schemas/Currency"},"subscriptionBaseCost":{"type":"number","format":"decimal"},"recurrence":{"type":"integer","format":"int32"}}},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]}}}}
```
## The SubscribeRequest object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"SubscribeRequest":{"type":"object","additionalProperties":false,"properties":{"clientId":{"type":"string","format":"guid"},"externalId":{"type":"string","nullable":true},"subscriptionTypeId":{"type":"integer","format":"int32"},"subscriptionCreationStrategy":{"$ref":"#/components/schemas/SubscriptionCreationStrategy"},"requireSuccessfulTransaction":{"type":"boolean"},"dayOfRenewal":{"type":"integer","format":"int32","nullable":true}}},"SubscriptionCreationStrategy":{"type":"integer","description":"","enum":[0,1,2]}}}}
```
## The SubscriptionCreationStrategy object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"SubscriptionCreationStrategy":{"type":"integer","description":"","enum":[0,1,2]}}}}
```
## The CancelSubscriptionRequest object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"CancelSubscriptionRequest":{"type":"object","additionalProperties":false,"properties":{"clientId":{"type":"string","format":"guid"},"externalId":{"type":"string","nullable":true},"subscriptionToken":{"type":"string","nullable":true},"cancelLastPayment":{"type":"boolean"},"loggedRole":{"$ref":"#/components/schemas/SuspendedByEnum"}}},"SuspendedByEnum":{"type":"integer","description":"","enum":[0,1]}}}}
```
## The PagedResultApiOfGetTransactionResponse object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"PagedResultApiOfGetTransactionResponse":{"allOf":[{"$ref":"#/components/schemas/PagedResultBaseApi"},{"type":"object","additionalProperties":false,"properties":{"results":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/GetTransactionResponse"}}}}]},"PagedResultBaseApi":{"type":"object","additionalProperties":false,"properties":{"currentPage":{"type":"integer","format":"int32"},"pageCount":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"rowCount":{"type":"integer","format":"int32"},"totals":{"type":"number","format":"decimal"},"totalsDollar":{"type":"number","format":"decimal"},"linkTemplate":{"type":"string","nullable":true},"firstRowOnPage":{"type":"integer","format":"int32"},"lastRowOnPage":{"type":"integer","format":"int32"}}},"GetTransactionResponse":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"subscription":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionResponse"}]},"amount":{"type":"number","format":"decimal"},"createdAt":{"type":"string","format":"date-time"},"createdUTC":{"type":"string","format":"date-time"},"currency":{"$ref":"#/components/schemas/Currency"},"state":{"$ref":"#/components/schemas/TransactionStatus"},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentResponse"}]},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorResponse"}]}}},"SubscriptionResponse":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","nullable":true},"token":{"type":"string","nullable":true},"subscriptionDate":{"type":"string","format":"date-time","nullable":true},"subscriptionLastPaymentDate":{"type":"string","format":"date-time"},"subscriptionStatus":{"$ref":"#/components/schemas/SubscriptionStatus"},"validUntil":{"type":"string","format":"date-time"},"legalId":{"type":"string","nullable":true},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"backgroundJobId":{"type":"string","nullable":true}}},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"SubscriptionTypeDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"frequence":{"$ref":"#/components/schemas/Frequence"},"subscriptionBaseCost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"recurrence":{"type":"integer","format":"int32"},"regularType":{"type":"boolean"},"taxPercentage":{"type":"string","nullable":true}}},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"InstrumentResponse":{"type":"object","additionalProperties":false,"properties":{"expiration":{"type":"string","format":"date-time"},"instrumentId":{"type":"string","nullable":true},"issuerImageUrl":{"type":"string","nullable":true},"issuerName":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"optionalUniqueID":{"type":"string","nullable":true}}},"SubscriptorResponse":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"fullName":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentResponse"}]},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionResponse"}},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionResponse"}},"firstSubscribed":{"type":"string","format":"date-time"}}},"TransactionResponse":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"subscription":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionResponse"}]},"amount":{"type":"number","format":"decimal"},"createdAt":{"type":"string","format":"date-time"},"state":{"$ref":"#/components/schemas/TransactionStatus"},"currency":{"$ref":"#/components/schemas/Currency"},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentResponse"}]},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorResponse"}]}}}}}}
```
## The GetTransactionResponse object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"GetTransactionResponse":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"subscription":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionResponse"}]},"amount":{"type":"number","format":"decimal"},"createdAt":{"type":"string","format":"date-time"},"createdUTC":{"type":"string","format":"date-time"},"currency":{"$ref":"#/components/schemas/Currency"},"state":{"$ref":"#/components/schemas/TransactionStatus"},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentResponse"}]},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorResponse"}]}}},"SubscriptionResponse":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","nullable":true},"token":{"type":"string","nullable":true},"subscriptionDate":{"type":"string","format":"date-time","nullable":true},"subscriptionLastPaymentDate":{"type":"string","format":"date-time"},"subscriptionStatus":{"$ref":"#/components/schemas/SubscriptionStatus"},"validUntil":{"type":"string","format":"date-time"},"legalId":{"type":"string","nullable":true},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"backgroundJobId":{"type":"string","nullable":true}}},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"SubscriptionTypeDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"frequence":{"$ref":"#/components/schemas/Frequence"},"subscriptionBaseCost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"recurrence":{"type":"integer","format":"int32"},"regularType":{"type":"boolean"},"taxPercentage":{"type":"string","nullable":true}}},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"InstrumentResponse":{"type":"object","additionalProperties":false,"properties":{"expiration":{"type":"string","format":"date-time"},"instrumentId":{"type":"string","nullable":true},"issuerImageUrl":{"type":"string","nullable":true},"issuerName":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"optionalUniqueID":{"type":"string","nullable":true}}},"SubscriptorResponse":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"fullName":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentResponse"}]},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionResponse"}},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionResponse"}},"firstSubscribed":{"type":"string","format":"date-time"}}},"TransactionResponse":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"subscription":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionResponse"}]},"amount":{"type":"number","format":"decimal"},"createdAt":{"type":"string","format":"date-time"},"state":{"$ref":"#/components/schemas/TransactionStatus"},"currency":{"$ref":"#/components/schemas/Currency"},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentResponse"}]},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorResponse"}]}}}}}}
```
## The PagedResultBaseApi object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"PagedResultBaseApi":{"type":"object","additionalProperties":false,"properties":{"currentPage":{"type":"integer","format":"int32"},"pageCount":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"rowCount":{"type":"integer","format":"int32"},"totals":{"type":"number","format":"decimal"},"totalsDollar":{"type":"number","format":"decimal"},"linkTemplate":{"type":"string","nullable":true},"firstRowOnPage":{"type":"integer","format":"int32"},"lastRowOnPage":{"type":"integer","format":"int32"}}}}}}
```
## The PagedResultOfTransactionDto object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"PagedResultOfTransactionDto":{"allOf":[{"$ref":"#/components/schemas/PagedResultBase"},{"type":"object","additionalProperties":false,"properties":{"results":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionDto"}}}}]},"PagedResultBase":{"type":"object","additionalProperties":false,"properties":{"currentPage":{"type":"integer","format":"int32"},"pageCount":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"rowCount":{"type":"integer","format":"int32"},"totalPeso":{"type":"number","format":"decimal"},"totalDollar":{"type":"number","format":"decimal"},"totalPesoFailed":{"type":"number","format":"decimal"},"totalDollarFailed":{"type":"number","format":"decimal"},"firstRowOnPage":{"type":"integer","format":"int32"},"lastRowOnPage":{"type":"integer","format":"int32"}}},"TransactionDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"subscriptionDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"amount":{"type":"number","format":"decimal"},"taxAmount":{"type":"number","format":"decimal"},"taxedAmount":{"type":"number","format":"decimal"},"createdAt":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/TransactionStatus"},"currency":{"$ref":"#/components/schemas/Currency"},"instrumentDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentDto"}]},"subscriptorDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"subscriptionTypeDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"transactionItemDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionItemDto"}]},"authorization":{"type":"string","nullable":true},"errorText":{"type":"string","nullable":true},"plexoClientReference":{"type":"string","nullable":true},"plexoTransactionId":{"type":"string","nullable":true}}},"SubscriptionDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"token":{"type":"string","nullable":true},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"subscriptionDate":{"type":"string","format":"date-time"},"subscriptionStatus":{"$ref":"#/components/schemas/SubscriptionStatus"},"subscriptionLastPaymentDate":{"type":"string","format":"date-time"},"validUntil":{"type":"string","format":"date-time"},"remainingRecurrences":{"type":"integer","format":"int32","nullable":true},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionDto"}}}},"SubscriptionTypeDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"frequence":{"$ref":"#/components/schemas/Frequence"},"subscriptionBaseCost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"recurrence":{"type":"integer","format":"int32"},"regularType":{"type":"boolean"},"taxPercentage":{"type":"string","nullable":true}}},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"ClientDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","nullable":true},"legalName":{"type":"string","nullable":true},"legalId":{"type":"string","nullable":true},"recurringPaymentUrl":{"type":"string","nullable":true},"plexoCommerceId":{"type":"integer","format":"int32"},"taxPercentage":{"type":"number","format":"decimal"},"admin":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ClientAdmin"}},"subscriptionTypesDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionTypeDto"}},"commercesDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/CommerceDto"}},"subscriptorsDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptorDto"}},"retriesConfiguration":{"$ref":"#/components/schemas/RetriesConfigurationEnum"},"notificationPermissionsDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NotificationPermissionsDto"}]}}},"ClientAdmin":{"type":"object","additionalProperties":false,"properties":{"userId":{"type":"string","nullable":true},"userName":{"type":"string","nullable":true},"clientId":{"type":"string","format":"guid"}}},"CommerceDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"issuer":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/IssuerDto"}]},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"fields":{"type":"object","nullable":true,"additionalProperties":{"type":"string"}}}},"IssuerDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"issuerImageUrl":{"type":"string","nullable":true},"fields":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FieldInfo"}}}},"FieldInfo":{"type":"object","additionalProperties":false,"properties":{"labelName":{"type":"string","nullable":true},"fieldType":{"$ref":"#/components/schemas/FieldType"},"required":{"type":"boolean"}}},"FieldType":{"type":"integer","description":"","enum":[257,258,259,260,261,262,263,264,265,266,267,268,269,270,271,272,273,274,513,514,515,516,517,518,519,520,521,522,523,524,525,526,527,528,529,530,531,532,533,534,535,1025,1281,1282,1283,1284,1285,1286,1287,1288,1289,1296,1297,1298,2049,2050,2051,2052,2053,2054,2055,2056,2057,2058,2059,2060,2061,2062,2063,2064,2065,2066,2067,2068,2069,2070,2071,2072,2073,2074,2075,2076,2077,2078,2079,2080,2081,2082,2083,2084,2085,2305,2306,2307,2308,2309,2310,2311,2312,2313,2320,33025,33026,33027,33028,33153,33154]},"SubscriptorDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"fullName":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionDto"}},"firstSubscribed":{"type":"string","format":"date-time","nullable":true},"links":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LinkDto"}}}},"InstrumentDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"expiration":{"type":"string","format":"date-time"},"issuerImageUrl":{"type":"string","nullable":true},"issuerName":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"token":{"type":"string","format":"guid","nullable":true},"plexoExtendedResponse":{"type":"string","nullable":true},"optionalUniqueID":{"type":"string","nullable":true}}},"LinkDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"externalId":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"canUpdateSubscriptorData":{"type":"boolean"},"status":{"$ref":"#/components/schemas/LinkStatusEnum"},"subscriptorDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]}}},"LinkStatusEnum":{"type":"integer","description":"","enum":[1,2,3]},"RetriesConfigurationEnum":{"type":"integer","description":"","enum":[0,1]},"NotificationPermissionsDto":{"type":"object","additionalProperties":false,"properties":{"transactionCancellation":{"type":"boolean"},"subscriptionCancellation":{"type":"boolean"},"subscriptorFields":{"type":"boolean"},"paymentSuccess":{"type":"boolean"},"paymentFailed":{"type":"boolean"}}},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionItemDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"amount":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"paymentRequestItemStatus":{"$ref":"#/components/schemas/PaymentRequestItemStatus"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionDto"}}}},"PaymentRequestItemStatus":{"type":"integer","description":"","enum":[1,2,3]}}}}
```
## The PagedResultApiOfTransactionResponse object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"PagedResultApiOfTransactionResponse":{"allOf":[{"$ref":"#/components/schemas/PagedResultBaseApi"},{"type":"object","additionalProperties":false,"properties":{"results":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionResponse"}}}}]},"PagedResultBaseApi":{"type":"object","additionalProperties":false,"properties":{"currentPage":{"type":"integer","format":"int32"},"pageCount":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"rowCount":{"type":"integer","format":"int32"},"totals":{"type":"number","format":"decimal"},"totalsDollar":{"type":"number","format":"decimal"},"linkTemplate":{"type":"string","nullable":true},"firstRowOnPage":{"type":"integer","format":"int32"},"lastRowOnPage":{"type":"integer","format":"int32"}}},"TransactionResponse":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"subscription":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionResponse"}]},"amount":{"type":"number","format":"decimal"},"createdAt":{"type":"string","format":"date-time"},"state":{"$ref":"#/components/schemas/TransactionStatus"},"currency":{"$ref":"#/components/schemas/Currency"},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentResponse"}]},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorResponse"}]}}},"SubscriptionResponse":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","nullable":true},"token":{"type":"string","nullable":true},"subscriptionDate":{"type":"string","format":"date-time","nullable":true},"subscriptionLastPaymentDate":{"type":"string","format":"date-time"},"subscriptionStatus":{"$ref":"#/components/schemas/SubscriptionStatus"},"validUntil":{"type":"string","format":"date-time"},"legalId":{"type":"string","nullable":true},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"backgroundJobId":{"type":"string","nullable":true}}},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"SubscriptionTypeDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"frequence":{"$ref":"#/components/schemas/Frequence"},"subscriptionBaseCost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"recurrence":{"type":"integer","format":"int32"},"regularType":{"type":"boolean"},"taxPercentage":{"type":"string","nullable":true}}},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"InstrumentResponse":{"type":"object","additionalProperties":false,"properties":{"expiration":{"type":"string","format":"date-time"},"instrumentId":{"type":"string","nullable":true},"issuerImageUrl":{"type":"string","nullable":true},"issuerName":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"optionalUniqueID":{"type":"string","nullable":true}}},"SubscriptorResponse":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"fullName":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentResponse"}]},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionResponse"}},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionResponse"}},"firstSubscribed":{"type":"string","format":"date-time"}}}}}}
```
## The PagedResultOfTransaction object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"PagedResultOfTransaction":{"allOf":[{"$ref":"#/components/schemas/PagedResultBase"},{"type":"object","additionalProperties":false,"properties":{"results":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}}}}]},"PagedResultBase":{"type":"object","additionalProperties":false,"properties":{"currentPage":{"type":"integer","format":"int32"},"pageCount":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"rowCount":{"type":"integer","format":"int32"},"totalPeso":{"type":"number","format":"decimal"},"totalDollar":{"type":"number","format":"decimal"},"totalPesoFailed":{"type":"number","format":"decimal"},"totalDollarFailed":{"type":"number","format":"decimal"},"firstRowOnPage":{"type":"integer","format":"int32"},"lastRowOnPage":{"type":"integer","format":"int32"}}},"Transaction":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["currency","amount","taxedAmount","taxAmount","date","status","retryAttempt","type","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"currency":{"$ref":"#/components/schemas/Currency"},"amount":{"type":"number","format":"decimal"},"taxedAmount":{"type":"number","format":"decimal"},"taxAmount":{"type":"number","format":"decimal"},"date":{"type":"string","format":"date-time","minLength":1},"status":{"$ref":"#/components/schemas/TransactionStatus"},"authorization":{"type":"string","nullable":true},"plexoReferenceId":{"type":"string","nullable":true},"errorText":{"type":"string","nullable":true},"retryAttempt":{"type":"integer","format":"int32","default":1},"plexoClientReference":{"type":"string","nullable":true},"ticket":{"type":"string","nullable":true},"type":{"default":1,"oneOf":[{"$ref":"#/components/schemas/TransactionType"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItemId":{"type":"string","format":"guid","nullable":true},"transactionRequestItem":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestItem"}]},"subscriptionId":{"type":"string","format":"guid","nullable":true},"subscription":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscription"}]},"instrumentId":{"type":"string","format":"guid","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Instrument"}]},"electronicBillingId":{"type":"integer","format":"int32","nullable":true},"electronicBilling":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ElectronicBill"}]}}}]},"BaseEntity":{"type":"object","additionalProperties":false},"Currency":{"type":"integer","description":"","enum":[1,2]},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionType":{"type":"integer","description":"","enum":[1,2]},"Client":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","legalName","legalId","clientSecret","plexoCommerceId","admin","taxPercentage"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"legalName":{"type":"string","maxLength":150,"minLength":1},"legalId":{"type":"string","maxLength":12,"minLength":1},"clientSecret":{"type":"string","maxLength":50,"minLength":1},"plexoCommerceId":{"type":"integer","format":"int32"},"recurringPaymentUrl":{"type":"string","maxLength":100,"nullable":true},"admin":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationUser"}},"taxPercentage":{"type":"number","format":"decimal","default":22},"subscriptionTypes":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionType"}},"clientIssuers":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ClientIssuer"}},"subscriptors":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscriptor"}},"historicData":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/HistoricData"}},"retriesConfiguration":{"$ref":"#/components/schemas/RetriesConfigurationEnum"},"notificationPermissionsId":{"type":"integer","format":"int32"},"notificationPermissions":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NotificationPermissions"}]}}}]},"ApplicationUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUser"},{"type":"object","additionalProperties":false,"properties":{"userType":{"$ref":"#/components/schemas/UserType"},"clientID":{"type":"string","format":"guid"}}}]},"IdentityUser":{"allOf":[{"$ref":"#/components/schemas/IdentityUserOfString"},{"type":"object","description":"The default implementation of IdentityUser`1 which uses a string as a primary key.","additionalProperties":false}]},"IdentityUserOfString":{"type":"object","description":"Represents a user in the identity system","additionalProperties":false,"properties":{"id":{"type":"string","description":"Gets or sets the primary key for this user.","nullable":true},"userName":{"type":"string","description":"Gets or sets the user name for this user.","nullable":true},"normalizedUserName":{"type":"string","description":"Gets or sets the normalized user name for this user.","nullable":true},"email":{"type":"string","description":"Gets or sets the email address for this user.","nullable":true},"normalizedEmail":{"type":"string","description":"Gets or sets the normalized email address for this user.","nullable":true},"emailConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their email address."},"passwordHash":{"type":"string","description":"Gets or sets a salted and hashed representation of the password for this user.","nullable":true},"securityStamp":{"type":"string","description":"A random value that must change whenever a users credentials change (password changed, login removed)","nullable":true},"concurrencyStamp":{"type":"string","description":"A random value that must change whenever a user is persisted to the store","nullable":true},"phoneNumber":{"type":"string","description":"Gets or sets a telephone number for the user.","nullable":true},"phoneNumberConfirmed":{"type":"boolean","description":"Gets or sets a flag indicating if a user has confirmed their telephone address."},"twoFactorEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if two factor authentication is enabled for this user."},"lockoutEnd":{"type":"string","description":"Gets or sets the date and time, in UTC, when any user lockout ends.","format":"date-time","nullable":true},"lockoutEnabled":{"type":"boolean","description":"Gets or sets a flag indicating if the user could be locked out."},"accessFailedCount":{"type":"integer","description":"Gets or sets the number of failed login attempts for the current user.","format":"int32"}}},"UserType":{"type":"integer","description":"","enum":[0,1,2]},"SubscriptionType":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["name","description","frequence","cost","currency","status","recurrence"],"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","maxLength":50,"minLength":0},"description":{"type":"string","maxLength":120,"minLength":0},"frequence":{"$ref":"#/components/schemas/Frequence"},"cost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"status":{"$ref":"#/components/schemas/SubscriptionTypeStatus"},"recurrence":{"type":"integer","format":"int32","default":0},"taxPercentage":{"type":"number","format":"decimal","nullable":true}}}]},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"SubscriptionTypeStatus":{"type":"integer","description":"","enum":[0,99]},"ClientIssuer":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["issuerId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"issuerId":{"type":"integer","format":"int32"},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]}}}]},"Subscriptor":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["externalId","clientId"],"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","maxLength":100,"minLength":0},"email":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"name":{"type":"string","maxLength":50,"minLength":0,"nullable":true},"fullName":{"type":"string","maxLength":150,"minLength":0,"nullable":true},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"instruments":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Instrument"}},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Subscription"}},"links":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Link"}}}}]},"Instrument":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["subscriptorId","instrumentToken","name","issuerName","issuerImageUrl","expiration","status"],"properties":{"id":{"type":"string","format":"guid"},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"instrumentToken":{"type":"string","format":"guid","minLength":1},"name":{"type":"string","maxLength":50,"minLength":1},"issuerName":{"type":"string","maxLength":50,"minLength":1},"issuerImageUrl":{"type":"string","maxLength":200,"minLength":1},"expiration":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/InstrumentStatus"},"uniqueID":{"type":"string","maxLength":200,"nullable":true},"plexoExtendedResponse":{"type":"string","nullable":true}}}]},"InstrumentStatus":{"type":"integer","description":"","enum":[0,99]},"Subscription":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["token","subscriptionTypeId","date","status","lastPaymentDate","validToDate","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"token":{"type":"string","minLength":1},"subscriptionTypeId":{"type":"integer","format":"int32"},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionType"}]},"date":{"type":"string","format":"date","minLength":1},"status":{"$ref":"#/components/schemas/SubscriptionStatus"},"lastPaymentDate":{"type":"string","format":"date","minLength":1},"validToDate":{"type":"string","format":"date","minLength":1},"backgroundJobId":{"type":"string","nullable":true},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"suspendedBy":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SuspendedByEnum"}]},"suspendedDate":{"type":"string","format":"date","nullable":true},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"remainingRecurrences":{"type":"integer","format":"int32","nullable":true}}}]},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"SuspendedByEnum":{"type":"integer","description":"","enum":[0,1]},"Link":{"type":"object","additionalProperties":false,"required":["externalId","status","clientId","canUpdateSubscriptorData"],"properties":{"id":{"type":"string","format":"guid"},"externalId":{"type":"string","maxLength":150,"minLength":1},"firstName":{"type":"string","maxLength":50,"nullable":true},"lastName":{"type":"string","maxLength":50,"nullable":true},"email":{"type":"string","maxLength":150,"nullable":true},"status":{"default":1,"oneOf":[{"$ref":"#/components/schemas/LinkStatusEnum"}]},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"subscriptorId":{"type":"integer","format":"int32","nullable":true},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"canUpdateSubscriptorData":{"type":"boolean","default":true},"subscriptionTypeId":{"type":"string","nullable":true}}},"LinkStatusEnum":{"type":"integer","description":"","enum":[1,2,3]},"HistoricData":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"date":{"type":"string","format":"date"},"totalSubscriptors":{"type":"integer","format":"int32"}}},"RetriesConfigurationEnum":{"type":"integer","description":"","enum":[0,1]},"NotificationPermissions":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["id"],"properties":{"id":{"type":"integer","format":"int32"},"transactionCancellation":{"type":"boolean"},"subscriptionCancellation":{"type":"boolean"},"subscriptorFields":{"type":"boolean"},"paymentSuccess":{"type":"boolean"},"paymentFailed":{"type":"boolean"},"subcriptioninactiveByPaymentFailure":{"type":"boolean"}}}]},"TransactionRequestItem":{"type":"object","additionalProperties":false,"required":["amount","currency","paymentRequestItemStatus","transactionRequestFileId","subscriptorId"],"properties":{"id":{"type":"string","format":"guid"},"amount":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"paymentRequestItemStatus":{"$ref":"#/components/schemas/PaymentRequestItemStatus"},"transactionRequestFileId":{"type":"string","format":"guid","minLength":1},"transactionRequestFile":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionRequestFile"}]},"subscriptorId":{"type":"integer","format":"int32"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Subscriptor"}]},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/Transaction"}},"jobId":{"type":"string","nullable":true}}},"PaymentRequestItemStatus":{"type":"integer","description":"","enum":[1,2,3]},"TransactionRequestFile":{"type":"object","additionalProperties":false,"required":["name","url","clientId"],"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","maxLength":50,"minLength":1},"url":{"type":"string","maxLength":200,"minLength":1},"clientId":{"type":"string","format":"guid","minLength":1},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Client"}]},"transactionRequestItems":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionRequestItem"}},"date":{"type":"string","format":"date-time"}}},"ElectronicBill":{"allOf":[{"$ref":"#/components/schemas/BaseEntity"},{"type":"object","additionalProperties":false,"required":["internalId","caeNumber","series","number"],"properties":{"id":{"type":"integer","format":"int32"},"internalId":{"type":"integer","format":"int32"},"caeNumber":{"type":"string","minLength":1},"series":{"type":"string","minLength":1},"number":{"type":"integer","format":"int32"}}}]}}}}
```
## The TransactionRequestFileDto object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"TransactionRequestFileDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","nullable":true},"url":{"type":"string","nullable":true},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"totalCount":{"type":"integer","format":"int32"},"successCount":{"type":"integer","format":"int32"},"failedCount":{"type":"integer","format":"int32"},"date":{"type":"string","format":"date-time"}}},"ClientDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","nullable":true},"legalName":{"type":"string","nullable":true},"legalId":{"type":"string","nullable":true},"recurringPaymentUrl":{"type":"string","nullable":true},"plexoCommerceId":{"type":"integer","format":"int32"},"taxPercentage":{"type":"number","format":"decimal"},"admin":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ClientAdmin"}},"subscriptionTypesDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionTypeDto"}},"commercesDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/CommerceDto"}},"subscriptorsDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptorDto"}},"retriesConfiguration":{"$ref":"#/components/schemas/RetriesConfigurationEnum"},"notificationPermissionsDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NotificationPermissionsDto"}]}}},"ClientAdmin":{"type":"object","additionalProperties":false,"properties":{"userId":{"type":"string","nullable":true},"userName":{"type":"string","nullable":true},"clientId":{"type":"string","format":"guid"}}},"SubscriptionTypeDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"frequence":{"$ref":"#/components/schemas/Frequence"},"subscriptionBaseCost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"recurrence":{"type":"integer","format":"int32"},"regularType":{"type":"boolean"},"taxPercentage":{"type":"string","nullable":true}}},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"Currency":{"type":"integer","description":"","enum":[1,2]},"CommerceDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"issuer":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/IssuerDto"}]},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"fields":{"type":"object","nullable":true,"additionalProperties":{"type":"string"}}}},"IssuerDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"issuerImageUrl":{"type":"string","nullable":true},"fields":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FieldInfo"}}}},"FieldInfo":{"type":"object","additionalProperties":false,"properties":{"labelName":{"type":"string","nullable":true},"fieldType":{"$ref":"#/components/schemas/FieldType"},"required":{"type":"boolean"}}},"FieldType":{"type":"integer","description":"","enum":[257,258,259,260,261,262,263,264,265,266,267,268,269,270,271,272,273,274,513,514,515,516,517,518,519,520,521,522,523,524,525,526,527,528,529,530,531,532,533,534,535,1025,1281,1282,1283,1284,1285,1286,1287,1288,1289,1296,1297,1298,2049,2050,2051,2052,2053,2054,2055,2056,2057,2058,2059,2060,2061,2062,2063,2064,2065,2066,2067,2068,2069,2070,2071,2072,2073,2074,2075,2076,2077,2078,2079,2080,2081,2082,2083,2084,2085,2305,2306,2307,2308,2309,2310,2311,2312,2313,2320,33025,33026,33027,33028,33153,33154]},"SubscriptorDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"fullName":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionDto"}},"firstSubscribed":{"type":"string","format":"date-time","nullable":true},"links":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LinkDto"}}}},"InstrumentDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"expiration":{"type":"string","format":"date-time"},"issuerImageUrl":{"type":"string","nullable":true},"issuerName":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"token":{"type":"string","format":"guid","nullable":true},"plexoExtendedResponse":{"type":"string","nullable":true},"optionalUniqueID":{"type":"string","nullable":true}}},"SubscriptionDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"token":{"type":"string","nullable":true},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"subscriptionDate":{"type":"string","format":"date-time"},"subscriptionStatus":{"$ref":"#/components/schemas/SubscriptionStatus"},"subscriptionLastPaymentDate":{"type":"string","format":"date-time"},"validUntil":{"type":"string","format":"date-time"},"remainingRecurrences":{"type":"integer","format":"int32","nullable":true},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionDto"}}}},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"subscriptionDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"amount":{"type":"number","format":"decimal"},"taxAmount":{"type":"number","format":"decimal"},"taxedAmount":{"type":"number","format":"decimal"},"createdAt":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/TransactionStatus"},"currency":{"$ref":"#/components/schemas/Currency"},"instrumentDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentDto"}]},"subscriptorDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"subscriptionTypeDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"transactionItemDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionItemDto"}]},"authorization":{"type":"string","nullable":true},"errorText":{"type":"string","nullable":true},"plexoClientReference":{"type":"string","nullable":true},"plexoTransactionId":{"type":"string","nullable":true}}},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionItemDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"amount":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"paymentRequestItemStatus":{"$ref":"#/components/schemas/PaymentRequestItemStatus"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionDto"}}}},"PaymentRequestItemStatus":{"type":"integer","description":"","enum":[1,2,3]},"LinkDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"externalId":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"canUpdateSubscriptorData":{"type":"boolean"},"status":{"$ref":"#/components/schemas/LinkStatusEnum"},"subscriptorDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]}}},"LinkStatusEnum":{"type":"integer","description":"","enum":[1,2,3]},"RetriesConfigurationEnum":{"type":"integer","description":"","enum":[0,1]},"NotificationPermissionsDto":{"type":"object","additionalProperties":false,"properties":{"transactionCancellation":{"type":"boolean"},"subscriptionCancellation":{"type":"boolean"},"subscriptorFields":{"type":"boolean"},"paymentSuccess":{"type":"boolean"},"paymentFailed":{"type":"boolean"}}}}}}
```
## The TransactionRequestFileData object
```json
{"openapi":"3.0.0","info":{"title":"My Title","version":"1.0.0"},"components":{"schemas":{"TransactionRequestFileData":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","nullable":true},"url":{"type":"string","nullable":true},"date":{"type":"string","format":"date-time"},"transactionRequestItems":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionItemDto"}}}},"TransactionItemDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"amount":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"paymentRequestItemStatus":{"$ref":"#/components/schemas/PaymentRequestItemStatus"},"subscriptor":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionDto"}}}},"Currency":{"type":"integer","description":"","enum":[1,2]},"PaymentRequestItemStatus":{"type":"integer","description":"","enum":[1,2,3]},"SubscriptorDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"externalId":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"fullName":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"instrument":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"subscriptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionDto"}},"firstSubscribed":{"type":"string","format":"date-time","nullable":true},"links":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/LinkDto"}}}},"InstrumentDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"expiration":{"type":"string","format":"date-time"},"issuerImageUrl":{"type":"string","nullable":true},"issuerName":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"token":{"type":"string","format":"guid","nullable":true},"plexoExtendedResponse":{"type":"string","nullable":true},"optionalUniqueID":{"type":"string","nullable":true}}},"ClientDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"name":{"type":"string","nullable":true},"legalName":{"type":"string","nullable":true},"legalId":{"type":"string","nullable":true},"recurringPaymentUrl":{"type":"string","nullable":true},"plexoCommerceId":{"type":"integer","format":"int32"},"taxPercentage":{"type":"number","format":"decimal"},"admin":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ClientAdmin"}},"subscriptionTypesDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptionTypeDto"}},"commercesDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/CommerceDto"}},"subscriptorsDto":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/SubscriptorDto"}},"retriesConfiguration":{"$ref":"#/components/schemas/RetriesConfigurationEnum"},"notificationPermissionsDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/NotificationPermissionsDto"}]}}},"ClientAdmin":{"type":"object","additionalProperties":false,"properties":{"userId":{"type":"string","nullable":true},"userName":{"type":"string","nullable":true},"clientId":{"type":"string","format":"guid"}}},"SubscriptionTypeDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"frequence":{"$ref":"#/components/schemas/Frequence"},"subscriptionBaseCost":{"type":"number","format":"decimal"},"currency":{"$ref":"#/components/schemas/Currency"},"recurrence":{"type":"integer","format":"int32"},"regularType":{"type":"boolean"},"taxPercentage":{"type":"string","nullable":true}}},"Frequence":{"type":"integer","description":"","enum":[0,1,2,3,4,5,6,7]},"CommerceDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"issuer":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/IssuerDto"}]},"client":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"fields":{"type":"object","nullable":true,"additionalProperties":{"type":"string"}}}},"IssuerDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"issuerImageUrl":{"type":"string","nullable":true},"fields":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FieldInfo"}}}},"FieldInfo":{"type":"object","additionalProperties":false,"properties":{"labelName":{"type":"string","nullable":true},"fieldType":{"$ref":"#/components/schemas/FieldType"},"required":{"type":"boolean"}}},"FieldType":{"type":"integer","description":"","enum":[257,258,259,260,261,262,263,264,265,266,267,268,269,270,271,272,273,274,513,514,515,516,517,518,519,520,521,522,523,524,525,526,527,528,529,530,531,532,533,534,535,1025,1281,1282,1283,1284,1285,1286,1287,1288,1289,1296,1297,1298,2049,2050,2051,2052,2053,2054,2055,2056,2057,2058,2059,2060,2061,2062,2063,2064,2065,2066,2067,2068,2069,2070,2071,2072,2073,2074,2075,2076,2077,2078,2079,2080,2081,2082,2083,2084,2085,2305,2306,2307,2308,2309,2310,2311,2312,2313,2320,33025,33026,33027,33028,33153,33154]},"RetriesConfigurationEnum":{"type":"integer","description":"","enum":[0,1]},"NotificationPermissionsDto":{"type":"object","additionalProperties":false,"properties":{"transactionCancellation":{"type":"boolean"},"subscriptionCancellation":{"type":"boolean"},"subscriptorFields":{"type":"boolean"},"paymentSuccess":{"type":"boolean"},"paymentFailed":{"type":"boolean"}}},"SubscriptionDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"token":{"type":"string","nullable":true},"subscriptionType":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"subscriptionDate":{"type":"string","format":"date-time"},"subscriptionStatus":{"$ref":"#/components/schemas/SubscriptionStatus"},"subscriptionLastPaymentDate":{"type":"string","format":"date-time"},"validUntil":{"type":"string","format":"date-time"},"remainingRecurrences":{"type":"integer","format":"int32","nullable":true},"transactions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TransactionDto"}}}},"SubscriptionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"TransactionDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"subscriptionDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]},"amount":{"type":"number","format":"decimal"},"taxAmount":{"type":"number","format":"decimal"},"taxedAmount":{"type":"number","format":"decimal"},"createdAt":{"type":"string","format":"date-time"},"status":{"$ref":"#/components/schemas/TransactionStatus"},"currency":{"$ref":"#/components/schemas/Currency"},"instrumentDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/InstrumentDto"}]},"subscriptorDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"subscriptionTypeDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptionTypeDto"}]},"transactionItemDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/TransactionItemDto"}]},"authorization":{"type":"string","nullable":true},"errorText":{"type":"string","nullable":true},"plexoClientReference":{"type":"string","nullable":true},"plexoTransactionId":{"type":"string","nullable":true}}},"TransactionStatus":{"type":"integer","description":"","enum":[0,1,2,3,4]},"LinkDto":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"string","format":"guid"},"externalId":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"canUpdateSubscriptorData":{"type":"boolean"},"status":{"$ref":"#/components/schemas/LinkStatusEnum"},"subscriptorDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubscriptorDto"}]},"clientDto":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ClientDto"}]}}},"LinkStatusEnum":{"type":"integer","description":"","enum":[1,2,3]}}}}
```
