Alterar plano de um usuário

Esse endpoint permite que o plano de um usuário seja alterado.

Pré-requisitos

Para que seja possível utilizar este endpoint, é necessário que:

O usuário esteja utilizando a Autenticação Gestão do Banco.

Requisição (Request)

Requisição HTTP

PUT https://sandbox.hiperbanco.com.br/plans/{accountId}

--request PUT 'https://sandbox.hiperbanco.com.br/plans/{accountId}' \
--header 'version: cutting-edge' \
--header 'Authorization: Bearer {{token}}' \
--data-raw '{
   "newPlanId": "f65b4009-ac7a-41fb-919f-cb2cd8dcecd4"
}'

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 / Query)

Nome	Tipo	Descrição
`accountId`	`path`	Id da conta do usuário.

Corpo da requisição (Body)

No body, envie os seguintes campos em formato JSON:

Nome	Tipo	Descrição
`newPlanId`	`string`	Obrigatório. Id do novo plano do usuário.

{
    "newPlanId": "0accbb77-208b-4e6e-9a67-9d875442d7e1"
}

Resposta (Response)

O status code 200 indicará sucesso na requisição.

⚠️
Importante
Ao mudar de plano, a alteração só entra em vigor no fim do ciclo vigente. Até lá, sua conta permanece no plano atual.

Erros

Este endpoint pode retornar erros específicos, conforme a tabela a seguir:

Status code	Código	Mensagem	Descrição
`404`	`PLAN_NOT_FOUND`	Plan not found with ID	Plano não encontrado.
`422`	`PLAN_UNAVAILABLE_FOR_UPDATE`	It's not possible to change account's plan wheather the plan is unavailable.	Não é possível alterar o plano da conta quando o plano não está disponível.
`422`	`PLAN_UNAVAILABLE_FOR_UPDATE_DO_TO_DEBT`	It's not possible to change account's plan wheather there are remaining invoices to pay of its current plan.	Não é possível alterar o plano da conta se houver faturas restantes a pagar do plano atual.
`422`	`INVALID_PLAN_CHANGE`	You cannot change to the current plan. Please select a different plan to proceed.	Você não pode mudar para o plano atual. Selecione um plano diferente para prosseguir.
`422`	`ACCOUNT_PLAN_MISMATCH`	The plan assigned is intended for `accountType` accounts, but the account is a `accountType` account.	O plano atribuído é destinado a contas `accountType`, mas a conta é uma conta `accountType`.

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.