Utilisation
Surveillez votre quota API, vos crédits extra et l'état de votre compte en temps réel.
L'endpoint Usage retourne votre quota API restant, vos crédits extra, vos limites de débit et les détails de votre clé API à tout moment. Il ne consomme aucun crédit.
Note : l'objet subscription reflète le quota API combiné (abonnement + top-ups restants), pas la part abonnement seule. Le tableau de bord affiche le détail Abonnement / Top-ups.
Cet endpoint est gratuit. Il ne consomme jamais aucun crédit.
Requête
curl "https://api.piloterr.com/v2/usage" \
-H "x-api-key: YOUR_API_KEY"Champs de réponse
| Champ | Type | Description |
|---|---|---|
remaining | integer | Total de crédits disponibles (quota API + crédits extra) |
total_used | integer | Total de crédits consommés à ce jour (quota API + extra ; la consommation top-up persiste entre périodes) |
renewal_date | string | Date de renouvellement de l'abonnement (ISO 8601) |
period.start | string | Début de la période de facturation actuelle |
period.end | string | Fin de la période de facturation actuelle |
subscription.used | integer | Appels API utilisés sur le quota API combiné |
subscription.total | integer | Plafond du quota API combiné (abonnement + top-ups) |
subscription.remaining | integer | Quota API combiné restant (part abonnement + top-ups non consommés) |
subscription.percent_used | number | Pourcentage du quota API consommé |
credits.given | integer | Crédits extra accordés (solde séparé) |
credits.consumed | integer | Crédits extra consommés |
credits.remaining | integer | Crédits extra restants |
rate_limit.per_minute | integer | null | Limite de requêtes par minute (null = illimité) |
rate_limit.per_second | integer | null | Limite de requêtes par seconde (null = illimité) |
account.name | string | Nom du compte |
account.slug | string | Identifiant du compte |
api_key.alias | string | Nom convivial de la clé API |
api_key.active | boolean | Si la clé est actuellement active |
api_key.category | string | Catégorie de la clé (ex. development, production) |
api_key.expires | string | null | Date d'expiration de la clé (null = n'expire jamais) |
api_key.quotas | object | Quotas personnalisés par clé : total, daily, weekly, monthly |
Exemple de réponse
{
"remaining": 450,
"total_used": 1550,
"renewal_date": "2026-04-25",
"period": {
"start": "2026-03-25",
"end": "2026-04-25"
},
"subscription": {
"used": 1550,
"total": 2000,
"remaining": 450,
"percent_used": 77
},
"credits": {
"given": 0,
"consumed": 0,
"remaining": 0,
"percent_used": 0
},
"rate_limit": {
"per_minute": null,
"per_second": null
},
"account": {
"name": "Acme Corp",
"slug": "acme-corp"
},
"api_key": {
"alias": "production",
"active": true,
"category": "production",
"expires": null,
"quotas": {
"total": null,
"daily": null,
"weekly": null,
"monthly": null
}
}
}