API Reference

Billing

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Usage

Get Account Billable Usage Info (Version 1, Alpha)

Deprecated

GET/accounts/{account_id}/billable-usage/info

Get Account Billable Usage (Version 1, Alpha)

Deprecated

GET/accounts/{account_id}/billable-usage

Get Account Usage (Version 2, Alpha, Restricted)

Deprecated

GET/accounts/{account_id}/billable/usage

Get Account Billable Usage Info (Version 1, Alpha)

GET/accounts/{account_id}/billable-usage/info

Get Account Billable Usage (Version 1, Alpha)

GET/accounts/{account_id}/billable-usage

Get Account Usage (Version 2, Alpha, Restricted)

GET/accounts/{account_id}/billable/usage

ModelsExpand Collapse

UsagePaygoInfoResponse object { covered, subscriptions }

Contains the usage info.

covered: boolean

Indicates whether the account is covered.

subscriptions: array of object { id, billing_cycle_anchor_timestamp, start_timestamp, end_timestamp }

List of subscriptions for the account.

id: string

The identifier for the Cloudflare subscription.

billing_cycle_anchor_timestamp: string

The subscription billing cycle anchor timestamp.

formatdate-time

start_timestamp: string

The subscription start timestamp.

formatdate-time

end_timestamp: optional string

The subscription end timestamp. Omitted for active subscriptions; present only when the subscription has been cancelled.

formatdate-time

UsagePaygoResponse = array of object { BilledCost, BillingAccountId, BillingAccountName, 24 more }

Contains the array of billable usage records.

BilledCost: number

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: string

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

formatdate-time

ChargeCategory: "Usage"

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: string

Indicates the end of the charge period.

formatdate-time

ChargePeriodStart: string

Indicates the start of the charge period.

formatdate-time

ConsumedQuantity: number

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: number

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

CumulatedContractedCost: number

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

CumulatedPricingQuantity: number

Specifies the cumulated pricing quantity for the billing period.

EffectiveCost: number

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: number

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

PricingQuantity: number

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: optional string

Identifies the product family for the Cloudflare service.

SubscriptionId: optional string

The identifier for the Cloudflare subscription.

ZoneId: optional string

The identifier for the Cloudflare zone (zone tag).

ZoneName: optional string

The display name of the Cloudflare zone.

UsageGetResponse = array of object { BillingAccountId, BillingAccountName, ChargeCategory, 32 more }

Contains the array of cost and usage records.

BillingAccountId: string

Public identifier of the Cloudflare account (account tag).

BillingAccountName: string

Display name of the Cloudflare account.

ChargeCategory: "Usage"

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

ChargeDescription: string

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

ChargeFrequency: "Usage-Based"

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

ChargePeriodEnd: string

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

formatdate-time

ChargePeriodStart: string

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

formatdate-time

ConsumedQuantity: number

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

ConsumedUnit: string

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

HostProviderName: string

Name of the entity providing the underlying infrastructure or platform.

InvoiceIssuerName: string

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

ServiceProviderName: string

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

x_BillableMetricId: string

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

x_BillableMetricName: string

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

BilledCost: optional number

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

BillingCurrency: optional string

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

BillingPeriodEnd: optional string

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

formatdate-time

BillingPeriodStart: optional string

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

formatdate-time

ChargeClass: optional "Correction"

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

ContractedCost: optional number

Cost calculated by multiplying ContractedUnitPrice and the corresponding PricingQuantity.

ContractedUnitPrice: optional number

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.

EffectiveCost: optional number

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.

ListCost: optional number

Cost calculated by multiplying ListUnitPrice and the corresponding PricingQuantity.

ListUnitPrice: optional number

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

PricingQuantity: optional number

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

PricingUnit: optional string

Provider-specified measurement unit for determining unit prices, indicating how the provider rates measured usage after applying pricing rules like block pricing.

RegionId: optional string

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

RegionName: optional string

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

SubAccountId: optional string

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

SubAccountName: optional string

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

x_ProductCategoryName: optional string

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

x_ProductFamilyId: optional string

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

x_ProductFamilyName: optional string

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

x_ZoneId: optional string

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

x_ZoneName: optional string

The display name of the Cloudflare zone. Cloudflare extension.

UsageGetAccountUsageInfoV1Response object { covered, subscriptions }

Contains the usage info.

covered: boolean

Indicates whether the account is covered.

subscriptions: array of object { id, billing_cycle_anchor_timestamp, start_timestamp, end_timestamp }

List of subscriptions for the account.

id: string

The identifier for the Cloudflare subscription.

billing_cycle_anchor_timestamp: string

The subscription billing cycle anchor timestamp.

formatdate-time

start_timestamp: string

The subscription start timestamp.

formatdate-time

end_timestamp: optional string

The subscription end timestamp. Omitted for active subscriptions; present only when the subscription has been cancelled.

formatdate-time

UsageGetAccountUsageV1Response = array of object { BilledCost, BillingAccountId, BillingAccountName, 24 more }

Contains the array of billable usage records.

BilledCost: number

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: string

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

formatdate-time

ChargeCategory: "Usage"

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: string

Indicates the end of the charge period.

formatdate-time

ChargePeriodStart: string

Indicates the start of the charge period.

formatdate-time

ConsumedQuantity: number

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: number

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

CumulatedContractedCost: number

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

CumulatedPricingQuantity: number

Specifies the cumulated pricing quantity for the billing period.

EffectiveCost: number

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: number

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

PricingQuantity: number

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: optional string

Identifies the product family for the Cloudflare service.

SubscriptionId: optional string

The identifier for the Cloudflare subscription.

ZoneId: optional string

The identifier for the Cloudflare zone (zone tag).

ZoneName: optional string

The display name of the Cloudflare zone.

UsageGetAccountUsageV2Response = array of object { BillingAccountId, BillingAccountName, ChargeCategory, 32 more }

Contains the array of cost and usage records.

BillingAccountId: string

Public identifier of the Cloudflare account (account tag).

BillingAccountName: string

Display name of the Cloudflare account.

ChargeCategory: "Usage"

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

ChargeDescription: string

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

ChargeFrequency: "Usage-Based"

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

ChargePeriodEnd: string

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

formatdate-time

ChargePeriodStart: string

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

formatdate-time

ConsumedQuantity: number

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

ConsumedUnit: string

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

HostProviderName: string

Name of the entity providing the underlying infrastructure or platform.

InvoiceIssuerName: string

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

ServiceProviderName: string

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

x_BillableMetricId: string

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

x_BillableMetricName: string

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

BilledCost: optional number

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

BillingCurrency: optional string

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

BillingPeriodEnd: optional string

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

formatdate-time

BillingPeriodStart: optional string

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

formatdate-time

ChargeClass: optional "Correction"

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

ContractedCost: optional number

Cost calculated by multiplying ContractedUnitPrice and the corresponding PricingQuantity.

ContractedUnitPrice: optional number

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.

EffectiveCost: optional number

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.

ListCost: optional number

Cost calculated by multiplying ListUnitPrice and the corresponding PricingQuantity.

ListUnitPrice: optional number

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

PricingQuantity: optional number

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

PricingUnit: optional string

Provider-specified measurement unit for determining unit prices, indicating how the provider rates measured usage after applying pricing rules like block pricing.

RegionId: optional string

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

RegionName: optional string

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

SubAccountId: optional string

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

SubAccountName: optional string

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

x_ProductCategoryName: optional string

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

x_ProductFamilyId: optional string

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

x_ProductFamilyName: optional string

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

x_ZoneId: optional string

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

x_ZoneName: optional string

The display name of the Cloudflare zone. Cloudflare extension.