--- title: Get invoice preview --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [AI Gateway](https://developers.cloudflare.com/api/go/resources/ai_gateway) [Billing](https://developers.cloudflare.com/api/go/resources/ai_gateway/subresources/billing) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Get invoice preview client.AIGateway.Billing.InvoicePreview(ctx, query) (\*[BillingInvoicePreviewResponse](), error) 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
query BillingInvoicePreviewParams AccountID param.Field\[string] Cloudflare account ID. Link to this property
[Link to this property](<#(resource)%20ai_gateway.billing%20%3E%20(method)%20invoice_preview%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type BillingInvoicePreviewResponse struct{…} ID string Link to this property AmountDue float64 Link to this property AmountPaid float64 Link to this property AmountRemaining float64 Link to this property Currency string Link to this property
InvoiceLines \[]BillingInvoicePreviewResponseInvoiceLine Amount float64 Link to this property Currency string Link to this property Description string Link to this property
Period BillingInvoicePreviewResponseInvoiceLinesPeriod End float64 Link to this property Start float64 Link to this property
Link to this property
Pricing BillingInvoicePreviewResponseInvoiceLinesPricing UnitAmountDecimal string Link to this property
Link to this property Quantity float64 Link to this property
PretaxCreditAmounts \[]BillingInvoicePreviewResponseInvoiceLinesPretaxCreditAmountOptional Amount float64 Link to this property Type string Link to this property CreditBalanceTransaction stringOptional Link to this property Discount stringOptional Link to this property
Link to this property
Link to this property PeriodEnd float64 Link to this property PeriodStart float64 Link to this property
Status BillingInvoicePreviewResponseStatus One of the following: const BillingInvoicePreviewResponseStatusDraft BillingInvoicePreviewResponseStatus = "draft" Link to this property const BillingInvoicePreviewResponseStatusOpen BillingInvoicePreviewResponseStatus = "open" Link to this property const BillingInvoicePreviewResponseStatusPaid BillingInvoicePreviewResponseStatus = "paid" Link to this property const BillingInvoicePreviewResponseStatusUncollectible BillingInvoicePreviewResponseStatus = "uncollectible" Link to this property const BillingInvoicePreviewResponseStatusVoid BillingInvoicePreviewResponseStatus = "void" Link to this property
Link to this property
[Link to this property](<#(resource)%20ai_gateway.billing%20%3E%20(model)%20BillingInvoicePreviewResponse%20%3E%20(schema)>) ### Get invoice preview Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/ai_gateway" "github.com/cloudflare/cloudflare-go/option" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) response, err := client.AIGateway.Billing.InvoicePreview(context.TODO(), ai_gateway.BillingInvoicePreviewParams{ AccountID: cloudflare.F("account_id"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", 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 } } ```