--- title: Get invoice preview --- [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 invoice preview ai\_gateway.billing.invoice\_preview(BillingInvoicePreviewParams\*\*kwargs) -> [BillingInvoicePreviewResponse]() 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` ##### ParametersExpand Collapse account\_id: str [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
class BillingInvoicePreviewResponse: … id: str Link to this property amount\_due: float Link to this property amount\_paid: float Link to this property amount\_remaining: float Link to this property currency: str Link to this property
invoice\_lines: List\[InvoiceLine] amount: float Link to this property currency: str Link to this property description: Optional\[str] Link to this property
period: InvoiceLinePeriod end: float Link to this property start: float Link to this property
Link to this property
pricing: InvoiceLinePricing unit\_amount\_decimal: Optional\[str] Link to this property
Link to this property quantity: float Link to this property
pretax\_credit\_amounts: Optional\[List\[InvoiceLinePretaxCreditAmount]] amount: float Link to this property type: str Link to this property credit\_balance\_transaction: Optional\[str] Link to this property discount: Optional\[str] Link to this property
Link to this property
Link to this property period\_end: float Link to this property period\_start: float Link to this property
status: Literal\["draft", "open", "paid", 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(model)%20billing_invoice_preview_response%20%3E%20(schema)>) ### Get invoice preview 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.invoice_preview( account_id="account_id", ) print(response.id) ``` 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 } } ```