Get Account Billable Usage (Version 1, Alpha)

billing.usage.paygo() -> UsagePaygoResponse

GET/accounts/{account_id}/billable-usage

Returns billable usage data for the account. When no query parameters are provided, returns usage for the current billing period.

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

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). The provided time range must include the subscription billing cycle anchor day, otherwise no usage data is returned. Use the info endpoint to retrieve the subscription anchor day.

formatdate

to: Optional[Union[null, null]]

End date for the usage query (ISO 8601).

formatdate

ReturnsExpand Collapse

List[UsagePaygoResponseItem]

Contains the array of billable usage records.

billed_cost: float

The amount invoiced for this charge. PayGo is billed directly by Cloudflare, so this equals ContractedCost.

billing_account_id: str

The identifier of the account the charge is billed to (account tag).

billing_account_name: Optional[str]

The display name of the billing account. Null when the name could not be resolved.

billing_currency: str

Specifies the billing currency code (ISO 4217).

billing_period_start: datetime

Indicates the start of the billing period. There is no BillingPeriodEnd counterpart; see the known gaps described on this schema.

formatdate-time

charge_category: Literal["Usage"]

Describes the nature of the charge. Always “Usage” for this endpoint, which only returns metered usage.

charge_class: Optional[str]

Indicates whether the row corrects a previously invoiced billing period. Always null for this endpoint, which does not return corrections.

charge_description: Optional[str]

A human-readable summary of the charge.

charge_period_end: datetime

Indicates the end of the charge period.

formatdate-time

charge_period_start: datetime

Indicates the start of the charge period.

formatdate-time

consumed_quantity: float

Specifies the quantity consumed during this charge period.

consumed_unit: str

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.

contracted_cost: float

Specifies the cost for this charge period in the billing currency.

cumulated_contracted_cost: float

Specifies the cumulated cost for the billing period in the billing currency.

cumulated_pricing_quantity: int

Specifies the cumulated pricing quantity for the billing period.

effective_cost: float

The amortized cost of the charge. PayGo has no upfront commitments, so this equals ContractedCost.

host_provider_name: str

The provider that hosts the infrastructure or platform the service runs on.

invoice_issuer_name: str

The entity that issues the invoice for this charge.

list_cost: float

The cost at published list prices, before any discount. PayGo has no commitment discounts, so this equals ContractedCost.

pricing_quantity: int

Specifies the pricing quantity for this charge period.

pricing_unit: str

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.

service_name: str

Identifies the Cloudflare service.

service_provider_name: str

The provider of the purchased service.

service_family_name: Optional[str]

Identifies the product family for the Cloudflare service.

subscription_id: Optional[str]

The identifier for the Cloudflare subscription.

zone_id: Optional[str]

The identifier for the Cloudflare zone (zone tag).

zone_name: Optional[str]

The display name of the Cloudflare zone.

Get Account Billable Usage (Version 1, Alpha)

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
response = client.billing.usage.paygo(
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(response)

{
  "errors": [
    {
      "message": "message",
      "code": 0
    }
  ],
  "messages": [
    {
      "message": "message",
      "code": 0
    }
  ],
  "result": [
    {
      "BilledCost": 0.75,
      "BillingAccountId": "023e105f4ecef8ad9ca31a8372d0c353",
      "BillingAccountName": "Example Account",
      "BillingCurrency": "USD",
      "BillingPeriodStart": "2025-02-01T00:00:00Z",
      "ChargeCategory": "Usage",
      "ChargeClass": "ChargeClass",
      "ChargeDescription": "Workers Standard usage measured in Count",
      "ChargePeriodEnd": "2025-02-02T00:00:00Z",
      "ChargePeriodStart": "2025-02-01T00:00:00Z",
      "ConsumedQuantity": 150000,
      "ConsumedUnit": "GB-months",
      "ContractedCost": 0.75,
      "CumulatedContractedCost": 2.25,
      "CumulatedPricingQuantity": 4500000,
      "EffectiveCost": 0.75,
      "HostProviderName": "Cloudflare, Inc.",
      "InvoiceIssuerName": "Cloudflare, Inc.",
      "ListCost": 0.75,
      "PricingQuantity": 150000,
      "PricingUnit": "Count",
      "ServiceName": "Workers Standard",
      "ServiceProviderName": "Cloudflare, Inc.",
      "ServiceFamilyName": "Workers",
      "SubscriptionId": "3F3CD4CQ6N7FXO7IK6NVFJBOYA",
      "ZoneId": "023e105f4ecef8ad9ca31a8372d0c353",
      "ZoneName": "example.com"
    }
  ],
  "success": true
}

Returns Examples

{
  "errors": [
    {
      "message": "message",
      "code": 0
    }
  ],
  "messages": [
    {
      "message": "message",
      "code": 0
    }
  ],
  "result": [
    {
      "BilledCost": 0.75,
      "BillingAccountId": "023e105f4ecef8ad9ca31a8372d0c353",
      "BillingAccountName": "Example Account",
      "BillingCurrency": "USD",
      "BillingPeriodStart": "2025-02-01T00:00:00Z",
      "ChargeCategory": "Usage",
      "ChargeClass": "ChargeClass",
      "ChargeDescription": "Workers Standard usage measured in Count",
      "ChargePeriodEnd": "2025-02-02T00:00:00Z",
      "ChargePeriodStart": "2025-02-01T00:00:00Z",
      "ConsumedQuantity": 150000,
      "ConsumedUnit": "GB-months",
      "ContractedCost": 0.75,
      "CumulatedContractedCost": 2.25,
      "CumulatedPricingQuantity": 4500000,
      "EffectiveCost": 0.75,
      "HostProviderName": "Cloudflare, Inc.",
      "InvoiceIssuerName": "Cloudflare, Inc.",
      "ListCost": 0.75,
      "PricingQuantity": 150000,
      "PricingUnit": "Count",
      "ServiceName": "Workers Standard",
      "ServiceProviderName": "Cloudflare, Inc.",
      "ServiceFamilyName": "Workers",
      "SubscriptionId": "3F3CD4CQ6N7FXO7IK6NVFJBOYA",
      "ZoneId": "023e105f4ecef8ad9ca31a8372d0c353",
      "ZoneName": "example.com"
    }
  ],
  "success": true
}