Este end-point tem como objetivo realizar uma consulta filtrada de todos os planos disponíveis.
| Variável | Tipo | Descrição |
|---|
| totalRecords | Number | Total de planos por página |
| data | PlanResponseForm | Lista contendo todos os planos da página |
| Variável | Tipo | Descrição |
|---|
| id | Number | Identificador único do plano |
| status | PlanStatus | Status do plano |
| name | String | Nome do plano |
| description | String | Descrição do plano |
| periodicValue | Number | Valor base a ser cobrado nas parcelas do plano em centavos |
| duration | Number | Tempo de duração do plano, sendo nulo = infinito |
| period | PlanPeriod | Periodicidade do plano |
| serviceOffered | String | Serviço oferecido pelo plano |
| Variável | Tipo | Descrição |
|---|
| ACTIVE | String | O plano está ativo e pode ser usado normalmente |
| INACTIVE | String | O plano está inativo e não pode aparecer para o cliente como opção |
| BLOCKED | String | O plano está bloqueado para uso |
| Tipo | |
|---|
| WEEKLY | String | Cobranças realizadas semanalmente |
| MONTHLY | String | Cobranças realizadas mensalmente |
| QUARTERLY | String | Cobranças realizadas trimestralmente |
| SEMIANNUAL | String | Cobranças realizadas semestralmente |
| YEARLY | String | Cobranças realizadas anualmente |
