Usage
Get Account Billable Usage Info (Version 1, Alpha)
Get Account Billable Usage Info (Version 1, Alpha)
Get Account Billable Usage (Version 1, Alpha)
Get Account Usage (Version 2, Alpha, Restricted)
ModelsExpand Collapse
UsagePaygoInfoResponse object { covered, subscriptions } Contains the usage info.
Contains the usage info.
UsagePaygoResponse = array of object { BilledCost, BillingAccountId, BillingAccountName, 24 more } Contains the array of billable usage records.
Contains the array of billable usage records.
The amount invoiced for this charge. PayGo is billed directly by Cloudflare, so this equals ContractedCost.
The display name of the billing account. Null when the name could not be resolved.
Indicates the start of the billing period. There is no BillingPeriodEnd counterpart; see the known gaps described on this schema.
Describes the nature of the charge. Always “Usage” for this endpoint, which only returns metered usage.
Indicates whether the row corrects a previously invoiced billing period. Always null for this endpoint, which does not return corrections.
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.
Specifies the cumulated cost for the billing period in the billing currency.
Specifies the portion of usage that is actually subject to a unit price.
The amortized cost of the charge. PayGo has no upfront commitments, so this equals ContractedCost.
The cost at published list prices, before any discount. PayGo has no commitment discounts, so this equals ContractedCost.
UsageGetResponse = array of object { ChargeCategory, ChargeDescription, ChargeFrequency, 33 more } Contains the array of cost and usage records.
Contains the array of cost and usage records.
Highest-level classification of a charge based on the nature of how it gets billed. Currently only “Usage” is supported.
Indicates how often a charge occurs. Currently only “Usage-Based” is supported.
Exclusive end of the time interval during which the usage was consumed.
Inclusive start of the time interval during which the usage was consumed.
Measured usage amount within the charge period. Reflects raw metered consumption before pricing transformations.
Unit of measure for the consumed quantity (e.g., “GB”, “Requests”, “vCPU-Hours”).
The unique identifier for the billable metric in the Cloudflare catalog. Cloudflare extension; replaces FOCUS SkuId.
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).
Public identifier of the Cloudflare account (account tag). Omitted when account is not part of the requested grouping, and always omitted for usage measured at contract level, even when grouping by account: that usage is returned as its own record with no account.
Display name of the Cloudflare account. Omitted when account is not part of the requested grouping, and for usage measured at contract level.
Exclusive end of the billing cycle that contains this usage record.
Inclusive start of the billing cycle that contains this usage record.
Indicates whether the row represents a correction to one or more charges invoiced in a previous billing period.
Cost calculated by multiplying ContractedUnitPrice and the corresponding PricingQuantity.
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.
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.
Cost calculated by multiplying ListUnitPrice and the corresponding PricingQuantity.
Suggested provider-published unit price for a single PricingUnit of the associated billable metric, exclusive of any discounts.
Volume of a given service used or purchased, based on the PricingUnit.
Provider-specified measurement unit for determining unit prices, indicating how the provider rates measured usage after applying pricing rules like block pricing.
Provider-assigned identifier for an isolated geographic area where a service is provided.
Unique identifier assigned to a grouping of services. For Cloudflare, this is the subscription or contract ID.
Name assigned to a grouping of services. For Cloudflare, this is the subscription or contract display name.
Tags: optional map[string or true]Tag values for the requested GroupBy keys. Omitted when GroupBy is not provided. Missing keys are omitted, and key-only tags are returned as boolean true. All other tag values are strings.
Tag values for the requested GroupBy keys. Omitted when GroupBy is not provided. Missing keys are omitted, and key-only tags are returned as boolean true. All other tag values are strings.
The display name of the billable metric. Cloudflare extension; replaces FOCUS SkuMeter.
The product category the charge belongs to (e.g., “Developer”, “Cloudflare One”). Cloudflare extension; replaces FOCUS ServiceCategory.
The unique identifier for the product family in the Cloudflare catalog. Cloudflare extension; replaces FOCUS ServiceId.
The product family the charge belongs to (e.g., “R2”, “Workers”). Cloudflare extension; replaces FOCUS ServiceName.
UsageGetAccountUsageInfoV1Response object { covered, subscriptions } Contains the usage info.
Contains the usage info.
UsageGetAccountUsageV1Response = array of object { BilledCost, BillingAccountId, BillingAccountName, 24 more } Contains the array of billable usage records.
Contains the array of billable usage records.
The amount invoiced for this charge. PayGo is billed directly by Cloudflare, so this equals ContractedCost.
The display name of the billing account. Null when the name could not be resolved.
Indicates the start of the billing period. There is no BillingPeriodEnd counterpart; see the known gaps described on this schema.
Describes the nature of the charge. Always “Usage” for this endpoint, which only returns metered usage.
Indicates whether the row corrects a previously invoiced billing period. Always null for this endpoint, which does not return corrections.
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.
Specifies the cumulated cost for the billing period in the billing currency.
Specifies the portion of usage that is actually subject to a unit price.
The amortized cost of the charge. PayGo has no upfront commitments, so this equals ContractedCost.
The cost at published list prices, before any discount. PayGo has no commitment discounts, so this equals ContractedCost.
UsageGetAccountUsageV2Response = array of object { ChargeCategory, ChargeDescription, ChargeFrequency, 33 more } Contains the array of cost and usage records.
Contains the array of cost and usage records.
Highest-level classification of a charge based on the nature of how it gets billed. Currently only “Usage” is supported.
Indicates how often a charge occurs. Currently only “Usage-Based” is supported.
Exclusive end of the time interval during which the usage was consumed.
Inclusive start of the time interval during which the usage was consumed.
Measured usage amount within the charge period. Reflects raw metered consumption before pricing transformations.
Unit of measure for the consumed quantity (e.g., “GB”, “Requests”, “vCPU-Hours”).
The unique identifier for the billable metric in the Cloudflare catalog. Cloudflare extension; replaces FOCUS SkuId.
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).
Public identifier of the Cloudflare account (account tag). Omitted when account is not part of the requested grouping, and always omitted for usage measured at contract level, even when grouping by account: that usage is returned as its own record with no account.
Display name of the Cloudflare account. Omitted when account is not part of the requested grouping, and for usage measured at contract level.
Exclusive end of the billing cycle that contains this usage record.
Inclusive start of the billing cycle that contains this usage record.
Indicates whether the row represents a correction to one or more charges invoiced in a previous billing period.
Cost calculated by multiplying ContractedUnitPrice and the corresponding PricingQuantity.
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.
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.
Cost calculated by multiplying ListUnitPrice and the corresponding PricingQuantity.
Suggested provider-published unit price for a single PricingUnit of the associated billable metric, exclusive of any discounts.
Volume of a given service used or purchased, based on the PricingUnit.
Provider-specified measurement unit for determining unit prices, indicating how the provider rates measured usage after applying pricing rules like block pricing.
Provider-assigned identifier for an isolated geographic area where a service is provided.
Unique identifier assigned to a grouping of services. For Cloudflare, this is the subscription or contract ID.
Name assigned to a grouping of services. For Cloudflare, this is the subscription or contract display name.
Tags: optional map[string or true]Tag values for the requested GroupBy keys. Omitted when GroupBy is not provided. Missing keys are omitted, and key-only tags are returned as boolean true. All other tag values are strings.
Tag values for the requested GroupBy keys. Omitted when GroupBy is not provided. Missing keys are omitted, and key-only tags are returned as boolean true. All other tag values are strings.
The display name of the billable metric. Cloudflare extension; replaces FOCUS SkuMeter.
The product category the charge belongs to (e.g., “Developer”, “Cloudflare One”). Cloudflare extension; replaces FOCUS ServiceCategory.
The unique identifier for the product family in the Cloudflare catalog. Cloudflare extension; replaces FOCUS ServiceId.
The product family the charge belongs to (e.g., “R2”, “Workers”). Cloudflare extension; replaces FOCUS ServiceName.