---
title: Get invoice preview
---
[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 invoice preview
GET/accounts/{account\_id}/ai-gateway/billing/invoice-preview
Retrieve a preview of the upcoming invoice including line items and tax.
##### 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)%20invoice_preview%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)%20invoice_preview%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)%20invoice_preview%20%3E%20(network%20schema)%20%3E%20(property)%20messages>)
result: object {id, amount\_due, amount\_paid, 6 more }
id: string
Link to this property
amount\_due: number
Link to this property
amount\_paid: number
Link to this property
amount\_remaining: number
Link to this property
currency: string
Link to this property
invoice\_lines: array of object {amount, currency, description, 4 more }
amount: number
Link to this property
currency: string
Link to this property
description: string
Link to this property
period: object {end, start }
end: number
Link to this property
start: number
Link to this property
Link to this property
pricing: object {unit\_amount\_decimal }
unit\_amount\_decimal: string
Link to this property
Link to this property
quantity: number
Link to this property
pretax\_credit\_amounts: optional array of object {amount, type, credit\_balance\_transaction, discount }
amount: number
Link to this property
type: string
Link to this property
credit\_balance\_transaction: optional string
Link to this property
discount: optional string
Link to this property
Link to this property
Link to this property
period\_end: number
Link to this property
period\_start: number
Link to this property
status: "draft"or "open"or "paid"or 2 more
One of the following:
"draft"
Link to this property
"open"
Link to this property
"paid"
Link to this property
"uncollectible"
Link to this property
"void"
Link to this property
Link to this property
[Link to this property](<#(resource)%20ai_gateway.billing%20%3E%20(method)%20invoice_preview%20%3E%20(network%20schema)%20%3E%20(property)%20result>)
success: true
[Link to this property](<#(resource)%20ai_gateway.billing%20%3E%20(method)%20invoice_preview%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)%20invoice_preview%20%3E%20(network%20schema)%20%3E%20(property)%20result_info>)
### Get invoice preview
HTTP
HTTPTypeScriptPythonGoTerraform
```
curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/ai-gateway/billing/invoice-preview \
-H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
```
200 example
```
{
"errors": [
{
"code": 0,
"message": "message"
}
],
"messages": [
{
"code": 0,
"message": "message"
}
],
"result": {
"id": "id",
"amount_due": 0,
"amount_paid": 0,
"amount_remaining": 0,
"currency": "currency",
"invoice_lines": [
{
"amount": 0,
"currency": "currency",
"description": "description",
"period": {
"end": 0,
"start": 0
},
"pricing": {
"unit_amount_decimal": "unit_amount_decimal"
},
"quantity": 0,
"pretax_credit_amounts": [
{
"amount": 0,
"type": "type",
"credit_balance_transaction": "credit_balance_transaction",
"discount": "discount"
}
]
}
],
"period_end": 0,
"period_start": 0,
"status": "draft"
},
"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": {
"id": "id",
"amount_due": 0,
"amount_paid": 0,
"amount_remaining": 0,
"currency": "currency",
"invoice_lines": [
{
"amount": 0,
"currency": "currency",
"description": "description",
"period": {
"end": 0,
"start": 0
},
"pricing": {
"unit_amount_decimal": "unit_amount_decimal"
},
"quantity": 0,
"pretax_credit_amounts": [
{
"amount": 0,
"type": "type",
"credit_balance_transaction": "credit_balance_transaction",
"discount": "discount"
}
]
}
],
"period_end": 0,
"period_start": 0,
"status": "draft"
},
"success": true,
"result_info": {
"has_more": true,
"page": 0,
"per_page": 0,
"total_count": 0
}
}
```