Endpoint que permite visualizar el estado actual de la suscripción de una compañía. Adicionalmente, ofrece la opción de consultar el costo total por agregar personas adicionales a un plan anual, así como el costo asociado a un cambio de plan (upgrade). Empresas anuales Consultar valor para cambio de plan (upgrade) en anualidad Para realizar un cambio de plan dentro de una suscripción anual, debes enviar los siguientes parámetros en la consulta (query parameters): - plan_id: El ID del nuevo plan al que deseas cambiarte. - extra_workers_number: Debe ser 0 si no planeas agregar personas adicionales en este cambio de plan. Ejemplo: shell https://api.nominapp.com/v1/{company_id}/subscription?plan_id=8919982a-0f18-4c82-8009-1a9d825b23de&extra_workers_number=0 Consultar valor para cambio de plan (upgrade) y agregar personas extras en anualidad Para realizar un cambio de plan y agregar personas adicionales dentro de una suscripción anual, debes enviar los siguientes parámetros en la consulta (query parameters): - plan_id: El ID del nuevo plan al que deseas cambiarte. - extra_workers_number: El número de personas extras que deseas agregar. Si no deseas agregar personas extras, envía el valor 0 en este parámetro. Ejemplo: shell https://api.nominapp.com/v1/{company_id}/subscription?plan_id=8919982a-0f18-4c82-8009-1a9d825b23de&extra_workers_number=5 Consultar valor para agregar personas extras en anualidad Si deseas únicamente agregar personas adicionales a una suscripción anual, debes enviar el siguiente parámetro en la consulta (query parameters): - extra_workers_number: El número de personas extras que deseas agregar. Ejemplo: shell https://api.nominapp.com/v1/{company_id}/subscription?extra_workers_number=5 Empresas mensuales Consultar valor por cambio de plan (upgrade) en una mensualidad Para realizar un cambio de plan en una suscripción mensual, debes enviar los siguientes parámetros en la consulta: - plan_id: ID del nuevo plan al que deseas cambiar. - extra_workers_number: Envía 0 si no agregas personas extras. - action_type: Especifica el string upgrade_info para indicar que se trata de un cambio en la suscripción. Ejemplo: shell https://api.nominapp.com/v1/{company_id}/subscription?plan_id=ec5d3c25-0500-486f-8fd8-78edfdf5084d&extra_workers_number=0&action_type=upgrade_info Consultar el valor por cambio de plan (upgrade), cambio de frecuencia de pago a anual y agregar personas extras Para realizar un cambio de plan, modificar la frecuencia de pago a anual o agregar personas adicionales, es necesario enviar los siguientes parámetros a través de query parameters: - plan_id: El ID del plan al que se quiere cambiar. - extra_workers_number: El número de personas extras que se desea agregar. Si no se desea agregar personas extras, se debe enviar 0. - subscription_type: Establece year para cambiar la frecuencia de pago a anual. - action_type: Especifica el string upgrade_info para indicar que se trata de un cambio en la suscripción. Ejemplo: shell https://api.nominapp.com/v1/{company_id}/subscription?plan_id=ec5d3c25-0500-486f-8fd8-78edfdf5084d&subscription_type=year&extra_workers_number=5&action_type=upgrade_info Para consulta del valor por cambio de frecuencia de pago a anual y agregar personas extras Para cambiar la frecuencia de pago a anual y agregar personas extras, debes enviar los siguientes parámetros en la consulta: - extra_workers_number: Indica el número de personas extras a agregar. Si no deseas agregar personas extras, envía 0. - subscription_type: Usa el valor year para especificar el cambio a una frecuencia de pago anual. - action_type: Especifica el string upgrade_info para indicar que se trata de un cambio en la suscripción. Ejemplo: shell https://api.nominapp.com/v1/{company_id}/subscription?subscription_type=year&extra_workers_number=5&action_type=upgrade_info Consultar únicamente la información relacionada con el cambio de suscripción (downgrade) Para obtener información sobre el nuevo plan tras realizar un downgrade, debes enviar el siguiente parámetro - action_type: Especifica el string downgrade_info para indicar que se trata de un cambio en la suscripción. Ejemplo: shell https://api.nominapp.com/v1/{company_id}/subscription?action_type=downgrade_info
get
https://nominapp-api-stage.herokuapp.com/v1//subscription