Utilisation et solde de crédit

Dernière mise à jour July 20, 2026

Consultez votre utilisation de l'API depuis le début du mois et votre solde de crédit actuel.

TEXT

GET /v1/usage

Requiert une clé d'API valide et un abonnement actif. Contrairement aux endpoints de recherche, celui-ci n'est pas conditionné par le crédit — vous pouvez toujours consulter votre solde, même lorsqu'il est vide — et il ne consomme pas de crédit.

Paramètres de requête

Aucun.

Réponse

JSON

{
  "period_start": "2026-06-01T00:00:00Z",
  "requests": 1284,
  "billable_units": 1310,
  "credits": {
    "balance_cents": 4250,
    "balance": 42.50,
    "currency": "usd",
    "included_cents": 0,
    "purchased_cents": 4250,
    "estimated_requests_remaining": 2125,
    "auto_reload_enabled": true
  }
}

Champ	Type	Description
`period_start`	string (ISO 8601, UTC)	Début de la période d'utilisation du mois civil en cours.
`requests`	integer	Requêtes à l'API enregistrées jusqu'à présent dans cette période.
`billable_units`	integer	Unités facturables consommées dans cette période (une requête peut facturer plus d'une unité lorsqu'elle se déploie en plusieurs récupérations en amont).
`credits.balance_cents`	integer	Solde total restant, en unités monétaires mineures.
`credits.balance`	number	Solde total restant, en unités majeures.
`credits.currency`	string	Code de devise ISO (p. ex. `USD`, `GBP`).
`credits.included_cents`	integer	Solde restant de l'allocation mensuelle de votre abonnement.
`credits.purchased_cents`	integer	Solde restant du crédit que vous avez acheté.
`credits.estimated_requests_remaining`	integer	Nombre approximatif de requêtes supplémentaires que votre solde couvre.
`credits.auto_reload_enabled`	boolean	Indique si la recharge automatique est activée pour votre compte.

Exemples

cURL

curl "https://api.suede.io/v1/usage" \
  -H "Authorization: Bearer $SUEDE_API_KEY"

using var http = new HttpClient();
http.DefaultRequestHeaders.Authorization =
    new("Bearer", Environment.GetEnvironmentVariable("SUEDE_API_KEY"));
var json = await http.GetStringAsync("https://api.suede.io/v1/usage");
Console.WriteLine(json);

JavaScript

const res = await fetch("https://api.suede.io/v1/usage", {
  headers: { Authorization: `Bearer ${process.env.SUEDE_API_KEY}` },
});
const usage = await res.json();
console.log(`Balance: ${usage.credits.balance} ${usage.credits.currency}`);

Le même solde est renvoyé à chaque réponse facturable via les en-têtes X-Credits-Balance et X-Credits-Requests-Remaining — consultez Erreurs.