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

[Skip to content](#%5Ftop) 

[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#%28resource%29%20billing.usage%20%3E%20%28model%29%20usage%5Fget%5Fresponse%20%3E%20%28schema%29)

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

API Token

The preferred authorization scheme for interacting with the Cloudflare API. [Create a token](https://developers.cloudflare.com/fundamentals/api/get-started/create-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`

##### ParametersExpand Collapse 

account\_id: str

Represents a Cloudflare resource identifier tag.

maxLength32

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

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

##### ReturnsExpand Collapse 

List\[UsageGetResponseItem\]

Contains the array of cost and usage records.

billing\_account\_id: str

Public identifier of the Cloudflare account (account tag).

billing\_account\_name: str

Display name of the Cloudflare account.

charge\_category: Literal\["Usage"\]

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

charge\_description: str

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

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

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

charge\_period\_end: datetime

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

formatdate-time

charge\_period\_start: datetime

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

formatdate-time

consumed\_quantity: float

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

consumed\_unit: str

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

host\_provider\_name: str

Name of the entity providing the underlying infrastructure or platform.

invoice\_issuer\_name: str

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

service\_provider\_name: str

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

x\_billable\_metric\_id: str

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

x\_billable\_metric\_name: str

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

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

billing\_currency: Optional\[str\]

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

billing\_period\_end: Optional\[datetime\]

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

formatdate-time

billing\_period\_start: Optional\[datetime\]

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

formatdate-time

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

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

contracted\_cost: Optional\[float\]

Cost calculated by multiplying ContractedUnitPrice and the corresponding PricingQuantity.

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.

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.

list\_cost: Optional\[float\]

Cost calculated by multiplying ListUnitPrice and the corresponding PricingQuantity.

list\_unit\_price: Optional\[float\]

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

pricing\_quantity: Optional\[float\]

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

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.

region\_id: Optional\[str\]

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

region\_name: Optional\[str\]

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

sub\_account\_id: Optional\[str\]

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

sub\_account\_name: Optional\[str\]

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

tags: Optional\[Dict\[str, Union\[str, Literal\[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:

str

Literal\[true\]

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

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

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

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

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

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

x\_zone\_id: Optional\[str\]

The identifier for the Cloudflare zone (zone tag). Cloudflare extension.

x\_zone\_name: Optional\[str\]

The display name of the Cloudflare zone. Cloudflare extension.

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

Python

HTTPHTTP

TypeScriptTypeScript

PythonPython

GoGo

TerraformTerraform

```
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": [
    {
      "BillingAccountId": "023e105f4ecef8ad9ca31a8372d0c353",
      "BillingAccountName": "My Account",
      "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",
      "x_BillableMetricName": "Workers Standard Requests",
      "BilledCost": 0,
      "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_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": [
    {
      "BillingAccountId": "023e105f4ecef8ad9ca31a8372d0c353",
      "BillingAccountName": "My Account",
      "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",
      "x_BillableMetricName": "Workers Standard Requests",
      "BilledCost": 0,
      "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_ProductCategoryName": "Developer",
      "x_ProductFamilyId": "workers",
      "x_ProductFamilyName": "Workers",
      "x_ZoneId": "023e105f4ecef8ad9ca31a8372d0c353",
      "x_ZoneName": "example.com"
    }
  ],
  "success": true
}
```