Dokumentacja APIGET

Podgląd rozliczenia słów kluczowych

Sprawdź plan i cenę miesięczną dla wybranej liczby aktywnych słów kluczowych. Tylko odczyt: API nigdy nie zmienia planu ani niczego nie nalicza.

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

Sprawdź plan i cenę miesięczną dla wybranej liczby aktywnych słów kluczowych. Tylko odczyt: API nigdy nie zmienia planu ani niczego nie nalicza.

Token Bearer (token API RedReplier)

Uwierzytelnianie

Wysyłaj token API RedReplier jako token Bearer w każdym żądaniu. Tokeny zaczynają się od redreplier_; RedReplier ustala konto na podstawie tokena. Wyślij X-Workspace-Id, aby działać w obszarze roboczym innym niż domyślny; zobacz Lista obszarów roboczych.

Authorization: Bearer redreplier_test_1234567890
Content-Type: application/json

Parametry

  • desiredKeywordCount (zapytanie, integer, wymagany, min. 0): Docelowa łączna liczba aktywnych słów kluczowych.

Treść żądania

Ten endpoint nie wymaga treści JSON.

Odpowiedź

Zwraca podgląd rozliczenia słów kluczowych.

  • currentPlanName (string | null): Nazwa obecnego planu lub null, gdy żaden nie jest aktywny.
  • currentMonthlyPrice (number): Obecna cena miesięczna.
  • targetPlanName (string | null): Plan potrzebny dla żądanej liczby słów kluczowych lub null, gdy zmiana nie jest potrzebna.
  • targetMonthlyPrice (number): Cena miesięczna po zmianie.
  • immediateCharge (number): Proporcjonalna opłata natychmiastowa za bieżący okres rozliczeniowy.
  • targetKeywords (number): Docelowa liczba aktywnych słów kluczowych.
  • isUpgrade, isDowngrade, requiresImmediatePayment (boolean): Flagi zmiany rozliczenia.

Przykładowe żądanie

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

Uwagi

Tylko odczyt: API nigdy nie zmienia subskrypcji. Plan zmienia się w aplikacji RedReplier.

Błędy

  • 400 Bad Request: Nieprawidłowe dane wejściowe, URL, UUID, wartość enum, parametr zapytania lub treść żądania.
  • 401 Unauthorized: Brak tokena Bearer lub nieprawidłowy token albo code: "token_issuer_lost_access", gdy osoba, która utworzyła klucz API, została dezaktywowana lub opuściła obszar roboczy.
  • 403 Forbidden: code: "subscription_required", gdy plan obszaru roboczego nie obejmuje dostępu do API, code: "workspace_access_denied", gdy X-Workspace-Id wskazuje obszar roboczy niedostępny dla tych poświadczeń, lub code: "permission_denied", gdy twoja rola w obszarze roboczym nie ma uprawnienia redreplier.write (mają je Administrator i Edytor).
  • 404 Not Found: Zasób nie istnieje dla konta powiązanego z tokenem.
  • 429 Too Many Requests: Przekroczono limit żądań. Odczekaj liczbę sekund podaną w Retry-After.
  • 500 Internal Server Error: Nieoczekiwany błąd serwera.
Przykładowe żądanie (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
}