Модуль биллинговой панели аккаунта

В производственных средах следует использовать HTTPS, чтобы гарантировать токены аутентификации. HTTP рекомендуется только для сред разработки.

Интерфейс запросов на выставление счетов, совместимый с OpenAI SDK. Используйте аутентификацию по токену, чтобы предоставить информацию о подписке и запрос об использовании. В основном используется для сторонних приложений и интеграции SDK, обеспечивая полную совместимость с API OpenAI.

🔐 Аутентификация пользователя

Получить информацию о квоте подписки

• Имя интерфейса: получение информации о квоте подписки.
• Метод HTTP: GET
• Путь: /dashboard/billing/subscription
• Требования аутентификации: токен пользователя.
• Введение в функцию: получение информации о квоте подписки пользователя, включая общую квоту, жесткий лимит и период действия доступа, совместимую с форматом OpenAI API.

💡Пример запроса:

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();

✅ Пример успешного ответа:

{
  "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
}

❗ Пример реакции на ошибку:

{
  "error": {
    "message": "Не удалось получить квоту",
    "type": "upstream_error"
  }
}

🧾 Описание поля:

• object (строка): фиксированное значение "billing_subscription"
• object (логическое значение): существует ли способ оплаты, установлено значение true.
• object (число): сумма мягкого лимита (доллары США).
• object (число): жесткий лимит (доллары США).
• object (число): жесткий лимит системы (доллары США)
• object (число): временная метка срока действия доступа, срок действия токена.

Совместимость с путем OpenAI SDK — получение информации о квоте подписки

• Имя интерфейса: совместимо с путем OpenAI SDK. - Получение информации о квоте подписки.
• Метод HTTP: GET
• Путь: object
• Требования аутентификации: токен пользователя.
• Введение в функцию: функция точно такая же, как и интерфейс выше, обеспечивая путь, совместимый с OpenAI SDK.

💡Пример запроса:

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();

✅ Пример успешного ответа:

{
  "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
}

❗ Пример реакции на ошибку:

{
  "error": {
    "message": "Не удалось получить квоту",
    "type": "upstream_error"
  }
}

🧾 Описание поля:

• object (строка): фиксированное значение "billing_subscription"
• object (логическое значение): существует ли способ оплаты, установлено значение true.
• object (число): сумма мягкого лимита (доллары США).
• object (число): жесткий лимит (доллары США).
• object (число): жесткий лимит системы (доллары США)
• object (число): временная метка срока действия доступа, срок действия токена.

Получить информацию об использовании

• Имя интерфейса: получение информации об использовании.
• Метод HTTP: GET
• Путь: object
• Требования аутентификации: токен пользователя.
• Введение в функцию: получение информации об использовании квот пользователя, совместимой с форматом OpenAI API.

💡Пример запроса:

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();

✅ Пример успешного ответа:

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

❗ Пример реакции на ошибку:

{
  "error": {
    "message": "Не удалось получить данные об использовании",
    "type": "new_api_error"
  }
}

🧾 Описание поля:

• object (строка): фиксированное значение «список»
• object (число): общий объем использования в 0,01 доллара США.

Совместимость с путем OpenAI SDK — получение информации об использовании

• Имя интерфейса: Совместимо с путем OpenAI SDK. - Получить информацию об использовании.
• Метод HTTP: GET
• Путь: object
• Требования аутентификации: токен пользователя.
• Введение в функцию: функция точно такая же, как и интерфейс выше, обеспечивая путь, совместимый с OpenAI SDK.

💡Пример запроса:

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();

✅ Пример успешного ответа:

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

❗ Пример реакции на ошибку:

{
  "error": {
    "message": "Не удалось получить данные об использовании",
    "type": "new_api_error"
  }
}

🧾 Описание поля:

• object (строка): фиксированное значение «список»
• object (число): общий объем использования в 0,01 доллара США.