Référence de l'APIGET

Prévisualiser la facturation des mots-clés

Prévisualise l’abonnement et le prix pour un nombre souhaité de mots-clés actifs.

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

Prévisualise l’abonnement et le prix pour un nombre souhaité de mots-clés actifs.

Jeton Bearer (jeton API RedReplier)

Paramètres

  • desiredKeywordCount (requête, entier, requis, min 0): Nombre total souhaité de mots-clés actifs.

Corps de la requête

Cet endpoint ne nécessite aucun corps JSON.

Réponse

Renvoie un aperçu de facturation des mots-clés.

  • currentPlanName (string | null): Nom de l’abonnement actuel, ou null s’il n’y en a pas.
  • currentMonthlyPrice (number): Prix mensuel actuel.
  • targetPlanName (string | null): Abonnement nécessaire pour le nombre de mots-clés demandé, ou null si aucun changement n’est nécessaire.
  • targetMonthlyPrice (number): Prix mensuel après le changement.
  • immediateCharge (number): Montant immédiat proratisé pour la période de facturation en cours.
  • targetKeywords (number): Nombre cible de mots-clés actifs.
  • isUpgrade, isDowngrade, requiresImmediatePayment (boolean): Indicateurs du changement de facturation.

Notes

Lecture seule: l'API ne modifie jamais l'abonnement. Les changements d'abonnement se font dans l'application RedReplier.

Erreurs

  • 400 Bad Request: Entrée, URL, UUID, enum, paramètre de requête ou corps non valide.
  • 401 Unauthorized: Bearer token manquant ou non valide, ou code: "token_issuer_lost_access" quand la personne qui a créé la clé API a été désactivée ou a quitté l'espace de travail.
  • 403 Forbidden: code: "subscription_required" quand l'abonnement de l'espace de travail n'inclut pas l'accès à l'API, code: "workspace_access_denied" quand X-Workspace-Id désigne un espace de travail que ces identifiants ne peuvent pas atteindre, ou code: "permission_denied" quand votre rôle dans l'espace de travail n'a pas la permission redreplier.write (Admin et Editor l'ont).
  • 404 Not Found: La ressource n’existe pas pour le compte du token.
  • 429 Too Many Requests: Limite de débit dépassée. Attendez le nombre de secondes indiqué dans Retry-After.
  • 500 Internal Server Error: Erreur serveur inattendue.
Exemple de requête (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
}