Los planes es el template inicial y el que la suscripción con el usuario usará como configuración para determinar el tiempo de la recurrencia, dias de prueba entre otros
Descripción: Verifica una ID del grupo como se ve en la solicitud subscriptionGroup? y trae todos los planes relacionadas con ese grupo.
Descripción: Trae un plan por su "id" y también incluye una lista de las suscripciones activas para la entrada.
Descripción: Crear un plan, el cual sera utilizado como guía para las suscripciones recurrentes.
| Nombre del campo | Descripción | Reglas |
|---|---|---|
| name | Nombre del plan | requerido, cadena, 'max:150' |
| description | Descripción del plan | requerido, cadena, 'max:500' |
| price | Valor que se usará para cada transacción en la recurrencia | requerido, numeric, max-cop:999999999999 max(usd-eur):200000000 |
| currency_type | Tipo de moneda en el que se realizará la transacción en la recurrencia | requerido, enumeración (COP, USD, EUR) |
| tax | Hace referencia al valor de iva a utilizar | opcional, Valores 10 o 19 |
| trial_period | Indica el tiempo de prueba de acuerdo al intervalo asignado, el débito se realizará una vez termine el tiempo de prueba en la recurrencia | a veces, entero, max:30 |
| trial_interval | Indica el intervalo para el tiempo de prueba . | a veces, enumeración (day, week, month, year) |
| invoice_period | Indica el tiempo entre cada recurrencia | a veces, entero, min:1, max:30 |
| invoice_interval | Indica el intervalo para el tiempo entre cada recurrencia | a veces, enumeración (day, week, month, year) |
| grace_period | Indica el tiempo que tendrá la recurrencia cada día de reintentar la transacción en caso de rechazo | a veces, entero, 'max:30' |
| grace_interval | Indica el intervalo para el periodo de gracia | a veces, en enumeración (day, week, month, year) |
| discount_period | Indica el tiempo en el que se aplicara el descuento sobre el precio asignado | a veces, entero, max:30 |
| discount_interval | Indica el intervalo para el tiempo del descuento | a veces, en enumeración (day, week, month, year) |
| discount_subscribers_limit | Indica el limite de suscriptores suscritos con este descuento | a veces, entero, max:30 |
| discount_type_amount | Tipo de descuento a aplicar | a veces, en enumeración (value, percentage) |
| discount_amount | Total del descuento de acuerdo al tipo de descuento | a veces, value:1-price percentage:1-100 |
| sort_order | Orden de los planes | opcional, entero, max:100000 |
| active_subscriber_limit | Limite de suscriptores activos al plan | opcional, entero, max:30 |
| allow_multiple_subscriptions | Indica si se permitirán multiples suscripciones para pagos recurrentes con el mismo subscriptor | a veces, booleano |
| subscription_group_id | Indicar al grupo al que se relacionara el plan | opcional, id de grupo creado |
| office | Sucursal a la que pertenecerá el plan. | requerido, id de Sucursal |
Descripción: Actualiza un valor de una entrada con el valor necesitado.
Parámetros de consulta: Los parámetros de consulta son iguales a los de Create omitiendo el campo "office".
Descripción: Change the plan "active" status.
Parámetros de consulta:
"active" booleano, define el estado de plan y puede ser cambiado por medio de esta solicitud.
Descripción: Borra una entrada dependiendo de la "id" indicada.