Get credit balance
ai_gateway.billing.credit_balance(BillingCreditBalanceParams**kwargs) -> BillingCreditBalanceResponse
GET/accounts/{account_id}/ai-gateway/billing/credit-balance
Retrieve the current credit balance, payment method info, and top-up configuration.
Security
API Token
The preferred authorization scheme for interacting with the Cloudflare API. Create a token.
Example:
API Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
Example:
The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
Example:
Accepted Permissions (at least one required)
Get credit balance
import os
from cloudflare import Cloudflare
client = Cloudflare(
api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted
)
response = client.ai_gateway.billing.credit_balance(
account_id="account_id",
)
print(response.balance){
"errors": [
{
"code": 0,
"message": "message"
}
],
"messages": [
{
"code": 0,
"message": "message"
}
],
"result": {
"balance": 0,
"has_default_payment_method": true,
"payment_method": {
"brand": "brand",
"last4": "last4"
},
"topup_config": {
"amount": 0,
"disabledReason": "disabledReason",
"error": "error",
"lastFailedAt": 0,
"threshold": 0
},
"first_topup_success": true
},
"success": true,
"result_info": {
"has_more": true,
"page": 0,
"per_page": 0,
"total_count": 0
}
}Returns Examples
{
"errors": [
{
"code": 0,
"message": "message"
}
],
"messages": [
{
"code": 0,
"message": "message"
}
],
"result": {
"balance": 0,
"has_default_payment_method": true,
"payment_method": {
"brand": "brand",
"last4": "last4"
},
"topup_config": {
"amount": 0,
"disabledReason": "disabledReason",
"error": "error",
"lastFailedAt": 0,
"threshold": 0
},
"first_topup_success": true
},
"success": true,
"result_info": {
"has_more": true,
"page": 0,
"per_page": 0,
"total_count": 0
}
}