--- title: Billing --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [AI Gateway](https://developers.cloudflare.com/api/typescript/resources/ai_gateway) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Billing ##### [Get credit balance](https://developers.cloudflare.com/api/typescript/resources/ai_gateway/subresources/billing/methods/credit_balance) client.aiGateway.billing.creditBalance(BillingCreditBalanceParams {account\_id } params, RequestOptionsoptions?): [BillingCreditBalanceResponse]() {balance, has\_default\_payment\_method, payment\_method, 2 more } GET/accounts/{account\_id}/ai-gateway/billing/credit-balance ##### [Get usage history](https://developers.cloudflare.com/api/typescript/resources/ai_gateway/subresources/billing/methods/usage_history) client.aiGateway.billing.usageHistory(BillingUsageHistoryParams {account\_id, value\_grouping\_window, end\_time, start\_time } params, RequestOptionsoptions?): [BillingUsageHistoryResponse]() {history } GET/accounts/{account\_id}/ai-gateway/billing/usage-history ##### [Get invoice history](https://developers.cloudflare.com/api/typescript/resources/ai_gateway/subresources/billing/methods/invoice_history) client.aiGateway.billing.invoiceHistory(BillingInvoiceHistoryParams {account\_id, type } params, RequestOptionsoptions?): [BillingInvoiceHistoryResponse]() {invoices, pagination } GET/accounts/{account\_id}/ai-gateway/billing/invoice-history ##### [Get invoice preview](https://developers.cloudflare.com/api/typescript/resources/ai_gateway/subresources/billing/methods/invoice_preview) client.aiGateway.billing.invoicePreview(BillingInvoicePreviewParams {account\_id } params, RequestOptionsoptions?): [BillingInvoicePreviewResponse]() {id, amount\_due, amount\_paid, 6 more } GET/accounts/{account\_id}/ai-gateway/billing/invoice-preview ##### ModelsExpand Collapse

BillingCreditBalanceResponse {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: PaymentMethod| null

brand?: string Link to this property last4?: string Link to this property

Link to this property

topup\_config: TopupConfig {amount, threshold, disabledReason, 2 more }

Link to this property first\_topup\_success?: boolean Link to this property

[Link to this property](<#(resource)%20ai_gateway.billing%20%3E%20(model)%20billing_credit_balance_response%20%3E%20(schema)>)

BillingUsageHistoryResponse {history }

history: Array<History>

id: string Link to this property aggregated\_value: number Link to this property end\_time: number Link to this property start\_time: number Link to this property

Link to this property

[Link to this property](<#(resource)%20ai_gateway.billing%20%3E%20(model)%20billing_usage_history_response%20%3E%20(schema)>)

BillingInvoiceHistoryResponse {invoices, pagination }

invoices: Array<Invoice>

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 id?: string| null Link to this property attempt\_count?: number Link to this property attempted?: boolean Link to this property auto\_advance?: boolean| null Link to this property created?: number Link to this property created\_by?: string Link to this property description?: string| null Link to this property invoice\_origin?: string Link to this property invoice\_pdf?: string| null Link to this property status?: string| null Link to this property

Link to this property

pagination: Pagination {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

[Link to this property](<#(resource)%20ai_gateway.billing%20%3E%20(model)%20billing_invoice_history_response%20%3E%20(schema)>)

BillingInvoicePreviewResponse {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<InvoiceLine>

amount: number Link to this property currency: string Link to this property description: string| null Link to this property

period: Period {end, start }

end: number Link to this property start: number Link to this property

Link to this property

pricing: Pricing {unit\_amount\_decimal }

unit\_amount\_decimal: string| null Link to this property

Link to this property quantity: number Link to this property

pretax\_credit\_amounts?: Array<PretaxCreditAmount>

amount: number Link to this property type: string Link to this property credit\_balance\_transaction?: string| null Link to this property discount?: string| null 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"| "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)>) #### BillingTopup ##### [Create a top-up](https://developers.cloudflare.com/api/typescript/resources/ai_gateway/subresources/billing/subresources/topup/methods/create) client.aiGateway.billing.topup.create(TopupCreateParams {account\_id, amount, payment\_method\_id } params, RequestOptionsoptions?): [TopupCreateResponse]() {client\_secret, onboarding, payment\_intent\_id, 2 more } POST/accounts/{account\_id}/ai-gateway/billing/topup ##### [Check top-up status](https://developers.cloudflare.com/api/typescript/resources/ai_gateway/subresources/billing/subresources/topup/methods/status) client.aiGateway.billing.topup.status(TopupStatusParams {account\_id, payment\_intent\_id } params, RequestOptionsoptions?): [TopupStatusResponse]() {payment\_intent\_id, status } POST/accounts/{account\_id}/ai-gateway/billing/topup/status ##### ModelsExpand Collapse

TopupCreateResponse {client\_secret, onboarding, payment\_intent\_id, 2 more }

client\_secret: string| null Stripe PaymentIntent client secret. Link to this property onboarding: boolean Whether the user was already onboarded. Link to this property payment\_intent\_id: string Stripe invoice ID. Link to this property brand?: string Card brand (visa, mastercard, etc.). Link to this property last4?: string Last 4 digits of card. Link to this property

[Link to this property](<#(resource)%20ai_gateway.billing.topup%20%3E%20(model)%20topup_create_response%20%3E%20(schema)>)

TopupStatusResponse {payment\_intent\_id, status }

payment\_intent\_id: string Link to this property

status: "completed"| "pending"

One of the following: "completed" Link to this property "pending" Link to this property

Link to this property

[Link to this property](<#(resource)%20ai_gateway.billing.topup%20%3E%20(model)%20topup_status_response%20%3E%20(schema)>) #### BillingTopupConfig ##### [Get auto top-up configuration](https://developers.cloudflare.com/api/typescript/resources/ai_gateway/subresources/billing/subresources/topup/subresources/config/methods/get) client.aiGateway.billing.topup.config.get(ConfigGetParams {account\_id } params, RequestOptionsoptions?): [ConfigGetResponse]() {amount, threshold, disabledReason, 2 more } GET/accounts/{account\_id}/ai-gateway/billing/topup/config ##### [Set auto top-up configuration](https://developers.cloudflare.com/api/typescript/resources/ai_gateway/subresources/billing/subresources/topup/subresources/config/methods/create) client.aiGateway.billing.topup.config.create(ConfigCreateParams {account\_id, amount, threshold } params, RequestOptionsoptions?): [ConfigCreateResponse]() {amount, threshold } POST/accounts/{account\_id}/ai-gateway/billing/topup/config ##### [Delete auto top-up configuration](https://developers.cloudflare.com/api/typescript/resources/ai_gateway/subresources/billing/subresources/topup/subresources/config/methods/delete) client.aiGateway.billing.topup.config.delete(ConfigDeleteParams {account\_id } params, RequestOptionsoptions?): [ConfigDeleteResponse]() DELETE/accounts/{account\_id}/ai-gateway/billing/topup/config ##### ModelsExpand Collapse

ConfigGetResponse {amount, threshold, disabledReason, 2 more }

[Link to this property](<#(resource)%20ai_gateway.billing.topup.config%20%3E%20(model)%20config_get_response%20%3E%20(schema)>)

ConfigCreateResponse {amount, threshold }

amount: number Link to this property threshold: number Link to this property

[Link to this property](<#(resource)%20ai_gateway.billing.topup.config%20%3E%20(model)%20config_create_response%20%3E%20(schema)>) ConfigDeleteResponse = unknown [Link to this property](<#(resource)%20ai_gateway.billing.topup.config%20%3E%20(model)%20config_delete_response%20%3E%20(schema)>) #### BillingSpending Limit ##### [Get spending limit (deprecated)](https://developers.cloudflare.com/api/typescript/resources/ai_gateway/subresources/billing/subresources/spending_limit/methods/get) client.aiGateway.billing.spendingLimit.get(SpendingLimitGetParams {account\_id } params, RequestOptionsoptions?): [SpendingLimitGetResponse]() {config, enabled } GET/accounts/{account\_id}/ai-gateway/billing/spending-limit ##### [Set spending limit (deprecated)](https://developers.cloudflare.com/api/typescript/resources/ai_gateway/subresources/billing/subresources/spending_limit/methods/create) Deprecated client.aiGateway.billing.spendingLimit.create(SpendingLimitCreateParams {account\_id, amount, duration, strategy } params, RequestOptionsoptions?): [SpendingLimitCreateResponse]() POST/accounts/{account\_id}/ai-gateway/billing/spending-limit ##### [Delete spending limit (deprecated)](https://developers.cloudflare.com/api/typescript/resources/ai_gateway/subresources/billing/subresources/spending_limit/methods/delete) client.aiGateway.billing.spendingLimit.delete(SpendingLimitDeleteParams {account\_id } params, RequestOptionsoptions?): [SpendingLimitDeleteResponse]() DELETE/accounts/{account\_id}/ai-gateway/billing/spending-limit ##### ModelsExpand Collapse

SpendingLimitGetResponse {config, enabled }

config: Config {amount, duration, strategy }

amount: number| null Link to this property duration: string| null Link to this property strategy: string| null Link to this property

Link to this property enabled: boolean Link to this property

[Link to this property](<#(resource)%20ai_gateway.billing.spending_limit%20%3E%20(model)%20spending_limit_get_response%20%3E%20(schema)>) SpendingLimitCreateResponse = unknown [Link to this property](<#(resource)%20ai_gateway.billing.spending_limit%20%3E%20(model)%20spending_limit_create_response%20%3E%20(schema)>) SpendingLimitDeleteResponse = unknown [Link to this property](<#(resource)%20ai_gateway.billing.spending_limit%20%3E%20(model)%20spending_limit_delete_response%20%3E%20(schema)>)