Remover um plano

Esse endpoint possibilita a remoção de um plano.

Requisição(Request)

Requisição HTTP

DELETE https://sandbox.hiperbanco.com.br/plans/{id}

--request DELETE 'https://sandbox.hiperbanco.com.br/plans/{id}' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}'

Cabeçalhos (Headers)

Nome	Propriedade	Descrição
`version`	`cutting-edge`	Essa propriedade garante que o response da API seja retornado no formato JSON
`Authorization`	`Bearer token`	Obrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

Nome	Tipo	Descrição
`id`	`path`	Identificador do plano

Corpo da requisição (Body)

Não é necessário enviar parâmetros no body desta requisição.

Resposta (Response)

O status code 200 indicará que a requisição foi feita com sucesso.

Erros

Status code	Código	Mensagem	Descrição
`400`	`BAD_REQUEST`	This plan has active users, it is not possible to delete it	Esse plano possui usuários ativos, não é possível deletá-lo
`404`	`PLAN_NOT_FOUND`	Plan not found with ID	Plano não encontrado
`500`	`INTERNAL_SERVER_ERROR`	Standard Plan cannot be removed	Plano Padrão não pode ser removido

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints que acompanham os erros 400 (se houver).

Eventos

Este endpoint não possui eventos relacionados a ele.