--- title: Billing --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Billing ##### [Validate Billing Address](https://developers.cloudflare.com/api/resources/billing/methods/address_validation) POST/billing/address-validation ##### ModelsExpand Collapse

BillingAddressValidationResponse object {validated\_addresses }

validated\_addresses: optional array of object {address, address2, city, 4 more } List of validated address suggestions.

address: optional string Validated address line 1. Link to this property address2: optional string Validated address line 2. Link to this property city: optional string Validated city. Link to this property country: optional string Validated country code. Link to this property state: optional string Validated state or province. Link to this property validation\_code: optional string The validation result code. Link to this property zipcode: optional string Validated postal or zip code. Link to this property

Link to this property

[Link to this property](<#(resource)%20billing%20%3E%20(model)%20billing_address_validation_response%20%3E%20(schema)>) #### BillingProfiles ##### [Get Billing Profile](https://developers.cloudflare.com/api/resources/billing/subresources/profiles/methods/get) GET/accounts/{account\_id}/billing/profile ##### [Create Billing Profile](https://developers.cloudflare.com/api/resources/billing/subresources/profiles/methods/create) POST/accounts/{account\_id}/billing/profile ##### [Update Billing Profile](https://developers.cloudflare.com/api/resources/billing/subresources/profiles/methods/update) PUT/accounts/{account\_id}/billing/profile ##### [Delete Billing Profile](https://developers.cloudflare.com/api/resources/billing/subresources/profiles/methods/delete) DELETE/accounts/{account\_id}/billing/profile ##### [Update Billing Email](https://developers.cloudflare.com/api/resources/billing/subresources/profiles/methods/update_billing_email) PATCH/accounts/{account\_id}/billing/profile ##### ModelsExpand Collapse

ProfileGetResponse object {id, account\_type, address, 35 more }

id: optional string Billing item identifier tag. maxLength32 Link to this property account\_type: optional string Link to this property address: optional string Link to this property address2: optional string Link to this property balance: optional string Link to this property card\_expiry\_month: optional number Link to this property card\_expiry\_year: optional number Link to this property card\_number: optional string Link to this property city: optional string Link to this property company: optional string Link to this property country: optional string Link to this property created\_on: optional string formatdate-time Link to this property device\_data: optional string Link to this property edited\_on: optional string formatdate-time Link to this property enterprise\_billing\_email: optional string Link to this property enterprise\_primary\_email: optional string Link to this property first\_name: optional string Link to this property is\_partner: optional boolean Link to this property last\_name: optional string Link to this property next\_bill\_date: optional string formatdate-time Link to this property payment\_address: optional string Link to this property payment\_address2: optional string Link to this property payment\_city: optional string Link to this property payment\_country: optional string Link to this property payment\_email: optional string Link to this property payment\_first\_name: optional string Link to this property payment\_gateway: optional string Link to this property payment\_last\_name: optional string Link to this property payment\_nonce: optional string Link to this property payment\_state: optional string Link to this property payment\_zipcode: optional string Link to this property primary\_email: optional string Link to this property state: optional string Link to this property tax\_id\_type: optional string Link to this property telephone: optional string Link to this property validation\_code: optional string Link to this property vat: optional string Link to this property zipcode: optional string Link to this property

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

ProfileCreateResponse object {id, account\_type, address, 35 more }

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

ProfileUpdateResponse object {id, account\_type, address, 35 more }

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

ProfileUpdateBillingEmailResponse object {id, account\_type, address, 35 more }

[Link to this property](<#(resource)%20billing.profiles%20%3E%20(model)%20profile_update_billing_email_response%20%3E%20(schema)>) #### BillingProfilesPayment Method ##### [Create Payment Intent for Billing Profile](https://developers.cloudflare.com/api/resources/billing/subresources/profiles/subresources/payment_method/methods/create) POST/accounts/{account\_id}/billing/profile/payment-method ##### ModelsExpand Collapse

PaymentMethodCreateResponse object {client\_secret, intent\_type }

client\_secret: optional string The Stripe client secret for frontend payment method collection. Link to this property intent\_type: optional string The type of Stripe intent created. Link to this property

[Link to this property](<#(resource)%20billing.profiles.payment_method%20%3E%20(model)%20payment_method_create_response%20%3E%20(schema)>) #### BillingUsage ##### [Get Account Billable Usage Info (Version 1, Alpha)](https://developers.cloudflare.com/api/resources/billing/subresources/usage/methods/paygo_info) Deprecated GET/accounts/{account\_id}/billable-usage/info ##### [Get Account Billable Usage (Version 1, Alpha)](https://developers.cloudflare.com/api/resources/billing/subresources/usage/methods/paygo) Deprecated GET/accounts/{account\_id}/billable-usage ##### [Get Account Usage (Version 2, Alpha, Restricted)](https://developers.cloudflare.com/api/resources/billing/subresources/usage/methods/get) Deprecated GET/accounts/{account\_id}/billable/usage ##### [Get Account Billable Usage Info (Version 1, Alpha)](https://developers.cloudflare.com/api/resources/billing/subresources/usage/methods/get_account_usage_info_v1) GET/accounts/{account\_id}/billable-usage/info ##### [Get Account Billable Usage (Version 1, Alpha)](https://developers.cloudflare.com/api/resources/billing/subresources/usage/methods/get_account_usage_v1) GET/accounts/{account\_id}/billable-usage ##### [Get Account Usage (Version 2, Alpha, Restricted)](https://developers.cloudflare.com/api/resources/billing/subresources/usage/methods/get_account_usage_v2) GET/accounts/{account\_id}/billable/usage ##### ModelsExpand Collapse

UsagePaygoInfoResponse object {covered, subscriptions } Contains the usage info.

covered: boolean Indicates whether the account is covered. Link to this property

subscriptions: array of object {id, billing\_cycle\_anchor\_timestamp, start\_timestamp, end\_timestamp } List of subscriptions for the account.

id: string The identifier for the Cloudflare subscription. Link to this property billing\_cycle\_anchor\_timestamp: string The subscription billing cycle anchor timestamp. formatdate-time Link to this property start\_timestamp: string The subscription start timestamp. formatdate-time Link to this property end\_timestamp: optional string The subscription end timestamp. Omitted for active subscriptions; present only when the subscription has been cancelled. formatdate-time Link to this property

Link to this property

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

UsagePaygoResponse = array of object {BilledCost, BillingAccountId, BillingAccountName, 24 more } Contains the array of billable usage records.

BilledCost: number The amount invoiced for this charge. PayGo is billed directly by Cloudflare, so this equals ContractedCost. Link to this property BillingAccountId: string The identifier of the account the charge is billed to (account tag). Link to this property BillingAccountName: string The display name of the billing account. Null when the name could not be resolved. Link to this property BillingCurrency: string Specifies the billing currency code (ISO 4217). Link to this property BillingPeriodStart: string Indicates the start of the billing period. There is no BillingPeriodEnd counterpart; see the known gaps described on this schema. formatdate-time Link to this property ChargeCategory: "Usage" Describes the nature of the charge. Always “Usage” for this endpoint, which only returns metered usage. Link to this property ChargeClass: string Indicates whether the row corrects a previously invoiced billing period. Always null for this endpoint, which does not return corrections. Link to this property ChargeDescription: string A human-readable summary of the charge. Link to this property ChargePeriodEnd: string Indicates the end of the charge period. formatdate-time Link to this property ChargePeriodStart: string Indicates the start of the charge period. formatdate-time Link to this property ConsumedQuantity: number Specifies the quantity consumed during this charge period. Link to this property ConsumedUnit: string A display name for the unit of measurement used for the product (for example, “GB-months”, “GB-seconds”). May be empty when the unit is implicit in the service name. Link to this property ContractedCost: number Specifies the cost for this charge period in the billing currency. Link to this property CumulatedContractedCost: number Specifies the cumulated cost for the billing period in the billing currency. Link to this property CumulatedPricingQuantity: number Specifies the portion of usage that is actually subject to a unit price. Link to this property EffectiveCost: number The amortized cost of the charge. PayGo has no upfront commitments, so this equals ContractedCost. Link to this property HostProviderName: string The provider that hosts the infrastructure or platform the service runs on. Link to this property InvoiceIssuerName: string The entity that issues the invoice for this charge. Link to this property ListCost: number The cost at published list prices, before any discount. PayGo has no commitment discounts, so this equals ContractedCost. Link to this property PricingQuantity: number Specifies the pricing quantity for this charge period. Link to this property PricingUnit: string The unit that PricingQuantity is expressed in. Unlike ConsumedUnit this is never empty; it falls back to “Count” when the service has no explicit unit. Link to this property ServiceName: string Identifies the Cloudflare service. Link to this property ServiceProviderName: string The provider of the purchased service. Link to this property ServiceFamilyName: optional string Identifies the product family for the Cloudflare service. Link to this property SubscriptionId: optional string The identifier for the Cloudflare subscription. Link to this property ZoneId: optional string The identifier for the Cloudflare zone (zone tag). Link to this property ZoneName: optional string The display name of the Cloudflare zone. Link to this property

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

UsageGetResponse = array of object {ChargeCategory, ChargeDescription, ChargeFrequency, 33 more } Contains the array of cost and usage records.

ChargeCategory: "Usage" Highest-level classification of a charge based on the nature of how it gets billed. Currently only “Usage” is supported. Link to this property ChargeDescription: string Self-contained summary of the charge’s purpose and price. Link to this property ChargeFrequency: "Usage-Based" Indicates how often a charge occurs. Currently only “Usage-Based” is supported. Link to this property ChargePeriodEnd: string Exclusive end of the time interval during which the usage was consumed. formatdate-time Link to this property ChargePeriodStart: string Inclusive start of the time interval during which the usage was consumed. formatdate-time Link to this property ConsumedQuantity: number Measured usage amount within the charge period. Reflects raw metered consumption before pricing transformations. Link to this property ConsumedUnit: string Unit of measure for the consumed quantity (e.g., “GB”, “Requests”, “vCPU-Hours”). Link to this property HostProviderName: string Name of the entity providing the underlying infrastructure or platform. Link to this property InvoiceIssuerName: string Name of the entity responsible for invoicing for the services consumed. Link to this property ServiceProviderName: string Name of the entity that made the services available for purchase. Link to this property x\_BillableMetricId: string The unique identifier for the billable metric in the Cloudflare catalog. Cloudflare extension; replaces FOCUS SkuId. Link to this property BilledCost: optional number A charge serving as the basis for invoicing, inclusive of all reduced rates and discounts while excluding the amortization of upfront charges (one-time or recurring). Link to this property BillingAccountId: optional string Public identifier of the Cloudflare account (account tag). Omitted when account is not part of the requested grouping, and always omitted for usage measured at contract level, even when grouping by account: that usage is returned as its own record with no account. Link to this property BillingAccountName: optional string Display name of the Cloudflare account. Omitted when account is not part of the requested grouping, and for usage measured at contract level. Link to this property BillingCurrency: optional string Currency that a charge was billed in (ISO 4217). Link to this property BillingPeriodEnd: optional string Exclusive end of the billing cycle that contains this usage record. formatdate-time Link to this property BillingPeriodStart: optional string Inclusive start of the billing cycle that contains this usage record. formatdate-time Link to this property ChargeClass: optional "Correction" Indicates whether the row represents a correction to one or more charges invoiced in a previous billing period. Link to this property ContractedCost: optional number Cost calculated by multiplying ContractedUnitPrice and the corresponding PricingQuantity. Link to this property ContractedUnitPrice: optional number The agreed-upon unit price for a single PricingUnit of the associated billable metric, inclusive of negotiated discounts, if present, while excluding any other discounts. Link to this property EffectiveCost: optional number The amortized cost of the charge after applying all reduced rates, discounts, and the applicable portion of relevant, prepaid purchases (one-time or recurring) that covered the charge. Link to this property ListCost: optional number Cost calculated by multiplying ListUnitPrice and the corresponding PricingQuantity. Link to this property ListUnitPrice: optional number Suggested provider-published unit price for a single PricingUnit of the associated billable metric, exclusive of any discounts. Link to this property PricingQuantity: optional number Volume of a given service used or purchased, based on the PricingUnit. Link to this property PricingUnit: optional string Provider-specified measurement unit for determining unit prices, indicating how the provider rates measured usage after applying pricing rules like block pricing. Link to this property RegionId: optional string Provider-assigned identifier for an isolated geographic area where a service is provided. Link to this property RegionName: optional string Name of an isolated geographic area where a service is provided. Link to this property SubAccountId: optional string Unique identifier assigned to a grouping of services. For Cloudflare, this is the subscription or contract ID. Link to this property SubAccountName: optional string Name assigned to a grouping of services. For Cloudflare, this is the subscription or contract display name. Link to this property

Tags: optional map\[stringor true] Tag values for the requested GroupBy keys. Omitted when GroupBy is not provided. Missing keys are omitted, and key-only tags are returned as boolean true. All other tag values are strings.

One of the following: string Link to this property true Link to this property

Link to this property x\_BillableMetricName: optional string The display name of the billable metric. Cloudflare extension; replaces FOCUS SkuMeter. Link to this property x\_ProductCategoryName: optional string The product category the charge belongs to (e.g., “Developer”, “Cloudflare One”). Cloudflare extension; replaces FOCUS ServiceCategory. Link to this property x\_ProductFamilyId: optional string The unique identifier for the product family in the Cloudflare catalog. Cloudflare extension; replaces FOCUS ServiceId. Link to this property x\_ProductFamilyName: optional string The product family the charge belongs to (e.g., “R2”, “Workers”). Cloudflare extension; replaces FOCUS ServiceName. Link to this property x\_ZoneId: optional string The identifier for the Cloudflare zone (zone tag). Omitted when zone is not part of the requested grouping, and always omitted for usage measured at contract level, even when grouping by zone. Cloudflare extension. Link to this property x\_ZoneName: optional string The display name of the Cloudflare zone. Omitted when zone is not part of the requested grouping, and for usage measured at contract level. Cloudflare extension. Link to this property

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

UsageGetAccountUsageInfoV1Response object {covered, subscriptions } Contains the usage info.

covered: boolean Indicates whether the account is covered. Link to this property

subscriptions: array of object {id, billing\_cycle\_anchor\_timestamp, start\_timestamp, end\_timestamp } List of subscriptions for the account.

Link to this property

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

UsageGetAccountUsageV1Response = array of object {BilledCost, BillingAccountId, BillingAccountName, 24 more } Contains the array of billable usage records.

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

UsageGetAccountUsageV2Response = array of object {ChargeCategory, ChargeDescription, ChargeFrequency, 33 more } Contains the array of cost and usage records.

One of the following: string Link to this property true Link to this property

[Link to this property](<#(resource)%20billing.usage%20%3E%20(model)%20usage_get_account_usage_v2_response%20%3E%20(schema)>) #### BillingCredits ##### [Get Account Credits](https://developers.cloudflare.com/api/resources/billing/subresources/credits/methods/get) GET/accounts/{account\_id}/billing/credits ##### ModelsExpand Collapse

CreditGetResponse object {confirmed\_balance\_cents, currency, days\_remaining, 7 more }

confirmed\_balance\_cents: optional number The confirmed credit balance in cents. formatint64 Link to this property currency: optional string Currency of the credit balance. Link to this property days\_remaining: optional number Days remaining until the credits expire. formatint64 Link to this property eligible: optional boolean Whether the account is eligible to receive credits. Link to this property has\_record: optional boolean Whether a credit record exists for the account. Link to this property original\_amount\_cents: optional number The original credit amount in cents. formatint64 Link to this property percent\_consumed: optional number Percentage of the original credit amount consumed. formatdouble Link to this property projected\_depletion\_date: optional string Projected date when the credits will be depleted. formatdate-time Link to this property valid\_from: optional string When the credits become valid. formatdate-time Link to this property valid\_to: optional string When the credits expire. formatdate-time Link to this property

[Link to this property](<#(resource)%20billing.credits%20%3E%20(model)%20credit_get_response%20%3E%20(schema)>) #### BillingHistory ##### [Get Account Billing History](https://developers.cloudflare.com/api/resources/billing/subresources/history/methods/list) GET/accounts/{account\_id}/billing/history ##### ModelsExpand Collapse

HistoryListResponse object {id, action, amount, 12 more }

id: optional string Billing history item identifier. Link to this property action: optional string The billing item action. Link to this property amount: optional number The amount associated with this billing item. Link to this property amount\_to\_pay: optional number The amount remaining to pay. Link to this property currency: optional string The currency of the billing item. Link to this property description: optional string The billing item description. Link to this property external\_invoice\_id: optional string The external invoice identifier. Link to this property hosted\_invoice\_url: optional string URL to the hosted invoice. Link to this property invoice\_id: optional string The associated invoice identifier. Link to this property occurred\_at: optional string When the billing event occurred. formatdate-time Link to this property receipt\_id: optional string The associated receipt identifier. Link to this property source: optional string The source of the billing item. Link to this property source\_invoice\_id: optional string The source invoice identifier. Link to this property status: optional string The status of the billing item. Link to this property type: optional string The billing item type. Link to this property

[Link to this property](<#(resource)%20billing.history%20%3E%20(model)%20history_list_response%20%3E%20(schema)>) #### BillingBad Debt ##### [Get Account Bad Debt](https://developers.cloudflare.com/api/resources/billing/subresources/bad_debt/methods/get) GET/accounts/{account\_id}/billing/bad-debt ##### ModelsExpand Collapse

BadDebtGetResponse object {already\_paid, bad\_debt\_status, invoices, total\_debt\_amount }

already\_paid: optional number Amount already paid towards the debt. Link to this property bad\_debt\_status: optional string The current bad debt status of the account. Link to this property

invoices: optional array of object {id, action, amount, 12 more } List of outstanding invoices contributing to bad debt.

Link to this property total\_debt\_amount: optional number Total outstanding debt amount. Link to this property

[Link to this property](<#(resource)%20billing.bad_debt%20%3E%20(model)%20bad_debt_get_response%20%3E%20(schema)>) #### BillingUnpaid Invoice ##### [Get Unpaid Invoices](https://developers.cloudflare.com/api/resources/billing/subresources/unpaid_invoice/methods/get) GET/accounts/{account\_id}/billing/unpaid-invoice ##### ModelsExpand Collapse

UnpaidInvoiceGetResponse object {invoices }

invoices: optional array of object {id, action, amount, 12 more } List of unpaid invoices.

Link to this property

[Link to this property](<#(resource)%20billing.unpaid_invoice%20%3E%20(model)%20unpaid_invoice_get_response%20%3E%20(schema)>) #### BillingRate Plans ##### [Get Rate Plan by Public Key](https://developers.cloudflare.com/api/resources/billing/subresources/rate_plans/methods/get) GET/billing/rate\_plans/{public\_key} ##### ModelsExpand Collapse

RatePlanGetResponse object {id, components, currency, public\_name }

id: optional string The uppercase rate plan public key. Link to this property components: optional array of map\[unknown] Pricing components that make up this rate plan. Link to this property currency: optional string Currency of the rate plan pricing. Link to this property public\_name: optional string Human-readable description of the rate plan. Link to this property

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