Balance

Query Account Balance

Retrieve current account balance information using a Management API Key.

Authentication

Management API Key authentication is required.

Authorization: Bearer <management_api_key>

Request

GET /management/balance

Query Parameters

Parameter	Type	Required	Description
currency_code	string	No	Currency code. If omitted, the system default currency is used
org_id	string	No	Organization ID. In most cases this is not needed because the key-bound organization is used by default

Request Examples

cURL

curl -X GET "https://portal-api.r9s.ai/api/v1/portal/management/balance?currency_code=CNY" \
  -H "Authorization: Bearer sk_mg_xxxxxxxxxxxxxxxxxx"

JavaScript (Fetch)

const response = await fetch('https://portal-api.r9s.ai/api/v1/portal/management/balance?currency_code=CNY', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer sk_mg_xxxxxxxxxxxxxxxxxx',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
console.log(data);

Python (requests)

import requests

url = "https://portal-api.r9s.ai/api/v1/portal/management/balance"
params = {
    "currency_code": "CNY"
}
headers = {
    "Authorization": "Bearer sk_mg_xxxxxxxxxxxxxxxxxx",
    "Content-Type": "application/json"
}

response = requests.get(url, params=params, headers=headers)
data = response.json()
print(data)

Response Schema

Field	Type	Required	Description
meta	object	Yes	Response metadata
meta.code	integer	Yes	Status code (0 for success)
meta.message	string	Yes	Response message
meta.request_id	string	Yes	Request identifier
data	object	Yes	Balance data
data.balance	number	Yes	Available balance
data.balance_str	string	Yes	Balance as string
data.coupon_balance	number	Yes	Coupon balance
data.currency_code	string	Yes	Currency code
data.credit_limit	number	Yes	Credit limit
data.total_coupon_amount	number	Yes	Total coupon amount

Response Example

{
  "meta": {
    "code": 0,
    "message": "success",
    "request_id": "xxx"
  },
  "data": {
    "balance": 100.5,
    "balance_str": "100.5",
    "coupon_balance": 20,
    "currency_code": "CNY",
    "credit_limit": 0,
    "total_coupon_amount": 20
  }
}

Related APIs

• Overview - Learn about Manager API authentication and basic information
• API Keys - Manage API Keys
• Usage - Query token usage records within a specified time range