Prever ativação de palavras-chave pendentes

Parâmetros

Este endpoint não aceita parâmetros de caminho nem de consulta.

Corpo da requisição

Este endpoint não exige um corpo JSON.

Resposta

Retorna uma prévia de cobrança de palavras-chave.

• currentPlanName (string | null): Nome do plano atual, ou null se nenhum estiver ativo.
• currentMonthlyPrice (number): Preço mensal atual.
• targetPlanName (string | null): Plano necessário para a quantidade de palavras-chave solicitada, ou null se nenhuma alteração for necessária.
• targetMonthlyPrice (number): Preço mensal após a alteração.
• immediateCharge (number): Cobrança imediata proporcional para o período de cobrança atual.
• targetKeywords (number): Quantidade alvo de palavras-chave ativas.
• isUpgrade, isDowngrade, requiresImmediatePayment (boolean): Indicadores da alteração de cobrança.

Notas

Somente leitura. A API não faz upgrade do plano: faça a mudança no app do RedReplier e depois chame Ativar palavras-chave pendentes ou GET /websites para ativar o que agora cabe.

Erros

• 400 Bad Request: Entrada, URL, UUID, enum, parâmetro de consulta ou corpo inválido.
• 401 Unauthorized: Bearer token ausente ou inválido, ou code: "token_issuer_lost_access" quando a pessoa que criou a chave API foi desativada ou saiu do workspace.
• 403 Forbidden: code: "subscription_required" quando o plano do workspace não inclui acesso à API, code: "workspace_access_denied" quando X-Workspace-Id indica um workspace que esta credencial não pode alcançar, ou code: "permission_denied" quando seu papel no workspace não tem a permissão redreplier.write (Admin e Editor têm).
• 404 Not Found: O recurso não existe para a conta do token.
• 429 Too Many Requests: Limite de requisições excedido. Aguarde os segundos indicados em Retry-After.
• 500 Internal Server Error: Erro inesperado do servidor.