88API88API
User GuideAI ApplicationsAPI ReferenceHelp & Support
API Module Guide

Module de tableau de bord de facturation du compte

Description des fonctionnalités

Le préfixe de l'API est uniformément http(s)://<your-domain>

HTTPS doit être utilisé dans les environnements de production pour sécuriser les jetons d'authentification. HTTP n'est recommandé que pour les environnements de développement.

Interface de requête de facturation compatible OpenAI SDK. Utilise l'authentification par jeton pour fournir des informations d'abonnement et des requêtes d'utilisation. Principalement destiné aux applications tierces et à l'intégration de SDK, garantissant une compatibilité totale avec l'API OpenAI.

🔐 Authentification de l'utilisateur

Récupérer les informations sur le quota d'abonnement

  • Nom de l'interface: récupérer les informations sur le quota d'abonnement
  • Méthode HTTP: GET
  • Chemin: /dashboard/billing/subscription
  • Authentification requise: jeton utilisateur
  • Description de la fonction: récupère les informations sur le quota d'abonnement de l'utilisateur, y compris le quota total, la limite stricte et la période de validité d'accès, compatible avec le format API OpenAI

💡 Exemple de demande:

const response = await fetch('/dashboard/billing/subscription', {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer your_user_token',
    'New-Api-User': 'your_user_id'
  }
});
const data = await response.json();

✅ Exemple de réponse réussie:

{
  "object": "billing_subscription",
  "has_payment_method": true,
  "soft_limit_usd": 100.0,
  "hard_limit_usd": 100.0,
  "system_hard_limit_usd": 100.0,
  "access_until": 1640995200
}

❗ Exemple de réponse échouée:

{
  "error": {
    "message": "Failed to obtain quota",
    "type": "upstream_error"
  }
}

🧾 Description du champ:

  • object (String) : Valeur fixe "billing_subscription"
  • has_payment_method (Booléen): Indique si un mode de paiement existe, fixé à true
  • soft_limit_usd (Nombre): quota de limite souple (USD)
  • hard_limit_usd (Nombre): quota de limite stricte (USD)
  • system_hard_limit_usd (Nombre): quota de limite stricte du système (USD)
  • access_until (Numéro) : Horodatage de validité d'accès, Heure d'expiration du Token

Chemin compatible avec le SDK OpenAI - Récupérer les informations sur le quota d'abonnement

  • Nom de l'interface: Chemin compatible avec le SDK OpenAI - Récupérer les informations sur le quota d'abonnement
  • Méthode HTTP: GET
  • Chemin: /v1/dashboard/billing/subscription
  • Authentification requise: jeton utilisateur
  • Description de la fonction: fonctionnellement identique à l'interface ci-dessus, fournissant un chemin compatible avec le SDK OpenAI

💡 Exemple de demande:

const response = await fetch('/v1/dashboard/billing/subscription', {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer your_user_token',
    'New-Api-User': 'your_user_id'
  }
});
const data = await response.json();

✅ Exemple de réponse réussie:

{
  "object": "billing_subscription",
  "has_payment_method": true,
  "soft_limit_usd": 100.0,
  "hard_limit_usd": 100.0,
  "system_hard_limit_usd": 100.0,
  "access_until": 1640995200
}

❗ Exemple de réponse échouée:

{
  "error": {
    "message": "Failed to obtain quota",
    "type": "upstream_error"
  }
}

🧾 Description du champ:

  • object (String) : Valeur fixe "billing_subscription"
  • has_payment_method (Booléen): Indique si un mode de paiement existe, fixé à true
  • soft_limit_usd (Nombre): quota de limite souple (USD)
  • hard_limit_usd (Nombre): quota de limite stricte (USD)
  • system_hard_limit_usd (Nombre): quota de limite stricte du système (USD)
  • access_until (Numéro) : Horodatage de validité d'accès, Heure d'expiration du Token

Récupérer les informations d'utilisation

  • Nom de l'interface: récupérer les informations d'utilisation
  • Méthode HTTP: GET
  • Chemin: /dashboard/billing/usage
  • Authentification requise: jeton utilisateur
  • Description de la fonction: Récupère les informations d'utilisation du quota de l'utilisateur, compatible avec le format API OpenAI

💡 Exemple de demande:

const response = await fetch('/dashboard/billing/usage', {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer your_user_token',
    'New-Api-User': 'your_user_id'
  }
});
const data = await response.json();

✅ Exemple de réponse réussie:

{
  "object": "list",
  "total_usage": 2500.0
}

❗ Exemple de réponse échouée:

{
  "error": {
    "message": "Failed to get usage",
    "type": "new_api_error"
  }
}

🧾 Description du champ:

  • object (String) : valeur fixe "liste"
  • total_usage (Nombre): utilisation totale, mesurée en unités de 0,01 USD

Chemin compatible avec le SDK OpenAI - Récupérer les informations d'utilisation

  • Nom de l'interface: Chemin compatible avec le SDK OpenAI - Récupérer les informations d'utilisation
  • Méthode HTTP: GET
  • Chemin: /v1/dashboard/billing/usage
  • Authentification requise: jeton utilisateur
  • Description de la fonction: fonctionnellement identique à l'interface ci-dessus, fournissant un chemin compatible avec le SDK OpenAI

💡 Exemple de demande:

const response = await fetch('/v1/dashboard/billing/usage', {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer your_user_token',
    'New-Api-User': 'your_user_id'
  }
});
const data = await response.json();

✅ Exemple de réponse réussie:

{
  "object": "list",
  "total_usage": 2500.0
}

❗ Exemple de réponse échouée:

{
  "error": {
    "message": "Failed to get usage",
    "type": "new_api_error"
  }
}

🧾 Description du champ:

  • object (String) : valeur fixe "liste"
  • total_usage (Nombre): utilisation totale, mesurée en unités de 0,01 USD