Get Account Billable Usage (Version 1, Alpha)

client.Billing.Usage.Paygo(ctx, params) (*[]UsagePaygoResponse, error)

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

params UsagePaygoParams

AccountID param.Field[string]

Path param: Represents a Cloudflare resource identifier tag.

maxLength32

From param.Field[Time]Optional

Query param: 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 param.Field[Time]Optional

Query param: End date for the usage query (ISO 8601).

formatdate

ReturnsExpand Collapse

type UsagePaygoResponseEnvelopeResult []UsagePaygoResponse

Contains the array of billable usage records.

BilledCost float64

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

BillingAccountID string

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

BillingAccountName string

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

BillingCurrency string

Specifies the billing currency code (ISO 4217).

BillingPeriodStart Time

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

formatdate-time

ChargeCategory UsagePaygoResponseChargeCategory

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

ChargeClass string

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

ChargeDescription string

A human-readable summary of the charge.

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

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.

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.

EffectiveCost float64

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

HostProviderName string

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

InvoiceIssuerName string

The entity that issues the invoice for this charge.

ListCost float64

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

PricingQuantity int64

Specifies the pricing quantity for this charge period.

PricingUnit string

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.

ServiceName string

Identifies the Cloudflare service.

ServiceProviderName string

The provider of the purchased service.

ServiceFamilyName stringOptional

Identifies the product family for the Cloudflare service.

SubscriptionID stringOptional

The identifier for the Cloudflare subscription.

ZoneID stringOptional

The identifier for the Cloudflare zone (zone tag).

ZoneName stringOptional

The display name of the Cloudflare zone.

Get Account Billable Usage (Version 1, Alpha)

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": [
    {
      "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
}