API Module Guide
Account Billing Dashboard Module
Feature Description
The API prefix is https://api.88api.ai
OpenAI SDK compatible billing query interface. Uses Token authentication to provide subscription information and usage queries. Primarily intended for third-party applications and SDK integration, ensuring full compatibility with the OpenAI API.
๐ User Authentication
Retrieve Subscription Quota Information
- Interface Name: Retrieve Subscription Quota Information
- HTTP Method: GET
- Path:
/dashboard/billing/subscription - Authentication Required: User Token
- Function Description: Retrieves the user's subscription quota information, including total quota, hard limit, and access validity period, compatible with the OpenAI API format
๐ก Request Example:
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();โ Successful Response Example:
{
"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
}โ Failed Response Example:
{
"error": {
"message": "่ทๅ้
้ขๅคฑ่ดฅ",
"type": "upstream_error"
}
}๐งพ Field Description:
object(String): Fixed value "billing_subscription"has_payment_method(Boolean): Whether a payment method exists, fixed to truesoft_limit_usd(Number): Soft limit quota (USD)hard_limit_usd(Number): Hard limit quota (USD)system_hard_limit_usd(Number): System hard limit quota (USD)access_until(Number): Access validity timestamp, Token expiration time
OpenAI SDK Compatible Path - Retrieve Subscription Quota Information
- Interface Name: OpenAI SDK Compatible Path - Retrieve Subscription Quota Information
- HTTP Method: GET
- Path:
/v1/dashboard/billing/subscription - Authentication Required: User Token
- Function Description: Functionally identical to the interface above, providing an OpenAI SDK compatible path
๐ก Request Example:
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();โ Successful Response Example:
{
"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
}โ Failed Response Example:
{
"error": {
"message": "่ทๅ้
้ขๅคฑ่ดฅ",
"type": "upstream_error"
}
}๐งพ Field Description:
object(String): Fixed value "billing_subscription"has_payment_method(Boolean): Whether a payment method exists, fixed to truesoft_limit_usd(Number): Soft limit quota (USD)hard_limit_usd(Number): Hard limit quota (USD)system_hard_limit_usd(Number): System hard limit quota (USD)access_until(Number): Access validity timestamp, Token expiration time
Retrieve Usage Information
- Interface Name: Retrieve Usage Information
- HTTP Method: GET
- Path:
/dashboard/billing/usage - Authentication Required: User Token
- Function Description: Retrieves the user's quota usage information, compatible with the OpenAI API format
๐ก Request Example:
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();โ Successful Response Example:
{
"object": "list",
"total_usage": 2500.0
}โ Failed Response Example:
{
"error": {
"message": "่ทๅไฝฟ็จ้ๅคฑ่ดฅ",
"type": "new_api_error"
}
}๐งพ Field Description:
object(String): Fixed value "list"total_usage(Number): Total usage, measured in $0.01 USD units
OpenAI SDK Compatible Path - Retrieve Usage Information
- Interface Name: OpenAI SDK Compatible Path - Retrieve Usage Information
- HTTP Method: GET
- Path:
/v1/dashboard/billing/usage - Authentication Required: User Token
- Function Description: Functionally identical to the interface above, providing an OpenAI SDK compatible path
๐ก Request Example:
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();โ Successful Response Example:
{
"object": "list",
"total_usage": 2500.0
}โ Failed Response Example:
{
"error": {
"message": "่ทๅไฝฟ็จ้ๅคฑ่ดฅ",
"type": "new_api_error"
}
}๐งพ Field Description:
object(String): Fixed value "list"total_usage(Number): Total usage, measured in $0.01 USD units