Planes


Overview

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

Get By Group

Descripción: Verifica una ID del grupo como se ve en la solicitud subscriptionGroup? y trae todos los planes relacionadas con ese grupo.

get

Descripción: Trae un plan por su "id" y también incluye una lista de las suscripciones activas para la entrada.

Create

Descripción: Crea un plan en la base de datos de acuerdo a los parámetros del modelo.

Nombre del campo Descripción Reglas
name Es requerido y debe ser una cadena de máximo 150 caracteres. requerido, cadena, 'max:150'
description Puede estar vacío, puede tener un máximo de 500 caracteres. requerido, cadena, 'max:500'
price Es requerido, debe ser un número. requerido, numerico
currency_type Es requerido. Su valor debe encontrarse en la enumeración (COP, USD, EUR). requerido, en enumeración (COP, USD, EUR)
tax Opcional. Hace referencia al iva a utilizar Opcional, Valores 10 o 19
trial_period En caso de estar presente en el request, debe ser un número y puede tener un valor máximo de 100000. a veces, entero, 'max:100000
trial_interval En caso de estar presente en el request, debe encontrarse en la enumeración (day, week, month, year). a veces, en enumeración (day, week, month, year)
invoice_period En caso de estar presente en el request, debe ser un número y puede tener un valor máximo de 100000. a veces, entero, 'max:100000'
invoice_interval En caso de estar presente en el request, debe encontrarse en la enumeración (day, week, month, year). a veces, en enumeración (day, week, month, year)
grace_period En caso de estar presente en el request, debe ser un número y puede tener un valor máximo de 100000. a veces, entero, 'max:100000'
grace_interval En caso de estar presente en el request, debe encontrarse en la enumeración (day, week, month, year). a veces, en enumeración (day, week, month, year)
discount_period En caso de estar presente en el request, debe ser un número y puede tener un valor máximo de 100000. a veces, entero, 'max:100000'
discount_interval En caso de estar presente en el request, debe encontrarse en la enumeración (day, week, month, year). a veces, en enumeración (day, week, month, year)
discount_subcribers_limit En caso de estar presente en el request, debe ser un número y puede tener un valor máximo de 100000. a veces, entero, 'max:100000'
discount_type_amount En caso de estar presente en el request, debe encontrarse en la enumeración (value, percentage). a veces, en enumeración (value, percentage)
discount_amount En caso de estar presente en el request, debe ser un número. a veces, 'numerico'
sort_order En caso de estar presente en el request, debe ser un número entero y puede tener un valor máximo de 100000. puede ser nulo, entero, 'max:100000'
active_subscriber_limit Puede estar vacío. En caso de estar presente en el request, debe ser un número entero y puede tener un valor máximo de 100000. puede ser nulo, entero, 'max:100000'
subscription_group_id Esta validación asegura que el campo 'subscription', si está presente, debe corresponder a un registro existente en la tabla 'subscription_groups' y estar asociado al usuario autenticado. puede ser nulo, 'subscription_groups' y id existe, 'user_id' coincide con el ID del usuario autenticado.
office Requerido. Hace referencia al ID de tus Sucursales. Si la ruta de la solicitud empieza con 'api/', el campo es requerido, de otra forma puede ser nulo. La tabla '

Update

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".

Change Active

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.

Delete

Descripción: Borra una entrada dependiendo de la "id" indicada.