Get PayGo Account Billable Usage (Beta)

billing.usage.paygo() -> UsagePaygoResponse

GET/accounts/{account_id}/billing/usage/paygo

Returns billable usage data for PayGo (self-serve) accounts. When no query parameters are provided, returns usage for the current billing period. This endpoint is currently in beta and access is restricted to select accounts.

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

Accepted Permissions (at least one required)

Billing WriteBilling Read

ParametersExpand Collapse

account_id: str

Represents a Cloudflare resource identifier tag.

maxLength32

from_: Optional[Union[null, null]]

Defines the start date for the usage query (e.g., 2025-02-01).

formatdate

to: Optional[Union[null, null]]

Defines the end date for the usage query (e.g., 2025-03-01).

formatdate

ReturnsExpand Collapse

List[UsagePaygoResponseItem]

Contains the array of billable usage records.

billing_currency: str

Specifies the billing currency code (ISO 4217).

billing_period_start: datetime

Indicates the start of the billing period.

formatdate-time

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

Specifies the unit of measurement for consumed quantity.

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.

pricing_quantity: int

Specifies the pricing quantity for this charge period.

service_name: str

Identifies the Cloudflare service.

Get PayGo Account Billable Usage (Beta)

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": [
    {
      "BillingCurrency": "USD",
      "BillingPeriodStart": "2025-02-01T00:00:00Z",
      "ChargePeriodEnd": "2025-02-02T00:00:00Z",
      "ChargePeriodStart": "2025-02-01T00:00:00Z",
      "ConsumedQuantity": 150000,
      "ConsumedUnit": "Requests",
      "ContractedCost": 0.75,
      "CumulatedContractedCost": 2.25,
      "CumulatedPricingQuantity": 4500000,
      "PricingQuantity": 150000,
      "ServiceName": "Workers Standard"
    }
  ],
  "success": true
}

Returns Examples

{
  "errors": [
    {
      "message": "message",
      "code": 0
    }
  ],
  "messages": [
    {
      "message": "message",
      "code": 0
    }
  ],
  "result": [
    {
      "BillingCurrency": "USD",
      "BillingPeriodStart": "2025-02-01T00:00:00Z",
      "ChargePeriodEnd": "2025-02-02T00:00:00Z",
      "ChargePeriodStart": "2025-02-01T00:00:00Z",
      "ConsumedQuantity": 150000,
      "ConsumedUnit": "Requests",
      "ContractedCost": 0.75,
      "CumulatedContractedCost": 2.25,
      "CumulatedPricingQuantity": 4500000,
      "PricingQuantity": 150000,
      "ServiceName": "Workers Standard"
    }
  ],
  "success": true
}