---
title: Get credit balance
---
[Skip to content](#_top)
[API Reference](https://developers.cloudflare.com/api)
[AI Gateway](https://developers.cloudflare.com/api/resources/ai_gateway)
[Billing](https://developers.cloudflare.com/api/resources/ai_gateway/subresources/billing)
Copy Markdown
Open in **Claude**Open in **ChatGPT**Open in **Cursor**
---
**Copy Markdown****View as Markdown**
# Get credit balance
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`
##### P ath ParametersExpand Collapse
account\_id: string
[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
errors: array of object {code, message }
code: number
Link to this property
message: string
Link to this property
[Link to this property](<#(resource)%20ai_gateway.billing%20%3E%20(method)%20credit_balance%20%3E%20(network%20schema)%20%3E%20(property)%20errors>)
messages: array of object {code, message }
code: number
Link to this property
message: string
Link to this property
[Link to this property](<#(resource)%20ai_gateway.billing%20%3E%20(method)%20credit_balance%20%3E%20(network%20schema)%20%3E%20(property)%20messages>)
result: object {balance, has\_default\_payment\_method, payment\_method, 2 more }
balance: number
Link to this property
has\_default\_payment\_method: boolean
Link to this property
payment\_method: object {brand, last4 }
brand: optional string
Link to this property
last4: optional string
Link to this property
Link to this property
topup\_config: object {amount, threshold, disabledReason, 2 more }
amount: number
Link to this property
threshold: number
Link to this property
disabledReason: optional string
Link to this property
error: optional string
Link to this property
lastFailedAt: optional number
Link to this property
Link to this property
first\_topup\_success: optional boolean
Link to this property
[Link to this property](<#(resource)%20ai_gateway.billing%20%3E%20(method)%20credit_balance%20%3E%20(network%20schema)%20%3E%20(property)%20result>)
success: true
[Link to this property](<#(resource)%20ai_gateway.billing%20%3E%20(method)%20credit_balance%20%3E%20(network%20schema)%20%3E%20(property)%20success>)
result\_info: optional object {has\_more, page, per\_page, total\_count }
has\_more: boolean
Link to this property
page: number
Link to this property
per\_page: number
Link to this property
total\_count: number
Link to this property
[Link to this property](<#(resource)%20ai_gateway.billing%20%3E%20(method)%20credit_balance%20%3E%20(network%20schema)%20%3E%20(property)%20result_info>)
### Get credit balance
HTTP
HTTPTypeScriptPythonGoTerraform
```
curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/ai-gateway/billing/credit-balance \
-H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
```
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
}
}
```