Billing
Validate Billing Address
BillingSpend Policies
List Spend Policies
Create Spend Policy
Get Spend Policy
Update Spend Policy
Delete Spend Policy
ModelsExpand Collapse
SpendPolicyListResponse { id, account_id, action, 7 more } A spend policy.
A spend policy.
Internal numeric ID of the account that owns the policy. This is not the account tag used in the path.
action: "notification" | "usage_block"The action taken when the threshold is reached. notification sends an email to notification_email. usage_block blocks further usage of the product until the end of the billing period. Raising the threshold above the current balance, disabling the policy, or deleting it lifts the block early.
The action taken when the threshold is reached. notification sends an email to notification_email. usage_block blocks further usage of the product until the end of the billing period. Raising the threshold above the current balance, disabling the policy, or deleting it lifts the block early.
Email address that receives notifications. An empty string when none is set.
product_id: "workers" | "durable_objects"The product the policy applies to: workers or durable_objects. Each product’s balance and policies are separate. Both products support notification and usage_block policies on create and update.
The product the policy applies to: workers or durable_objects. Each product’s balance and policies are separate. Both products support notification and usage_block policies on create and update.
Optimistic-concurrency version. It starts at 1 and goes up by one on every update or delete. This value is also returned in ETag.
current_state?: CurrentState { balance_cents, billing_period_end, billing_period_start, 3 more } Read-only state on list/get responses, evaluated from the latest owning projector snapshot at request time, independently of the API replica. Configuration enabled/version/ETag do not change when a cycle rolls over. Audit history remains unchanged. Missing during a rolling upgrade or on mutation responses; clients must treat missing state as unavailable. Balances are asynchronous estimates, not a synchronous usage read.
Read-only state on list/get responses, evaluated from the latest owning projector snapshot at request time, independently of the API replica. Configuration enabled/version/ETag do not change when a cycle rolls over. Audit history remains unchanged. Missing during a rolling upgrade or on mutation responses; clients must treat missing state as unavailable. Balances are asynchronous estimates, not a synchronous usage read.
enforcement: Enforcement | nullDurable desired cap and delivery bookkeeping for this policy, or null if no owned effect exists. Separate from threshold evaluation: pending/leased/retry can lag the new billing period. Succeeded with equal generations means delivery completed, not an EWC readback.
Durable desired cap and delivery bookkeeping for this policy, or null if no owned effect exists. Separate from threshold evaluation: pending/leased/retry can lag the new billing period. Succeeded with equal generations means delivery completed, not an EWC readback.
status: "disabled" | "no_current_period" | "unavailable" | 2 moreThreshold evaluation, not proof of an edge cap. No current active period yields no_current_period for enabled policies; failed aggregate reads yield unavailable for enabled policies. Disabled policies report disabled. Neither no_current_period nor unavailable implies a zero balance or below-limit state. Operators may disable current-state reads, in which case current_state is omitted.
Threshold evaluation, not proof of an edge cap. No current active period yields no_current_period for enabled policies; failed aggregate reads yield unavailable for enabled policies. Disabled policies report disabled. Neither no_current_period nor unavailable implies a zero balance or below-limit state. Operators may disable current-state reads, in which case current_state is omitted.
SpendPolicyCreateResponse { id, account_id, action, 7 more } A spend policy.
A spend policy.
Internal numeric ID of the account that owns the policy. This is not the account tag used in the path.
action: "notification" | "usage_block"The action taken when the threshold is reached. notification sends an email to notification_email. usage_block blocks further usage of the product until the end of the billing period. Raising the threshold above the current balance, disabling the policy, or deleting it lifts the block early.
The action taken when the threshold is reached. notification sends an email to notification_email. usage_block blocks further usage of the product until the end of the billing period. Raising the threshold above the current balance, disabling the policy, or deleting it lifts the block early.
Email address that receives notifications. An empty string when none is set.
product_id: "workers" | "durable_objects"The product the policy applies to: workers or durable_objects. Each product’s balance and policies are separate. Both products support notification and usage_block policies on create and update.
The product the policy applies to: workers or durable_objects. Each product’s balance and policies are separate. Both products support notification and usage_block policies on create and update.
Optimistic-concurrency version. It starts at 1 and goes up by one on every update or delete. This value is also returned in ETag.
current_state?: CurrentState { balance_cents, billing_period_end, billing_period_start, 3 more } Read-only state on list/get responses, evaluated from the latest owning projector snapshot at request time, independently of the API replica. Configuration enabled/version/ETag do not change when a cycle rolls over. Audit history remains unchanged. Missing during a rolling upgrade or on mutation responses; clients must treat missing state as unavailable. Balances are asynchronous estimates, not a synchronous usage read.
Read-only state on list/get responses, evaluated from the latest owning projector snapshot at request time, independently of the API replica. Configuration enabled/version/ETag do not change when a cycle rolls over. Audit history remains unchanged. Missing during a rolling upgrade or on mutation responses; clients must treat missing state as unavailable. Balances are asynchronous estimates, not a synchronous usage read.
enforcement: Enforcement | nullDurable desired cap and delivery bookkeeping for this policy, or null if no owned effect exists. Separate from threshold evaluation: pending/leased/retry can lag the new billing period. Succeeded with equal generations means delivery completed, not an EWC readback.
Durable desired cap and delivery bookkeeping for this policy, or null if no owned effect exists. Separate from threshold evaluation: pending/leased/retry can lag the new billing period. Succeeded with equal generations means delivery completed, not an EWC readback.
status: "disabled" | "no_current_period" | "unavailable" | 2 moreThreshold evaluation, not proof of an edge cap. No current active period yields no_current_period for enabled policies; failed aggregate reads yield unavailable for enabled policies. Disabled policies report disabled. Neither no_current_period nor unavailable implies a zero balance or below-limit state. Operators may disable current-state reads, in which case current_state is omitted.
Threshold evaluation, not proof of an edge cap. No current active period yields no_current_period for enabled policies; failed aggregate reads yield unavailable for enabled policies. Disabled policies report disabled. Neither no_current_period nor unavailable implies a zero balance or below-limit state. Operators may disable current-state reads, in which case current_state is omitted.
SpendPolicyGetResponse { id, account_id, action, 7 more } A spend policy.
A spend policy.
Internal numeric ID of the account that owns the policy. This is not the account tag used in the path.
action: "notification" | "usage_block"The action taken when the threshold is reached. notification sends an email to notification_email. usage_block blocks further usage of the product until the end of the billing period. Raising the threshold above the current balance, disabling the policy, or deleting it lifts the block early.
The action taken when the threshold is reached. notification sends an email to notification_email. usage_block blocks further usage of the product until the end of the billing period. Raising the threshold above the current balance, disabling the policy, or deleting it lifts the block early.
Email address that receives notifications. An empty string when none is set.
product_id: "workers" | "durable_objects"The product the policy applies to: workers or durable_objects. Each product’s balance and policies are separate. Both products support notification and usage_block policies on create and update.
The product the policy applies to: workers or durable_objects. Each product’s balance and policies are separate. Both products support notification and usage_block policies on create and update.
Optimistic-concurrency version. It starts at 1 and goes up by one on every update or delete. This value is also returned in ETag.
current_state?: CurrentState { balance_cents, billing_period_end, billing_period_start, 3 more } Read-only state on list/get responses, evaluated from the latest owning projector snapshot at request time, independently of the API replica. Configuration enabled/version/ETag do not change when a cycle rolls over. Audit history remains unchanged. Missing during a rolling upgrade or on mutation responses; clients must treat missing state as unavailable. Balances are asynchronous estimates, not a synchronous usage read.
Read-only state on list/get responses, evaluated from the latest owning projector snapshot at request time, independently of the API replica. Configuration enabled/version/ETag do not change when a cycle rolls over. Audit history remains unchanged. Missing during a rolling upgrade or on mutation responses; clients must treat missing state as unavailable. Balances are asynchronous estimates, not a synchronous usage read.
enforcement: Enforcement | nullDurable desired cap and delivery bookkeeping for this policy, or null if no owned effect exists. Separate from threshold evaluation: pending/leased/retry can lag the new billing period. Succeeded with equal generations means delivery completed, not an EWC readback.
Durable desired cap and delivery bookkeeping for this policy, or null if no owned effect exists. Separate from threshold evaluation: pending/leased/retry can lag the new billing period. Succeeded with equal generations means delivery completed, not an EWC readback.
status: "disabled" | "no_current_period" | "unavailable" | 2 moreThreshold evaluation, not proof of an edge cap. No current active period yields no_current_period for enabled policies; failed aggregate reads yield unavailable for enabled policies. Disabled policies report disabled. Neither no_current_period nor unavailable implies a zero balance or below-limit state. Operators may disable current-state reads, in which case current_state is omitted.
Threshold evaluation, not proof of an edge cap. No current active period yields no_current_period for enabled policies; failed aggregate reads yield unavailable for enabled policies. Disabled policies report disabled. Neither no_current_period nor unavailable implies a zero balance or below-limit state. Operators may disable current-state reads, in which case current_state is omitted.
SpendPolicyUpdateResponse { id, account_id, action, 7 more } A spend policy.
A spend policy.
Internal numeric ID of the account that owns the policy. This is not the account tag used in the path.
action: "notification" | "usage_block"The action taken when the threshold is reached. notification sends an email to notification_email. usage_block blocks further usage of the product until the end of the billing period. Raising the threshold above the current balance, disabling the policy, or deleting it lifts the block early.
The action taken when the threshold is reached. notification sends an email to notification_email. usage_block blocks further usage of the product until the end of the billing period. Raising the threshold above the current balance, disabling the policy, or deleting it lifts the block early.
Email address that receives notifications. An empty string when none is set.
product_id: "workers" | "durable_objects"The product the policy applies to: workers or durable_objects. Each product’s balance and policies are separate. Both products support notification and usage_block policies on create and update.
The product the policy applies to: workers or durable_objects. Each product’s balance and policies are separate. Both products support notification and usage_block policies on create and update.
Optimistic-concurrency version. It starts at 1 and goes up by one on every update or delete. This value is also returned in ETag.
current_state?: CurrentState { balance_cents, billing_period_end, billing_period_start, 3 more } Read-only state on list/get responses, evaluated from the latest owning projector snapshot at request time, independently of the API replica. Configuration enabled/version/ETag do not change when a cycle rolls over. Audit history remains unchanged. Missing during a rolling upgrade or on mutation responses; clients must treat missing state as unavailable. Balances are asynchronous estimates, not a synchronous usage read.
Read-only state on list/get responses, evaluated from the latest owning projector snapshot at request time, independently of the API replica. Configuration enabled/version/ETag do not change when a cycle rolls over. Audit history remains unchanged. Missing during a rolling upgrade or on mutation responses; clients must treat missing state as unavailable. Balances are asynchronous estimates, not a synchronous usage read.
enforcement: Enforcement | nullDurable desired cap and delivery bookkeeping for this policy, or null if no owned effect exists. Separate from threshold evaluation: pending/leased/retry can lag the new billing period. Succeeded with equal generations means delivery completed, not an EWC readback.
Durable desired cap and delivery bookkeeping for this policy, or null if no owned effect exists. Separate from threshold evaluation: pending/leased/retry can lag the new billing period. Succeeded with equal generations means delivery completed, not an EWC readback.
status: "disabled" | "no_current_period" | "unavailable" | 2 moreThreshold evaluation, not proof of an edge cap. No current active period yields no_current_period for enabled policies; failed aggregate reads yield unavailable for enabled policies. Disabled policies report disabled. Neither no_current_period nor unavailable implies a zero balance or below-limit state. Operators may disable current-state reads, in which case current_state is omitted.
Threshold evaluation, not proof of an edge cap. No current active period yields no_current_period for enabled policies; failed aggregate reads yield unavailable for enabled policies. Disabled policies report disabled. Neither no_current_period nor unavailable implies a zero balance or below-limit state. Operators may disable current-state reads, in which case current_state is omitted.
BillingSpend PoliciesAudit
List Spend Policy Audit Entries
ModelsExpand Collapse
AuditListResponse { action, balance_cents, billing_period_end, 7 more } A state transition recorded when the policy was evaluated against the account’s balance.
A state transition recorded when the policy was evaluated against the account’s balance.
action: "notification" | "usage_block"The action taken when the threshold is reached. notification sends an email to notification_email. usage_block blocks further usage of the product until the end of the billing period. Raising the threshold above the current balance, disabling the policy, or deleting it lifts the block early.
The action taken when the threshold is reached. notification sends an email to notification_email. usage_block blocks further usage of the product until the end of the billing period. Raising the threshold above the current balance, disabling the policy, or deleting it lifts the block early.
The account’s balance for the product at evaluation time, in US cents.
Inclusive start of the billing period that was evaluated.
BillingSpend PoliciesActivity
List Spend Policy Activity
ModelsExpand Collapse
ActivityListResponse { id, action, actor, 5 more }
details: Details { after, before }
after?: After { id, account_id, action, 7 more } A spend policy.
A spend policy.
Internal numeric ID of the account that owns the policy. This is not the account tag used in the path.
action: "notification" | "usage_block"The action taken when the threshold is reached. notification sends an email to notification_email. usage_block blocks further usage of the product until the end of the billing period. Raising the threshold above the current balance, disabling the policy, or deleting it lifts the block early.
The action taken when the threshold is reached. notification sends an email to notification_email. usage_block blocks further usage of the product until the end of the billing period. Raising the threshold above the current balance, disabling the policy, or deleting it lifts the block early.
Email address that receives notifications. An empty string when none is set.
product_id: "workers" | "durable_objects"The product the policy applies to: workers or durable_objects. Each product’s balance and policies are separate. Both products support notification and usage_block policies on create and update.
The product the policy applies to: workers or durable_objects. Each product’s balance and policies are separate. Both products support notification and usage_block policies on create and update.
Optimistic-concurrency version. It starts at 1 and goes up by one on every update or delete. This value is also returned in ETag.
current_state?: CurrentState { balance_cents, billing_period_end, billing_period_start, 3 more } Read-only state on list/get responses, evaluated from the latest owning projector snapshot at request time, independently of the API replica. Configuration enabled/version/ETag do not change when a cycle rolls over. Audit history remains unchanged. Missing during a rolling upgrade or on mutation responses; clients must treat missing state as unavailable. Balances are asynchronous estimates, not a synchronous usage read.
Read-only state on list/get responses, evaluated from the latest owning projector snapshot at request time, independently of the API replica. Configuration enabled/version/ETag do not change when a cycle rolls over. Audit history remains unchanged. Missing during a rolling upgrade or on mutation responses; clients must treat missing state as unavailable. Balances are asynchronous estimates, not a synchronous usage read.
enforcement: Enforcement | nullDurable desired cap and delivery bookkeeping for this policy, or null if no owned effect exists. Separate from threshold evaluation: pending/leased/retry can lag the new billing period. Succeeded with equal generations means delivery completed, not an EWC readback.
Durable desired cap and delivery bookkeeping for this policy, or null if no owned effect exists. Separate from threshold evaluation: pending/leased/retry can lag the new billing period. Succeeded with equal generations means delivery completed, not an EWC readback.
status: "disabled" | "no_current_period" | "unavailable" | 2 moreThreshold evaluation, not proof of an edge cap. No current active period yields no_current_period for enabled policies; failed aggregate reads yield unavailable for enabled policies. Disabled policies report disabled. Neither no_current_period nor unavailable implies a zero balance or below-limit state. Operators may disable current-state reads, in which case current_state is omitted.
Threshold evaluation, not proof of an edge cap. No current active period yields no_current_period for enabled policies; failed aggregate reads yield unavailable for enabled policies. Disabled policies report disabled. Neither no_current_period nor unavailable implies a zero balance or below-limit state. Operators may disable current-state reads, in which case current_state is omitted.
before?: Before | nullPrior configuration; null on creation or if a previous revision is unavailable.
Prior configuration; null on creation or if a previous revision is unavailable.
Internal numeric ID of the account that owns the policy. This is not the account tag used in the path.
action: "notification" | "usage_block"The action taken when the threshold is reached. notification sends an email to notification_email. usage_block blocks further usage of the product until the end of the billing period. Raising the threshold above the current balance, disabling the policy, or deleting it lifts the block early.
The action taken when the threshold is reached. notification sends an email to notification_email. usage_block blocks further usage of the product until the end of the billing period. Raising the threshold above the current balance, disabling the policy, or deleting it lifts the block early.
Email address that receives notifications. An empty string when none is set.
product_id: "workers" | "durable_objects"The product the policy applies to: workers or durable_objects. Each product’s balance and policies are separate. Both products support notification and usage_block policies on create and update.
The product the policy applies to: workers or durable_objects. Each product’s balance and policies are separate. Both products support notification and usage_block policies on create and update.
Optimistic-concurrency version. It starts at 1 and goes up by one on every update or delete. This value is also returned in ETag.
current_state?: CurrentState { balance_cents, billing_period_end, billing_period_start, 3 more } Read-only state on list/get responses, evaluated from the latest owning projector snapshot at request time, independently of the API replica. Configuration enabled/version/ETag do not change when a cycle rolls over. Audit history remains unchanged. Missing during a rolling upgrade or on mutation responses; clients must treat missing state as unavailable. Balances are asynchronous estimates, not a synchronous usage read.
Read-only state on list/get responses, evaluated from the latest owning projector snapshot at request time, independently of the API replica. Configuration enabled/version/ETag do not change when a cycle rolls over. Audit history remains unchanged. Missing during a rolling upgrade or on mutation responses; clients must treat missing state as unavailable. Balances are asynchronous estimates, not a synchronous usage read.
enforcement: Enforcement | nullDurable desired cap and delivery bookkeeping for this policy, or null if no owned effect exists. Separate from threshold evaluation: pending/leased/retry can lag the new billing period. Succeeded with equal generations means delivery completed, not an EWC readback.
Durable desired cap and delivery bookkeeping for this policy, or null if no owned effect exists. Separate from threshold evaluation: pending/leased/retry can lag the new billing period. Succeeded with equal generations means delivery completed, not an EWC readback.
status: "disabled" | "no_current_period" | "unavailable" | 2 moreThreshold evaluation, not proof of an edge cap. No current active period yields no_current_period for enabled policies; failed aggregate reads yield unavailable for enabled policies. Disabled policies report disabled. Neither no_current_period nor unavailable implies a zero balance or below-limit state. Operators may disable current-state reads, in which case current_state is omitted.
Threshold evaluation, not proof of an edge cap. No current active period yields no_current_period for enabled policies; failed aggregate reads yield unavailable for enabled policies. Disabled policies report disabled. Neither no_current_period nor unavailable implies a zero balance or below-limit state. Operators may disable current-state reads, in which case current_state is omitted.
BillingProfiles
Get Billing Profile
Create Billing Profile
Update Billing Profile
Delete Billing Profile
Update Billing Email
BillingProfilesPayment Method
Create Payment Intent for Billing Profile
BillingUsage
Get Account Billable Usage Info (Version 1, Alpha)
Get Account Billable Usage (Version 1, Alpha)
Get Account Usage (Version 2, Alpha, Restricted)
Get Account Billable Usage Info (Version 1, Alpha)
Get Account Billable Usage (Version 1, Alpha)
Get Account Usage (Version 2, Alpha, Restricted)
ModelsExpand Collapse
UsagePaygoResponse = Array<UsagePaygoResponseItem>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<UsageGetResponseItem>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.
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.
Measured usage amount within the charge period. Reflects raw metered consumption before pricing transformations.
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?: Record<string, string | 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.
UsageGetAccountUsageV1Response = Array<UsageGetAccountUsageV1ResponseItem>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<UsageGetAccountUsageV2ResponseItem>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.
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.
Measured usage amount within the charge period. Reflects raw metered consumption before pricing transformations.
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?: Record<string, string | 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.