API referenceGET

Preview pending keyword activation

Preview the billing impact of activating pending keywords, including the target plan and any immediate charge.

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

Preview the billing impact of activating pending keywords, including the target plan and any immediate charge.

Bearer Token (RedReplier API token)

Parameters

This endpoint does not take path or query parameters.

Request body

This endpoint does not require a JSON body.

Response

Returns a keyword billing preview.

  • currentPlanName (string | null): Current plan name, or null when none is active.
  • currentMonthlyPrice (number): Current monthly price.
  • targetPlanName (string | null): Plan needed for the requested keyword count, or null when no change is needed.
  • targetMonthlyPrice (number): Monthly price after the change.
  • immediateCharge (number): Prorated immediate charge for the current billing period.
  • targetKeywords (number): Target active keyword count.
  • isUpgrade, isDowngrade, requiresImmediatePayment (boolean): Billing change flags.

Notes

This endpoint previews billing only; it does not activate keywords.

Errors

  • 400 Bad Request: Invalid input, URL, UUID, enum, query parameter, or body.
  • 401 Unauthorized: Missing or invalid Bearer token.
  • 404 Not Found: The resource does not exist for the token account.
  • 500 Internal Server Error: Unexpected server error.
Example request (curl)
curl --request GET \
  --url https://ai.redreplier.com/ai-app/api/v1/keywords/activate-pending/preview \
  --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
}