Referencia de APIGET

Previsualizar facturación de palabras clave

Previsualiza el plan y precio para una cantidad deseada de palabras clave activas.

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

Previsualiza el plan y precio para una cantidad deseada de palabras clave activas.

Token Bearer (token de API de RedReplier)

Parámetros

  • desiredKeywordCount (consulta, entero, obligatorio, mínimo 0): Cantidad total deseada de palabras clave activas.

Cuerpo de la solicitud

Este endpoint no requiere un cuerpo JSON.

Respuesta

Devuelve una vista previa de facturación de palabras clave.

  • currentPlanName (string | null): Nombre del plan actual, o null si no hay uno activo.
  • currentMonthlyPrice (number): Precio mensual actual.
  • targetPlanName (string | null): Plan necesario para la cantidad de palabras clave solicitada, o null si no se requiere cambio.
  • targetMonthlyPrice (number): Precio mensual después del cambio.
  • immediateCharge (number): Cargo inmediato prorrateado para el periodo de facturación actual.
  • targetKeywords (number): Cantidad objetivo de palabras clave activas.
  • isUpgrade, isDowngrade, requiresImmediatePayment (boolean): Indicadores del cambio de facturación.

Notas

Solo lectura: la API nunca cambia la suscripción. Los cambios de plan se hacen en la app de RedReplier.

Errores

  • 400 Bad Request: Entrada, URL, UUID, enum, parámetro de consulta o cuerpo no válido.
  • 401 Unauthorized: Bearer token ausente o no válido, o code: "token_issuer_lost_access" cuando la persona que creó la clave API fue desactivada o salió del workspace.
  • 403 Forbidden: code: "subscription_required" cuando el plan del workspace no incluye acceso a la API, code: "workspace_access_denied" cuando X-Workspace-Id indica un workspace al que esta credencial no puede acceder, o code: "permission_denied" cuando tu rol en el workspace no tiene el permiso redreplier.write (lo tienen Admin y Editor).
  • 404 Not Found: El recurso no existe para la cuenta del token.
  • 429 Too Many Requests: Límite de solicitudes superado. Espera los segundos indicados en Retry-After.
  • 500 Internal Server Error: Error inesperado del servidor.
Solicitud de ejemplo (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
}