--- title: Usage --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [Billing](https://developers.cloudflare.com/api/typescript/resources/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)](https://developers.cloudflare.com/api/typescript/resources/billing/subresources/usage/methods/paygo_info) Deprecated client.billing.usage.paygoInfo(UsagePaygoInfoParams {account\_id } params, RequestOptionsoptions?): [UsagePaygoInfoResponse]() {covered, subscriptions } GET/accounts/{account\_id}/billable-usage/info ##### [Get Account Billable Usage (Version 1, Alpha)](https://developers.cloudflare.com/api/typescript/resources/billing/subresources/usage/methods/paygo) Deprecated client.billing.usage.paygo(UsagePaygoParams {account\_id, from, to } params, RequestOptionsoptions?): [UsagePaygoResponse]() {BilledCost, BillingAccountId, BillingAccountName, 24 more } GET/accounts/{account\_id}/billable-usage ##### [Get Account Usage (Version 2, Alpha, Restricted)](https://developers.cloudflare.com/api/typescript/resources/billing/subresources/usage/methods/get) Deprecated client.billing.usage.get(UsageGetParams {account\_id, from, to } params, RequestOptionsoptions?): [UsageGetResponse]() {ChargeCategory, ChargeDescription, ChargeFrequency, 33 more } GET/accounts/{account\_id}/billable/usage ##### [Get Account Billable Usage Info (Version 1, Alpha)](https://developers.cloudflare.com/api/typescript/resources/billing/subresources/usage/methods/get_account_usage_info_v1) client.billing.usage.getAccountUsageInfoV1(UsageGetAccountUsageInfoV1Params {account\_id } params, RequestOptionsoptions?): [UsageGetAccountUsageInfoV1Response]() {covered, subscriptions } GET/accounts/{account\_id}/billable-usage/info ##### [Get Account Billable Usage (Version 1, Alpha)](https://developers.cloudflare.com/api/typescript/resources/billing/subresources/usage/methods/get_account_usage_v1) client.billing.usage.getAccountUsageV1(UsageGetAccountUsageV1Params {account\_id, from, to } params, RequestOptionsoptions?): [UsageGetAccountUsageV1Response]() {BilledCost, BillingAccountId, BillingAccountName, 24 more } GET/accounts/{account\_id}/billable-usage ##### [Get Account Usage (Version 2, Alpha, Restricted)](https://developers.cloudflare.com/api/typescript/resources/billing/subresources/usage/methods/get_account_usage_v2) client.billing.usage.getAccountUsageV2(UsageGetAccountUsageV2Params {account\_id, from, to } params, RequestOptionsoptions?): [UsageGetAccountUsageV2Response]() {ChargeCategory, ChargeDescription, ChargeFrequency, 33 more } GET/accounts/{account\_id}/billable/usage ##### ModelsExpand Collapse
UsagePaygoInfoResponse {covered, subscriptions } Contains the usage info. covered: boolean Indicates whether the account is covered. Link to this property
subscriptions: Array<Subscription> List of subscriptions for the account. id: string The identifier for the Cloudflare subscription. Link to this property billing\_cycle\_anchor\_timestamp: string The subscription billing cycle anchor timestamp. formatdate-time Link to this property start\_timestamp: string The subscription start timestamp. formatdate-time Link to this property end\_timestamp?: string The subscription end timestamp. Omitted for active subscriptions; present only when the subscription has been cancelled. formatdate-time Link to this property
Link to this property
[Link to this property](<#(resource)%20billing.usage%20%3E%20(model)%20usage_paygo_info_response%20%3E%20(schema)>)
UsagePaygoResponse = Array<UsagePaygoResponseItem> 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. Link to this property BillingAccountId: string The identifier of the account the charge is billed to (account tag). Link to this property BillingAccountName: string| null The display name of the billing account. Null when the name could not be resolved. Link to this property BillingCurrency: string Specifies the billing currency code (ISO 4217). Link to this property BillingPeriodStart: string Indicates the start of the billing period. There is no BillingPeriodEnd counterpart; see the known gaps described on this schema. formatdate-time Link to this property ChargeCategory: "Usage" Describes the nature of the charge. Always “Usage” for this endpoint, which only returns metered usage. Link to this property ChargeClass: string| null Indicates whether the row corrects a previously invoiced billing period. Always null for this endpoint, which does not return corrections. Link to this property ChargeDescription: string| null A human-readable summary of the charge. Link to this property ChargePeriodEnd: string Indicates the end of the charge period. formatdate-time Link to this property ChargePeriodStart: string Indicates the start of the charge period. formatdate-time Link to this property ConsumedQuantity: number Specifies the quantity consumed during this charge period. Link to this property 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. Link to this property ContractedCost: number Specifies the cost for this charge period in the billing currency. Link to this property CumulatedContractedCost: number Specifies the cumulated cost for the billing period in the billing currency. Link to this property CumulatedPricingQuantity: number Specifies the portion of usage that is actually subject to a unit price. Link to this property EffectiveCost: number The amortized cost of the charge. PayGo has no upfront commitments, so this equals ContractedCost. Link to this property HostProviderName: string The provider that hosts the infrastructure or platform the service runs on. Link to this property InvoiceIssuerName: string The entity that issues the invoice for this charge. Link to this property ListCost: number The cost at published list prices, before any discount. PayGo has no commitment discounts, so this equals ContractedCost. Link to this property PricingQuantity: number Specifies the pricing quantity for this charge period. Link to this property 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. Link to this property ServiceName: string Identifies the Cloudflare service. Link to this property ServiceProviderName: string The provider of the purchased service. Link to this property ServiceFamilyName?: string Identifies the product family for the Cloudflare service. Link to this property SubscriptionId?: string| null The identifier for the Cloudflare subscription. Link to this property ZoneId?: string| null The identifier for the Cloudflare zone (zone tag). Link to this property ZoneName?: string| null The display name of the Cloudflare zone. Link to this property
[Link to this property](<#(resource)%20billing.usage%20%3E%20(model)%20usage_paygo_response%20%3E%20(schema)>)
UsageGetResponse = Array<UsageGetResponseItem> Contains the array of cost and usage records. ChargeCategory: "Usage" Highest-level classification of a charge based on the nature of how it gets billed. Currently only “Usage” is supported. Link to this property ChargeDescription: string Self-contained summary of the charge’s purpose and price. Link to this property ChargeFrequency: "Usage-Based" Indicates how often a charge occurs. Currently only “Usage-Based” is supported. Link to this property ChargePeriodEnd: string Exclusive end of the time interval during which the usage was consumed. formatdate-time Link to this property ChargePeriodStart: string Inclusive start of the time interval during which the usage was consumed. formatdate-time Link to this property ConsumedQuantity: number Measured usage amount within the charge period. Reflects raw metered consumption before pricing transformations. Link to this property ConsumedUnit: string Unit of measure for the consumed quantity (e.g., “GB”, “Requests”, “vCPU-Hours”). Link to this property HostProviderName: string Name of the entity providing the underlying infrastructure or platform. Link to this property InvoiceIssuerName: string Name of the entity responsible for invoicing for the services consumed. Link to this property ServiceProviderName: string Name of the entity that made the services available for purchase. Link to this property x\_BillableMetricId: string The unique identifier for the billable metric in the Cloudflare catalog. Cloudflare extension; replaces FOCUS SkuId. Link to this property BilledCost?: number| null 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). Link to this property BillingAccountId?: string 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. Link to this property BillingAccountName?: string Display name of the Cloudflare account. Omitted when account is not part of the requested grouping, and for usage measured at contract level. Link to this property BillingCurrency?: string| null Currency that a charge was billed in (ISO 4217). Link to this property BillingPeriodEnd?: string| null Exclusive end of the billing cycle that contains this usage record. formatdate-time Link to this property BillingPeriodStart?: string| null Inclusive start of the billing cycle that contains this usage record. formatdate-time Link to this property ChargeClass?: "Correction"| null Indicates whether the row represents a correction to one or more charges invoiced in a previous billing period. Link to this property ContractedCost?: number| null Cost calculated by multiplying ContractedUnitPrice and the corresponding PricingQuantity. Link to this property ContractedUnitPrice?: number| null 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. Link to this property EffectiveCost?: number| null 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. Link to this property ListCost?: number| null Cost calculated by multiplying ListUnitPrice and the corresponding PricingQuantity. Link to this property ListUnitPrice?: number| null Suggested provider-published unit price for a single PricingUnit of the associated billable metric, exclusive of any discounts. Link to this property PricingQuantity?: number| null Volume of a given service used or purchased, based on the PricingUnit. Link to this property PricingUnit?: string| null Provider-specified measurement unit for determining unit prices, indicating how the provider rates measured usage after applying pricing rules like block pricing. Link to this property RegionId?: string| null Provider-assigned identifier for an isolated geographic area where a service is provided. Link to this property RegionName?: string| null Name of an isolated geographic area where a service is provided. Link to this property SubAccountId?: string Unique identifier assigned to a grouping of services. For Cloudflare, this is the subscription or contract ID. Link to this property SubAccountName?: string Name assigned to a grouping of services. For Cloudflare, this is the subscription or contract display name. Link to this property
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. One of the following: string Link to this property
true true Link to this property
Link to this property
Link to this property x\_BillableMetricName?: string The display name of the billable metric. Cloudflare extension; replaces FOCUS SkuMeter. Link to this property x\_ProductCategoryName?: string The product category the charge belongs to (e.g., “Developer”, “Cloudflare One”). Cloudflare extension; replaces FOCUS ServiceCategory. Link to this property x\_ProductFamilyId?: string The unique identifier for the product family in the Cloudflare catalog. Cloudflare extension; replaces FOCUS ServiceId. Link to this property x\_ProductFamilyName?: string The product family the charge belongs to (e.g., “R2”, “Workers”). Cloudflare extension; replaces FOCUS ServiceName. Link to this property x\_ZoneId?: string| null The identifier for the Cloudflare zone (zone tag). Omitted when zone is not part of the requested grouping, and always omitted for usage measured at contract level, even when grouping by zone. Cloudflare extension. Link to this property x\_ZoneName?: string| null The display name of the Cloudflare zone. Omitted when zone is not part of the requested grouping, and for usage measured at contract level. Cloudflare extension. Link to this property
[Link to this property](<#(resource)%20billing.usage%20%3E%20(model)%20usage_get_response%20%3E%20(schema)>)
UsageGetAccountUsageInfoV1Response {covered, subscriptions } Contains the usage info. covered: boolean Indicates whether the account is covered. Link to this property
subscriptions: Array<Subscription> List of subscriptions for the account. id: string The identifier for the Cloudflare subscription. Link to this property billing\_cycle\_anchor\_timestamp: string The subscription billing cycle anchor timestamp. formatdate-time Link to this property start\_timestamp: string The subscription start timestamp. formatdate-time Link to this property end\_timestamp?: string The subscription end timestamp. Omitted for active subscriptions; present only when the subscription has been cancelled. formatdate-time Link to this property
Link to this property
[Link to this property](<#(resource)%20billing.usage%20%3E%20(model)%20usage_get_account_usage_info_v1_response%20%3E%20(schema)>)
UsageGetAccountUsageV1Response = Array<UsageGetAccountUsageV1ResponseItem> 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. Link to this property BillingAccountId: string The identifier of the account the charge is billed to (account tag). Link to this property BillingAccountName: string| null The display name of the billing account. Null when the name could not be resolved. Link to this property BillingCurrency: string Specifies the billing currency code (ISO 4217). Link to this property BillingPeriodStart: string Indicates the start of the billing period. There is no BillingPeriodEnd counterpart; see the known gaps described on this schema. formatdate-time Link to this property ChargeCategory: "Usage" Describes the nature of the charge. Always “Usage” for this endpoint, which only returns metered usage. Link to this property ChargeClass: string| null Indicates whether the row corrects a previously invoiced billing period. Always null for this endpoint, which does not return corrections. Link to this property ChargeDescription: string| null A human-readable summary of the charge. Link to this property ChargePeriodEnd: string Indicates the end of the charge period. formatdate-time Link to this property ChargePeriodStart: string Indicates the start of the charge period. formatdate-time Link to this property ConsumedQuantity: number Specifies the quantity consumed during this charge period. Link to this property 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. Link to this property ContractedCost: number Specifies the cost for this charge period in the billing currency. Link to this property CumulatedContractedCost: number Specifies the cumulated cost for the billing period in the billing currency. Link to this property CumulatedPricingQuantity: number Specifies the portion of usage that is actually subject to a unit price. Link to this property EffectiveCost: number The amortized cost of the charge. PayGo has no upfront commitments, so this equals ContractedCost. Link to this property HostProviderName: string The provider that hosts the infrastructure or platform the service runs on. Link to this property InvoiceIssuerName: string The entity that issues the invoice for this charge. Link to this property ListCost: number The cost at published list prices, before any discount. PayGo has no commitment discounts, so this equals ContractedCost. Link to this property PricingQuantity: number Specifies the pricing quantity for this charge period. Link to this property 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. Link to this property ServiceName: string Identifies the Cloudflare service. Link to this property ServiceProviderName: string The provider of the purchased service. Link to this property ServiceFamilyName?: string Identifies the product family for the Cloudflare service. Link to this property SubscriptionId?: string| null The identifier for the Cloudflare subscription. Link to this property ZoneId?: string| null The identifier for the Cloudflare zone (zone tag). Link to this property ZoneName?: string| null The display name of the Cloudflare zone. Link to this property
[Link to this property](<#(resource)%20billing.usage%20%3E%20(model)%20usage_get_account_usage_v1_response%20%3E%20(schema)>)
UsageGetAccountUsageV2Response = Array<UsageGetAccountUsageV2ResponseItem> Contains the array of cost and usage records. ChargeCategory: "Usage" Highest-level classification of a charge based on the nature of how it gets billed. Currently only “Usage” is supported. Link to this property ChargeDescription: string Self-contained summary of the charge’s purpose and price. Link to this property ChargeFrequency: "Usage-Based" Indicates how often a charge occurs. Currently only “Usage-Based” is supported. Link to this property ChargePeriodEnd: string Exclusive end of the time interval during which the usage was consumed. formatdate-time Link to this property ChargePeriodStart: string Inclusive start of the time interval during which the usage was consumed. formatdate-time Link to this property ConsumedQuantity: number Measured usage amount within the charge period. Reflects raw metered consumption before pricing transformations. Link to this property ConsumedUnit: string Unit of measure for the consumed quantity (e.g., “GB”, “Requests”, “vCPU-Hours”). Link to this property HostProviderName: string Name of the entity providing the underlying infrastructure or platform. Link to this property InvoiceIssuerName: string Name of the entity responsible for invoicing for the services consumed. Link to this property ServiceProviderName: string Name of the entity that made the services available for purchase. Link to this property x\_BillableMetricId: string The unique identifier for the billable metric in the Cloudflare catalog. Cloudflare extension; replaces FOCUS SkuId. Link to this property BilledCost?: number| null 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). Link to this property BillingAccountId?: string 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. Link to this property BillingAccountName?: string Display name of the Cloudflare account. Omitted when account is not part of the requested grouping, and for usage measured at contract level. Link to this property BillingCurrency?: string| null Currency that a charge was billed in (ISO 4217). Link to this property BillingPeriodEnd?: string| null Exclusive end of the billing cycle that contains this usage record. formatdate-time Link to this property BillingPeriodStart?: string| null Inclusive start of the billing cycle that contains this usage record. formatdate-time Link to this property ChargeClass?: "Correction"| null Indicates whether the row represents a correction to one or more charges invoiced in a previous billing period. Link to this property ContractedCost?: number| null Cost calculated by multiplying ContractedUnitPrice and the corresponding PricingQuantity. Link to this property ContractedUnitPrice?: number| null 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. Link to this property EffectiveCost?: number| null 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. Link to this property ListCost?: number| null Cost calculated by multiplying ListUnitPrice and the corresponding PricingQuantity. Link to this property ListUnitPrice?: number| null Suggested provider-published unit price for a single PricingUnit of the associated billable metric, exclusive of any discounts. Link to this property PricingQuantity?: number| null Volume of a given service used or purchased, based on the PricingUnit. Link to this property PricingUnit?: string| null Provider-specified measurement unit for determining unit prices, indicating how the provider rates measured usage after applying pricing rules like block pricing. Link to this property RegionId?: string| null Provider-assigned identifier for an isolated geographic area where a service is provided. Link to this property RegionName?: string| null Name of an isolated geographic area where a service is provided. Link to this property SubAccountId?: string Unique identifier assigned to a grouping of services. For Cloudflare, this is the subscription or contract ID. Link to this property SubAccountName?: string Name assigned to a grouping of services. For Cloudflare, this is the subscription or contract display name. Link to this property
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. One of the following: string Link to this property
true true Link to this property
Link to this property
Link to this property x\_BillableMetricName?: string The display name of the billable metric. Cloudflare extension; replaces FOCUS SkuMeter. Link to this property x\_ProductCategoryName?: string The product category the charge belongs to (e.g., “Developer”, “Cloudflare One”). Cloudflare extension; replaces FOCUS ServiceCategory. Link to this property x\_ProductFamilyId?: string The unique identifier for the product family in the Cloudflare catalog. Cloudflare extension; replaces FOCUS ServiceId. Link to this property x\_ProductFamilyName?: string The product family the charge belongs to (e.g., “R2”, “Workers”). Cloudflare extension; replaces FOCUS ServiceName. Link to this property x\_ZoneId?: string| null The identifier for the Cloudflare zone (zone tag). Omitted when zone is not part of the requested grouping, and always omitted for usage measured at contract level, even when grouping by zone. Cloudflare extension. Link to this property x\_ZoneName?: string| null The display name of the Cloudflare zone. Omitted when zone is not part of the requested grouping, and for usage measured at contract level. Cloudflare extension. Link to this property
[Link to this property](<#(resource)%20billing.usage%20%3E%20(model)%20usage_get_account_usage_v2_response%20%3E%20(schema)>)