Solde de crédits

Consultez votre solde de crédits disponible pour gérer votre utilisation et éviter l'échec des tâches.

GET/api/v1/balance

Implémentation rapide

curl -X GET https://api.srtgen.com/api/v1/balance \
  -H "x-api-key: <YOUR_API_KEY>"

GEThttps://api.srtgen.com/api/v1/balance

Ce point de terminaison renvoie le solde total utilisable, qui comprend à la fois vos allocations d'abonnement mensuel et tous les crédits de recharge supplémentaires que vous avez achetés.

Structure de la réponse

Paramètre	Type	Requis
Identité & Contexte
`user`	Objet	Informations de base sur l'utilisateur authentifié.
`user.name`	Type	Le nom d'affichage de l'utilisateur.
`user.email`	Type	L'adresse email enregistrée.
Détail du solde de crédits
`credits`	Objet	Répartition détaillée du solde de crédits.
`credits.totalBalance`	Number	Somme de tous les crédits utilisables (Allocations + Extras).
`credits.extraCredits`	Number	Crédits de recharge permanents.
`credits.plans`	Array	Liste des forfaits d'abonnement actifs.
`plans[].name`	Type	Nom d'affichage du forfait (ex : 'Pro Plan').
`plans[].status`	Type	Statut de l'abonnement (active, past_due).
`plans[].balance`	Number	Crédits restants pour ce cycle spécifique.
Utilisation du stockage cloud
`storage`	Objet	Statistiques d'utilisation du stockage cloud.
`storage.usage`	Number	Utilisation actuelle du stockage en octets.
`storage.limit`	Number	Limite maximale de stockage en octets basée sur votre forfait.
`storage.formattedUsage`	Type	Utilisation lisible (ex : '200 Mo').
`storage.formattedLimit`	Type	Limite lisible (ex : '10 Go').

Exemple de réponse : 200 OK

{
  "success": true,
  "user": {
    "name": "Alex Rivera",
    "email": "[email protected]"
  },
  "credits": {
    "totalBalance": 1250,
    "totalMonthlyCredits": 1000,
    "extraCredits": 250,
    "plans": [
      {
        "id": "starter",
        "name": "Starter Plan",
        "status": "active",
        "balance": 1000,
        "total": 1000,
        "resetTime": "2026-04-29T17:48:46.000Z"
      }
    ]
  },
  "storage": {
    "usage": 209715200,
    "limit": 10737418240,
    "formattedUsage": "200 MB",
    "formattedLimit": "10 GB"
  },
  "updatedAt": "2026-03-29T17:48:46.000Z"
}

Erreurs

Statut	Code d'erreur	Description
401	unauthorized	La clé API est manquante ou invalide.
500	server_error	Une erreur interne inattendue est survenue.

Cette page vous a-t-elle été utile ?