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

# Listar Planos de Assinatura

> Retorna os planos de assinatura disponíveis para o parceiro autenticado

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

<ParamField query="page" type="integer">
  Número da página para paginação. Padrão: `1`.
</ParamField>

<ParamField query="per_page" type="integer">
  Quantidade de itens por página. Padrão: `15`.
</ParamField>

## Resposta

Retorna os planos disponíveis para o parceiro. Cada plano inclui:

| Campo          | Tipo    | Descrição                                                                       |
| -------------- | ------- | ------------------------------------------------------------------------------- |
| `id`           | integer | Identificador do plano. Usar como `plan_id` na contratação e cotação individual |
| `name`         | string  | Nome do plano                                                                   |
| `installments` | integer | Número de parcelas do plano (ex: `12`)                                          |

<Note>
  Os planos disponíveis são configurados pelo time ClubFix conforme o contrato do parceiro. Cada parceiro pode ter acesso a diferentes planos.
</Note>


## OpenAPI

````yaml GET /plans
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:
    get:
      summary: Listagem dos Planos
      parameters:
        - name: Accept
          in: header
          required: true
          schema:
            type: string
          example: application/json
        - name: page
          in: query
          required: false
          schema:
            type: string
          example: '1'
      responses:
        '200':
          description: List Plans Response
          content:
            application/json:
              example:
                data:
                  - id: 1
                    name: Proteção Clubfix
                    coverages:
                      - Quebra de Tela
                      - Danos Líquidos
                      - Oxidação
                      - Alto Falantes
                      - Microfone
                      - Danos Internos
                      - Conector de Carga
                      - Wi-Fi/Sinal
                  - id: 2
                    name: PROTEÇÃO TOTAL + SIGA-ME
                    coverages:
                      - Roubo e Furto Qualificado
                      - Quebra de Tela
                      - Danos Líquidos
                      - Oxidação
                      - Alto Falantes
                      - Microfone
                      - Danos Internos
                      - Conector de Carga
                      - Wi-Fi/Sinal
                links:
                  first: https://homolog.clubfix.com.br/webservice/plans?page=1
                  last: https://homolog.clubfix.com.br/webservice/plans?page=1
                  prev: null
                  next: null
                meta:
                  current_page: 1
                  from: 1
                  last_page: 1
                  links:
                    - url: null
                      label: '&laquo; Anterior'
                      active: false
                    - url: https://homolog.clubfix.com.br/webservice/plans?page=1
                      label: '1'
                      active: true
                    - url: null
                      label: Próxima &raquo;
                      active: false
                  path: https://homolog.clubfix.com.br/webservice/plans
                  per_page: 15
                  to: 2
                  total: 2
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        name:
                          type: string
                        coverages:
                          type: array
                          items:
                            type: string
                  links:
                    type: object
                    properties:
                      first:
                        type: string
                      last:
                        type: string
                      prev:
                        type: string
                      next:
                        type: string
                  meta:
                    type: object
                    properties:
                      current_page:
                        type: integer
                      from:
                        type: integer
                      last_page:
                        type: integer
                      links:
                        type: array
                        items:
                          type: object
                          properties:
                            url:
                              type: string
                            label:
                              type: string
                            active:
                              type: integer
                      path:
                        type: string
                      per_page:
                        type: integer
                      to:
                        type: integer
                      total:
                        type: integer

````