--- title: Get credit balance --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [AI Gateway](https://developers.cloudflare.com/api/python/resources/ai_gateway) [Billing](https://developers.cloudflare.com/api/python/resources/ai_gateway/subresources/billing) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # 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:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required) `AI Gateway Write``AI Gateway Read` ##### ParametersExpand Collapse account\_id: str [Link to this property](<#(resource)%20ai_gateway.billing%20%3E%20(method)%20credit_balance%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>) ##### ReturnsExpand Collapse
class BillingCreditBalanceResponse: … balance: float Link to this property has\_default\_payment\_method: bool Link to this property
payment\_method: Optional\[PaymentMethod] brand: Optional\[str] Link to this property last4: Optional\[str] Link to this property
Link to this property
topup\_config: TopupConfig amount: Optional\[float] Link to this property threshold: Optional\[float] Link to this property disabled\_reason: Optional\[str] Link to this property error: Optional\[str] Link to this property last\_failed\_at: Optional\[float] Link to this property
Link to this property first\_topup\_success: Optional\[bool] Link to this property
[Link to this property](<#(resource)%20ai_gateway.billing%20%3E%20(model)%20billing_credit_balance_response%20%3E%20(schema)>) ### Get credit balance Python HTTPTypeScriptPythonGoTerraform ``` 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) ``` 200 example ``` { "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, "threshold": 0, "disabledReason": "disabledReason", "error": "error", "lastFailedAt": 0 }, "first_topup_success": true }, "success": true, "result_info": { "has_more": true, "page": 0, "per_page": 0, "total_count": 0 } } ``` ##### Returns Examples 200 example ``` { "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, "threshold": 0, "disabledReason": "disabledReason", "error": "error", "lastFailedAt": 0 }, "first_topup_success": true }, "success": true, "result_info": { "has_more": true, "page": 0, "per_page": 0, "total_count": 0 } } ```