---
title: Get Account Usage (Version 2, Alpha, Restricted)
---

[Skip to content](#_top)

[API Reference](https://developers.cloudflare.com/api/python)

[Billing](https://developers.cloudflare.com/api/python/resources/billing)

[Usage](https://developers.cloudflare.com/api/python/resources/billing/subresources/usage)

Copy Markdown

Open in **Claude**Open in **ChatGPT**Open in **Cursor**

---

**Copy Markdown****View as Markdown**

# Get Account Usage (Version 2, Alpha, Restricted)

Deprecated: Use \`get\_account\_usage\_v2\` instead.

billing.usage.get(UsageGetParams\*\*kwargs) -> [UsageGetResponse](<https://developers.cloudflare.com/api/python/resources/billing#(resource)%20billing.usage%20%3E%20(model)%20usage_get_response%20%3E%20(schema)>)

GET/accounts/{account\_id}/billable/usage

Returns cost and usage data for a single Cloudflare account, aligned with the [FinOps FOCUS v1.3](https://focus.finops.org/focus-specification/v1-3/) Cost and Usage dataset specification.

Each record represents one billable metric for one account on one day. This includes all metered usage, including usage that falls within free-tier allowances and may result in zero cost.

**Note:** Cost and pricing fields are not yet populated and will be absent from responses until billing integration is complete.

When `from` and `to` are omitted, defaults to the start of the current month through today. The maximum date range is 31 days.

##### Security

<details>

<summary>API Token</summary>



The preferred authorization scheme for interacting with the Cloudflare API. <a href="https://developers.cloudflare.com/fundamentals/api/get-started/create-token/">Create a token</a>.

**Example:**<code>Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY</code>

</details>

<details>

<summary>API Email + API Key</summary>



The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

**Example:**<code>X-Auth-Email: user@example.com</code>

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

**Example:**<code>X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194</code>

</details>

##### ParametersExpand Collapse

account\_id: str

Represents a Cloudflare resource identifier tag.

maxLength32

[Link to this property](<#(resource)%20billing.usage%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>)

from\_: Optional\[Union\[null, null]]

Start date for the usage query (ISO 8601). Required if `to` is set. When omitted along with `to`, defaults to the start of the current month. Filters by charge period (when consumption happened), not billing period. The maximum date range is 31 days.

formatdate

[Link to this property](<#(resource)%20billing.usage%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20from%20%3E%20(schema)>)

to: Optional\[Union\[null, null]]

End date for the usage query (ISO 8601). Required if `from` is set. When omitted along with `from`, defaults to today. Filters by charge period (when consumption happened), not billing period. The maximum date range is 31 days.

formatdate

[Link to this property](<#(resource)%20billing.usage%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20to%20%3E%20(schema)>)

##### ReturnsExpand Collapse

<details>

<summary>

List\[UsageGetResponseItem]

Contains the array of cost and usage records.

</summary>

charge\_category: Literal\["Usage"]

Highest-level classification of a charge based on the nature of how it gets billed. Currently only “Usage” is supported.

<a href="#(resource)%20billing.usage%20%3E%20(model)%20usage_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20ChargeCategory">Link to this property</a>

charge\_description: str

Self-contained summary of the charge’s purpose and price.

<a href="#(resource)%20billing.usage%20%3E%20(model)%20usage_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20ChargeDescription">Link to this property</a>

charge\_frequency: Literal\["Usage-Based"]

Indicates how often a charge occurs. Currently only “Usage-Based” is supported.

<a href="#(resource)%20billing.usage%20%3E%20(model)%20usage_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20ChargeFrequency">Link to this property</a>

charge\_period\_end: datetime

Exclusive end of the time interval during which the usage was consumed.

formatdate-time

<a href="#(resource)%20billing.usage%20%3E%20(model)%20usage_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20ChargePeriodEnd">Link to this property</a>

charge\_period\_start: datetime

Inclusive start of the time interval during which the usage was consumed.

formatdate-time

<a href="#(resource)%20billing.usage%20%3E%20(model)%20usage_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20ChargePeriodStart">Link to this property</a>

consumed\_quantity: float

Measured usage amount within the charge period. Reflects raw metered consumption before pricing transformations.

<a href="#(resource)%20billing.usage%20%3E%20(model)%20usage_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20ConsumedQuantity">Link to this property</a>

consumed\_unit: str

Unit of measure for the consumed quantity (e.g., “GB”, “Requests”, “vCPU-Hours”).

<a href="#(resource)%20billing.usage%20%3E%20(model)%20usage_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20ConsumedUnit">Link to this property</a>

host\_provider\_name: str

Name of the entity providing the underlying infrastructure or platform.

<a href="#(resource)%20billing.usage%20%3E%20(model)%20usage_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20HostProviderName">Link to this property</a>

invoice\_issuer\_name: str

Name of the entity responsible for invoicing for the services consumed.

<a href="#(resource)%20billing.usage%20%3E%20(model)%20usage_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20InvoiceIssuerName">Link to this property</a>

service\_provider\_name: str

Name of the entity that made the services available for purchase.

<a href="#(resource)%20billing.usage%20%3E%20(model)%20usage_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20ServiceProviderName">Link to this property</a>

x\_billable\_metric\_id: str

The unique identifier for the billable metric in the Cloudflare catalog. Cloudflare extension; replaces FOCUS SkuId.

<a href="#(resource)%20billing.usage%20%3E%20(model)%20usage_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20x_BillableMetricId">Link to this property</a>

billed\_cost: Optional\[float]

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).

<a href="#(resource)%20billing.usage%20%3E%20(model)%20usage_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20BilledCost">Link to this property</a>

billing\_account\_id: Optional\[str]

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.

<a href="#(resource)%20billing.usage%20%3E%20(model)%20usage_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20BillingAccountId">Link to this property</a>

billing\_account\_name: Optional\[str]

Display name of the Cloudflare account. Omitted when account is not part of the requested grouping, and for usage measured at contract level.

<a href="#(resource)%20billing.usage%20%3E%20(model)%20usage_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20BillingAccountName">Link to this property</a>

billing\_currency: Optional\[str]

Currency that a charge was billed in (ISO 4217).

<a href="#(resource)%20billing.usage%20%3E%20(model)%20usage_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20BillingCurrency">Link to this property</a>

billing\_period\_end: Optional\[datetime]

Exclusive end of the billing cycle that contains this usage record.

formatdate-time

<a href="#(resource)%20billing.usage%20%3E%20(model)%20usage_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20BillingPeriodEnd">Link to this property</a>

billing\_period\_start: Optional\[datetime]

Inclusive start of the billing cycle that contains this usage record.

formatdate-time

<a href="#(resource)%20billing.usage%20%3E%20(model)%20usage_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20BillingPeriodStart">Link to this property</a>

charge\_class: Optional\[Literal\["Correction"]]

Indicates whether the row represents a correction to one or more charges invoiced in a previous billing period.

<a href="#(resource)%20billing.usage%20%3E%20(model)%20usage_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20ChargeClass">Link to this property</a>

contracted\_cost: Optional\[float]

Cost calculated by multiplying ContractedUnitPrice and the corresponding PricingQuantity.

<a href="#(resource)%20billing.usage%20%3E%20(model)%20usage_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20ContractedCost">Link to this property</a>

contracted\_unit\_price: Optional\[float]

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.

<a href="#(resource)%20billing.usage%20%3E%20(model)%20usage_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20ContractedUnitPrice">Link to this property</a>

effective\_cost: Optional\[float]

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.

<a href="#(resource)%20billing.usage%20%3E%20(model)%20usage_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20EffectiveCost">Link to this property</a>

list\_cost: Optional\[float]

Cost calculated by multiplying ListUnitPrice and the corresponding PricingQuantity.

<a href="#(resource)%20billing.usage%20%3E%20(model)%20usage_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20ListCost">Link to this property</a>

list\_unit\_price: Optional\[float]

Suggested provider-published unit price for a single PricingUnit of the associated billable metric, exclusive of any discounts.

<a href="#(resource)%20billing.usage%20%3E%20(model)%20usage_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20ListUnitPrice">Link to this property</a>

pricing\_quantity: Optional\[float]

Volume of a given service used or purchased, based on the PricingUnit.

<a href="#(resource)%20billing.usage%20%3E%20(model)%20usage_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20PricingQuantity">Link to this property</a>

pricing\_unit: Optional\[str]

Provider-specified measurement unit for determining unit prices, indicating how the provider rates measured usage after applying pricing rules like block pricing.

<a href="#(resource)%20billing.usage%20%3E%20(model)%20usage_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20PricingUnit">Link to this property</a>

region\_id: Optional\[str]

Provider-assigned identifier for an isolated geographic area where a service is provided.

<a href="#(resource)%20billing.usage%20%3E%20(model)%20usage_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20RegionId">Link to this property</a>

region\_name: Optional\[str]

Name of an isolated geographic area where a service is provided.

<a href="#(resource)%20billing.usage%20%3E%20(model)%20usage_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20RegionName">Link to this property</a>

sub\_account\_id: Optional\[str]

Unique identifier assigned to a grouping of services. For Cloudflare, this is the subscription or contract ID.

<a href="#(resource)%20billing.usage%20%3E%20(model)%20usage_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20SubAccountId">Link to this property</a>

sub\_account\_name: Optional\[str]

Name assigned to a grouping of services. For Cloudflare, this is the subscription or contract display name.

<a href="#(resource)%20billing.usage%20%3E%20(model)%20usage_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20SubAccountName">Link to this property</a>

<details>

<summary>

tags: Optional\[Dict\[str, Union\[str, Literal\[true]]]]

Tag values for the requested <code>GroupBy</code> keys. Omitted when <code>GroupBy</code> is not provided. Missing keys are omitted, and key-only tags are returned as boolean <code>true</code>. All other tag values are strings.

</summary>

One of the following:

str

<a href="#(resource)%20billing.usage%20%3E%20(model)%20usage_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20Tags%20%3E%20(items)%20%3E%20(variant)%200">Link to this property</a>

Literal\[true]

<a href="#(resource)%20billing.usage%20%3E%20(model)%20usage_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20Tags%20%3E%20(items)%20%3E%20(variant)%201">Link to this property</a>

</details>

<a href="#(resource)%20billing.usage%20%3E%20(model)%20usage_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20Tags">Link to this property</a>

x\_billable\_metric\_name: Optional\[str]

The display name of the billable metric. Cloudflare extension; replaces FOCUS SkuMeter.

<a href="#(resource)%20billing.usage%20%3E%20(model)%20usage_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20x_BillableMetricName">Link to this property</a>

x\_product\_category\_name: Optional\[str]

The product category the charge belongs to (e.g., “Developer”, “Cloudflare One”). Cloudflare extension; replaces FOCUS ServiceCategory.

<a href="#(resource)%20billing.usage%20%3E%20(model)%20usage_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20x_ProductCategoryName">Link to this property</a>

x\_product\_family\_id: Optional\[str]

The unique identifier for the product family in the Cloudflare catalog. Cloudflare extension; replaces FOCUS ServiceId.

<a href="#(resource)%20billing.usage%20%3E%20(model)%20usage_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20x_ProductFamilyId">Link to this property</a>

x\_product\_family\_name: Optional\[str]

The product family the charge belongs to (e.g., “R2”, “Workers”). Cloudflare extension; replaces FOCUS ServiceName.

<a href="#(resource)%20billing.usage%20%3E%20(model)%20usage_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20x_ProductFamilyName">Link to this property</a>

x\_zone\_id: Optional\[str]

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.

<a href="#(resource)%20billing.usage%20%3E%20(model)%20usage_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20x_ZoneId">Link to this property</a>

x\_zone\_name: Optional\[str]

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.

<a href="#(resource)%20billing.usage%20%3E%20(model)%20usage_get_response%20%3E%20(schema)%20%3E%20(items)%20%3E%20(property)%20x_ZoneName">Link to this property</a>

</details>

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

### Get Account Usage (Version 2, Alpha, Restricted)

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
)
usages = client.billing.usage.get(
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(usages)
```

200 example

```
{
  "errors": [
    {
      "message": "message",
      "code": 0
    }
  ],
  "messages": [
    {
      "message": "message",
      "code": 0
    }
  ],
  "result": [
    {
      "ChargeCategory": "Usage",
      "ChargeDescription": "Workers Standard Requests — daily usage",
      "ChargeFrequency": "Usage-Based",
      "ChargePeriodEnd": "2025-05-02T00:00:00Z",
      "ChargePeriodStart": "2025-05-01T00:00:00Z",
      "ConsumedQuantity": 150000,
      "ConsumedUnit": "Requests",
      "HostProviderName": "Cloudflare",
      "InvoiceIssuerName": "Cloudflare",
      "ServiceProviderName": "Cloudflare",
      "x_BillableMetricId": "workers_standard_requests",
      "BilledCost": 0,
      "BillingAccountId": "023e105f4ecef8ad9ca31a8372d0c353",
      "BillingAccountName": "My Account",
      "BillingCurrency": "USD",
      "BillingPeriodEnd": "2025-06-01T00:00:00Z",
      "BillingPeriodStart": "2025-05-01T00:00:00Z",
      "ChargeClass": "Correction",
      "ContractedCost": 0.75,
      "ContractedUnitPrice": 0.000005,
      "EffectiveCost": 0,
      "ListCost": 0.75,
      "ListUnitPrice": 0.000005,
      "PricingQuantity": 150000,
      "PricingUnit": "Requests",
      "RegionId": "EEUR",
      "RegionName": "Eastern Europe",
      "SubAccountId": "c9bd752d-9ca8-411d-b804-be44a758057f",
      "SubAccountName": "My Subscription",
      "Tags": {
        "team": "fintech"
      },
      "x_BillableMetricName": "Workers Standard Requests",
      "x_ProductCategoryName": "Developer",
      "x_ProductFamilyId": "workers",
      "x_ProductFamilyName": "Workers",
      "x_ZoneId": "023e105f4ecef8ad9ca31a8372d0c353",
      "x_ZoneName": "example.com"
    }
  ],
  "success": true
}
```

##### Returns Examples

200 example

```
{
  "errors": [
    {
      "message": "message",
      "code": 0
    }
  ],
  "messages": [
    {
      "message": "message",
      "code": 0
    }
  ],
  "result": [
    {
      "ChargeCategory": "Usage",
      "ChargeDescription": "Workers Standard Requests — daily usage",
      "ChargeFrequency": "Usage-Based",
      "ChargePeriodEnd": "2025-05-02T00:00:00Z",
      "ChargePeriodStart": "2025-05-01T00:00:00Z",
      "ConsumedQuantity": 150000,
      "ConsumedUnit": "Requests",
      "HostProviderName": "Cloudflare",
      "InvoiceIssuerName": "Cloudflare",
      "ServiceProviderName": "Cloudflare",
      "x_BillableMetricId": "workers_standard_requests",
      "BilledCost": 0,
      "BillingAccountId": "023e105f4ecef8ad9ca31a8372d0c353",
      "BillingAccountName": "My Account",
      "BillingCurrency": "USD",
      "BillingPeriodEnd": "2025-06-01T00:00:00Z",
      "BillingPeriodStart": "2025-05-01T00:00:00Z",
      "ChargeClass": "Correction",
      "ContractedCost": 0.75,
      "ContractedUnitPrice": 0.000005,
      "EffectiveCost": 0,
      "ListCost": 0.75,
      "ListUnitPrice": 0.000005,
      "PricingQuantity": 150000,
      "PricingUnit": "Requests",
      "RegionId": "EEUR",
      "RegionName": "Eastern Europe",
      "SubAccountId": "c9bd752d-9ca8-411d-b804-be44a758057f",
      "SubAccountName": "My Subscription",
      "Tags": {
        "team": "fintech"
      },
      "x_BillableMetricName": "Workers Standard Requests",
      "x_ProductCategoryName": "Developer",
      "x_ProductFamilyId": "workers",
      "x_ProductFamilyName": "Workers",
      "x_ZoneId": "023e105f4ecef8ad9ca31a8372d0c353",
      "x_ZoneName": "example.com"
    }
  ],
  "success": true
}
```