Fluxo de criação de Planos

Título do Fluxo: Fluxo de Criação de Planos

Este diagrama mostra o processo de criação de planos na plataforma Vindi. Abaixo está a descrição detalhada de cada passo no fluxo, incluindo métodos de autenticação, endpoints e exemplos de parâmetros para requisições.

1. Buscar Listagem de Planos

Método: GET
Endpoint: /v1/plans
Descrição: Busca a listagem de planos existentes e verifica se o plano solicitado já existe.
Exemplo de Parâmetros:

GET /v1/plans

2. Verificar Existência do Plano

Descrição: O sistema verifica se o plano solicitado já existe na listagem retornada.

Caso 1: Plano Existente

3. Armazenar Código do Plano

Descrição: Se o plano já existir, o sistema armazena o código do plano para uso em próximas requisições.
Notas: O código do plano é armazenado em informações internas.

Caso 2: Plano Inexistente

4. Cadastro do Plano

4.1 Plano com Produtos Fixos

Método: POST
Endpoint: /v1/plans
Descrição: Realiza o cadastro do plano com produtos vinculados com periodicidade de cobrança em "billing_trigger_type" e produtos fixos já configurados com valores em "plan_items.product_id".
Exemplo de Parâmetros:

{
  "name": "Plano Teste",
  "billing_trigger_type": "monthly",
  "plan_items": [
    {
      "product_id": 12345,
      "quantity": 1
    }
  ]
}

Retorno: O sistema retorna o resultado da requisição e armazena o código do plano.

4.2 Plano sem Produtos Fixos

Método: POST
Endpoint: /v1/plans
Descrição: Realiza o cadastro do plano sem produtos vinculados com periodicidade de cobrança em "billing_trigger_type" sem produtos cadastrados (não inserir array de plan items).
Exemplo de Parâmetros:

{
  "name": "Plano Teste",
  "billing_trigger_type": "monthly"
}

Retorno: O sistema retorna o resultado da requisição e armazena o código do plano.

Notas Adicionais

Plano com Produtos Fixos: Usado quando os produtos e seus valores já estão configurados.
Plano sem Produtos Fixos: Usado quando a empresa possui muita variação de valores em planos. Na montagem da assinatura, os produtos podem ser inseridos e precificados conforme necessidades.

Resumo das Requisições:

Buscar Listagem de Planos:
- Método: GET
- Endpoint: /v1/plans
- Exemplo de Parâmetros:
```
GET /v1/plans
```

Cadastro do Plano com Produtos Fixos:

Método: POST
Endpoint: /v1/plans

Exemplo de Parâmetros:

{
  "name": "Plano Teste",
  "billing_trigger_type": "monthly",
  "plan_items": [
    {
      "product_id": 12345,
      "quantity": 1
    }
  ]
}

Cadastro do Plano sem Produtos Fixos:
- Método: POST
- Endpoint: /v1/plans
- Exemplo de Parâmetros:
```
{
  "name": "Plano Teste",
  "billing_trigger_type": "monthly"
}
```

Estas descrições ajudam a entender como realizar a atividade de criação de planos, conforme ilustrado no diagrama.