API-ReferenzGET

Keyword-Abrechnung vorab prüfen

Prüft Tarif und Preis für eine gewünschte Anzahl aktiver Keywords vorab.

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

Prüft Tarif und Preis für eine gewünschte Anzahl aktiver Keywords vorab.

Bearer-Token (RedReplier-API-Token)

Parameter

  • desiredKeywordCount (Query, Integer, erforderlich, min. 0): Gewünschte Gesamtzahl aktiver Keywords.

Request-Body

Dieser Endpoint benötigt keinen JSON-Body.

Antwort

Gibt eine Keyword-Abrechnungsvorschau zurück.

  • currentPlanName (string | null): Aktueller Tarifname oder null, wenn keiner aktiv ist.
  • currentMonthlyPrice (number): Aktueller monatlicher Preis.
  • targetPlanName (string | null): Tarif für die angeforderte Keyword-Anzahl oder null, wenn keine Änderung nötig ist.
  • targetMonthlyPrice (number): Monatlicher Preis nach der Änderung.
  • immediateCharge (number): Anteilig sofort fälliger Betrag für die aktuelle Abrechnungsperiode.
  • targetKeywords (number): Zielanzahl aktiver Keywords.
  • isUpgrade, isDowngrade, requiresImmediatePayment (boolean): Flags für die Abrechnungsänderung.

Hinweise

Nur lesend: Die API ändert das Abonnement nie. Tarifänderungen erfolgen in der RedReplier-App.

Fehler

  • 400 Bad Request: Ungültige Eingabe, URL, UUID, Enum, Query-Parameter oder Body.
  • 401 Unauthorized: Fehlendes oder ungültiges Bearer-Token, oder code: "token_issuer_lost_access", wenn die Person, die den API-Schlüssel erstellt hat, deaktiviert wurde oder den Workspace verlassen hat.
  • 403 Forbidden: code: "subscription_required", wenn der Tarif des Workspace keinen API-Zugang enthält, code: "workspace_access_denied", wenn X-Workspace-Id einen Workspace nennt, den diese Zugangsdaten nicht erreichen, oder code: "permission_denied", wenn Ihre Rolle im Workspace die Berechtigung redreplier.write nicht hat (Admin und Editor haben sie).
  • 404 Not Found: Die Ressource existiert nicht für das Token-Konto.
  • 429 Too Many Requests: Rate-Limit überschritten. Warten Sie die Sekunden aus Retry-After ab.
  • 500 Internal Server Error: Unerwarteter Serverfehler.
Beispielanfrage (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
}