Skip to content
Cloudflare API
Start here
API Reference
Billing
Usage

Get PayGo Account Billable Usage (Beta)

client.Billing.Usage.Paygo(ctx, params) (*[]UsagePaygoResponse, error)
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
params UsagePaygoParams
AccountID param.Field[string]

Path param: Represents a Cloudflare resource identifier tag.

maxLength32
From param.Field[Time]optional

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

formatdate
To param.Field[Time]optional

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

formatdate
ReturnsExpand Collapse
type UsagePaygoResponseEnvelopeResult []UsagePaygoResponse

Contains the array of billable usage records.

BillingCurrency string

Specifies the billing currency code (ISO 4217).

BillingPeriodStart Time

Indicates the start of the billing period.

formatdate-time
ChargePeriodEnd Time

Indicates the end of the charge period.

formatdate-time
ChargePeriodStart Time

Indicates the start of the charge period.

formatdate-time
ConsumedQuantity float64

Specifies the quantity consumed during this charge period.

ConsumedUnit string

Specifies the unit of measurement for consumed quantity.

ContractedCost float64

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

CumulatedContractedCost float64

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

CumulatedPricingQuantity int64

Specifies the cumulated pricing quantity for the billing period.

PricingQuantity int64

Specifies the pricing quantity for this charge period.

ServiceName string

Identifies the Cloudflare service.

Get PayGo Account Billable Usage (Beta)

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/billing"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  response, err := client.Billing.Usage.Paygo(context.TODO(), billing.UsagePaygoParams{
    AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", 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
}