> ## Documentation Index
> Fetch the complete documentation index at: https://docs.clubfix.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Cota um único plano

<ParamField path="planId" type="string" required>
  Corresponde ao ID do plano para o qual será realizada a cotação. Este ID é único para cada plano e pode ser encontrado na listagem de planos.
</ParamField>

<ParamField query="model_id" type="string">
  Corresponde ao ID do modelo de dispositivo que pode ser encontrado no recurso `/models` que dispõe este webservice.
</ParamField>

<ParamField query="is_used" type="string">
  Informa se o dispositivo possui mais de três meses de uso. Valores possíveis: `true` ou `false`.
</ParamField>

<ParamField header="Accept" type="string" required>
  Deve ser definido como `application/json`.
</ParamField>

<ParamField header="Authorization" type="string" required>
  Token de autenticação do tipo Bearer obtido através do endpoint de login.
</ParamField>


## OpenAPI

````yaml GET /plans/{planId}/quotation
openapi: 3.0.3
info:
  title: Clubfix Webservice de Parceiros
  description: >-
    Bem vido(a) à documentação do **Webservice de Parceiros** da **Clubfix.** Os
    recursos aqui dispostos são suplementados com exemplos de respostas
    esperadas, para nortear a implementação. Caso haja algum empecilho ou erro
    não esperado, fique à vontade para chamar o suporte em TI pelos canais que
    você já conhece.


    Observação: Utilize sempre os cabeçalhos `Content-Type` e `Accept` como
    `application/json`


    #### **URL Base**


    | **Ambiente** | **URL** |

    | --- | --- |

    | Homologação | [https://homolog.clubfix.com.br/webservice]() |

    | Produção | [https://clubfix.com.br/webservice]() |


    > NOTA: Para conseguir utilizar ambos ambientes, faz-se necessário solicitar
    pelo nosso time de suporte a geração das chaves de autenticação mencionadas
    na seção de **Autenticação**. 
      

    #### Paginação


    Para navegar nos recursos de listagem através de suas páginas, utilize as
    `parâmeros` dispostas na tabela abaixo


    | **Parâmetro** | **Descrição** |

    | --- | --- |

    | page | Corresponde à pagina que você deseja exibir os dados. |

    | per_page | Altera a quantidade de itens devolvidos em uma requisição. |

    | current_page | Identifica a pagina correspondente àquela requisição. |


    ### **Conhecendo os erros comuns**


    | **Status Code** | **Descrição** |

    | --- | --- |

    | 422 | Erro em algum parâmetro fornecido. O resultado deste erro será um
    objeto, onde a sua chave indicará o campo que não está em conformidade. |

    | 401 | Não autorizado. Significa que há ausência de um token válido na
    requisição, seja por expiração, não fornecimento, ou, no caso do login, as
    suas credenciais não estão corretas. |

    | 5** | Erro de servidor no endpoint requisitado. Quando isso ocorrer,
    contate o nosso suporte. |
  version: 1.0.0
servers: []
security: []
paths:
  /plans/{planId}/quotation:
    get:
      summary: Cota um único plano
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
          example: application/json
        - name: model_id
          in: query
          required: false
          schema:
            type: string
          example: '19'
        - name: is_used
          in: query
          required: false
          schema:
            type: string
          example: 'true'
      responses:
        '200':
          description: Quote of a single plan
          content:
            application/json:
              example:
                data:
                  plan:
                    id: 1
                    name: Proteção Clubfix
                  model:
                    id: 1
                    name: onetouch|5017A PIXI3 4.5 SS
                    brand:
                      id: 1
                      name: Alcatel
                      meta:
                        link: https://homolog.clubfix.com.br/webservice/brands/1
                    meta:
                      link: https://homolog.clubfix.com.br/webservice/models/1
                  maxima: 499
                  total_premium: 7.04
                  total_premium_with_discount: 7.04
                  device_is_used: true
                  franchise: 84.83
                meta:
                  link: >-
                    https://homolog.clubfix.com.br/webservice/plans/1/quotation?model_id=1&is_used=1
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      plan:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                      model:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          brand:
                            type: object
                            properties:
                              id:
                                type: integer
                              name:
                                type: string
                              meta:
                                type: object
                                properties:
                                  link:
                                    type: string
                          meta:
                            type: object
                            properties:
                              link:
                                type: string
                      maxima:
                        type: integer
                      total_premium:
                        type: number
                      total_premium_with_discount:
                        type: number
                      device_is_used:
                        type: integer
                      franchise:
                        type: number
                  meta:
                    type: object
                    properties:
                      link:
                        type: string

````