Referência da APIGET

Prever cobrança de palavras-chave

Prevê o plano e o preço para uma quantidade desejada de palavras-chave ativas.

GEThttps://ai.redreplier.com/ai-app/api/v1/keywords/billing-preview

Prevê o plano e o preço para uma quantidade desejada de palavras-chave ativas.

Token Bearer (token de API do RedReplier)

Autenticação

Envie um token de API do RedReplier como Bearer token em cada requisição. Os tokens começam com redreplier_; o RedReplier resolve a conta a partir do token.

Authorization: Bearer redreplier_test_1234567890
Content-Type: application/json

Parâmetros

  • desiredKeywordCount (consulta, inteiro, obrigatório, mínimo 0): Quantidade total desejada de palavras-chave ativas.

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.

Exemplo de requisição

curl -s 'https://ai.redreplier.com/ai-app/api/v1/keywords/billing-preview?desiredKeywordCount=12' \
  -H 'Authorization: Bearer redreplier_test_1234567890'

Notas

Este endpoint não altera a assinatura.

Erros

  • 400 Bad Request: Entrada, URL, UUID, enum, parâmetro de consulta ou corpo inválido.
  • 401 Unauthorized: Bearer token ausente ou inválido.
  • 404 Not Found: O recurso não existe para a conta do token.
  • 500 Internal Server Error: Erro inesperado do servidor.
Exemplo de solicitação (curl)
curl --request GET \
  --url https://ai.redreplier.com/ai-app/api/v1/keywords/billing-preview?desiredKeywordCount=25 \
  --header 'Authorization: Bearer redreplier_test_1234567890'
200
{
  "currentPlanName": "Starter",
  "currentMonthlyPrice": 49,
  "targetPlanName": "Growth",
  "targetMonthlyPrice": 99,
  "immediateCharge": 18.42,
  "targetKeywords": 25,
  "isUpgrade": true,
  "isDowngrade": false,
  "requiresImmediatePayment": true
}