--- title: Usage --- [Skip to content](#%5Ftop) [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%5Finfo) Deprecated client.billing.usage.paygoInfo(UsagePaygoInfoParams { account\_id } params, RequestOptionsoptions?): [UsagePaygoInfoResponse](https://developers.cloudflare.com/api/typescript/resources/billing#%28resource%29%20billing.usage%20%3E%20%28model%29%20usage%5Fpaygo%5Finfo%5Fresponse%20%3E%20%28schema%29) { 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](https://developers.cloudflare.com/api/typescript/resources/billing#%28resource%29%20billing.usage%20%3E%20%28model%29%20usage%5Fpaygo%5Fresponse%20%3E%20%28schema%29) { 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](https://developers.cloudflare.com/api/typescript/resources/billing#%28resource%29%20billing.usage%20%3E%20%28model%29%20usage%5Fget%5Fresponse%20%3E%20%28schema%29) { BillingAccountId, BillingAccountName, ChargeCategory, 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%5Faccount%5Fusage%5Finfo%5Fv1) client.billing.usage.getAccountUsageInfoV1(UsageGetAccountUsageInfoV1Params { account\_id } params, RequestOptionsoptions?): [UsageGetAccountUsageInfoV1Response](https://developers.cloudflare.com/api/typescript/resources/billing#%28resource%29%20billing.usage%20%3E%20%28model%29%20usage%5Fget%5Faccount%5Fusage%5Finfo%5Fv1%5Fresponse%20%3E%20%28schema%29) { 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%5Faccount%5Fusage%5Fv1) client.billing.usage.getAccountUsageV1(UsageGetAccountUsageV1Params { account\_id, from, to } params, RequestOptionsoptions?): [UsageGetAccountUsageV1Response](https://developers.cloudflare.com/api/typescript/resources/billing#%28resource%29%20billing.usage%20%3E%20%28model%29%20usage%5Fget%5Faccount%5Fusage%5Fv1%5Fresponse%20%3E%20%28schema%29) { 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%5Faccount%5Fusage%5Fv2) client.billing.usage.getAccountUsageV2(UsageGetAccountUsageV2Params { account\_id, from, to } params, RequestOptionsoptions?): [UsageGetAccountUsageV2Response](https://developers.cloudflare.com/api/typescript/resources/billing#%28resource%29%20billing.usage%20%3E%20%28model%29%20usage%5Fget%5Faccount%5Fusage%5Fv2%5Fresponse%20%3E%20%28schema%29) { BillingAccountId, BillingAccountName, ChargeCategory, 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. subscriptions: Array 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?: string The subscription end timestamp. Omitted for active subscriptions; present only when the subscription has been cancelled. formatdate-time UsagePaygoResponse \= Array 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 | null 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 | null Indicates whether the row corrects a previously invoiced billing period. Always null for this endpoint, which does not return corrections. ChargeDescription: string | null 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 portion of usage that is actually subject to a unit price. 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?: string Identifies the product family for the Cloudflare service. SubscriptionId?: string | null The identifier for the Cloudflare subscription. ZoneId?: string | null The identifier for the Cloudflare zone (zone tag). ZoneName?: string | null The display name of the Cloudflare zone. UsageGetResponse \= Array 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?: 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). BillingCurrency?: string | null Currency that a charge was billed in (ISO 4217). BillingPeriodEnd?: string | null Exclusive end of the billing cycle that contains this usage record. formatdate-time BillingPeriodStart?: string | null Inclusive start of the billing cycle that contains this usage record. formatdate-time ChargeClass?: "Correction" | null Indicates whether the row represents a correction to one or more charges invoiced in a previous billing period. ContractedCost?: number | null Cost calculated by multiplying ContractedUnitPrice and the corresponding PricingQuantity. 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. 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. ListCost?: number | null Cost calculated by multiplying ListUnitPrice and the corresponding PricingQuantity. ListUnitPrice?: number | null Suggested provider-published unit price for a single PricingUnit of the associated billable metric, exclusive of any discounts. PricingQuantity?: number | null Volume of a given service used or purchased, based on the PricingUnit. 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. RegionId?: string | null Provider-assigned identifier for an isolated geographic area where a service is provided. RegionName?: string | null Name of an isolated geographic area where a service is provided. SubAccountId?: string Unique identifier assigned to a grouping of services. For Cloudflare, this is the subscription or contract ID. SubAccountName?: string Name assigned to a grouping of services. For Cloudflare, this is the subscription or contract display name. Tags?: Record 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 true true x\_ProductCategoryName?: string The product category the charge belongs to (e.g., “Developer”, “Cloudflare One”). Cloudflare extension; replaces FOCUS ServiceCategory. x\_ProductFamilyId?: string The unique identifier for the product family in the Cloudflare catalog. Cloudflare extension; replaces FOCUS ServiceId. x\_ProductFamilyName?: string The product family the charge belongs to (e.g., “R2”, “Workers”). Cloudflare extension; replaces FOCUS ServiceName. x\_ZoneId?: string | null The identifier for the Cloudflare zone (zone tag). Cloudflare extension. x\_ZoneName?: string | null The display name of the Cloudflare zone. Cloudflare extension. UsageGetAccountUsageInfoV1Response { covered, subscriptions } Contains the usage info. covered: boolean Indicates whether the account is covered. subscriptions: Array 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?: string The subscription end timestamp. Omitted for active subscriptions; present only when the subscription has been cancelled. formatdate-time UsageGetAccountUsageV1Response \= Array 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 | null 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 | null Indicates whether the row corrects a previously invoiced billing period. Always null for this endpoint, which does not return corrections. ChargeDescription: string | null 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 portion of usage that is actually subject to a unit price. 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?: string Identifies the product family for the Cloudflare service. SubscriptionId?: string | null The identifier for the Cloudflare subscription. ZoneId?: string | null The identifier for the Cloudflare zone (zone tag). ZoneName?: string | null The display name of the Cloudflare zone. UsageGetAccountUsageV2Response \= Array 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?: 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). BillingCurrency?: string | null Currency that a charge was billed in (ISO 4217). BillingPeriodEnd?: string | null Exclusive end of the billing cycle that contains this usage record. formatdate-time BillingPeriodStart?: string | null Inclusive start of the billing cycle that contains this usage record. formatdate-time ChargeClass?: "Correction" | null Indicates whether the row represents a correction to one or more charges invoiced in a previous billing period. ContractedCost?: number | null Cost calculated by multiplying ContractedUnitPrice and the corresponding PricingQuantity. 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. 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. ListCost?: number | null Cost calculated by multiplying ListUnitPrice and the corresponding PricingQuantity. ListUnitPrice?: number | null Suggested provider-published unit price for a single PricingUnit of the associated billable metric, exclusive of any discounts. PricingQuantity?: number | null Volume of a given service used or purchased, based on the PricingUnit. 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. RegionId?: string | null Provider-assigned identifier for an isolated geographic area where a service is provided. RegionName?: string | null Name of an isolated geographic area where a service is provided. SubAccountId?: string Unique identifier assigned to a grouping of services. For Cloudflare, this is the subscription or contract ID. SubAccountName?: string Name assigned to a grouping of services. For Cloudflare, this is the subscription or contract display name. Tags?: Record 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 true true x\_ProductCategoryName?: string The product category the charge belongs to (e.g., “Developer”, “Cloudflare One”). Cloudflare extension; replaces FOCUS ServiceCategory. x\_ProductFamilyId?: string The unique identifier for the product family in the Cloudflare catalog. Cloudflare extension; replaces FOCUS ServiceId. x\_ProductFamilyName?: string The product family the charge belongs to (e.g., “R2”, “Workers”). Cloudflare extension; replaces FOCUS ServiceName. x\_ZoneId?: string | null The identifier for the Cloudflare zone (zone tag). Cloudflare extension. x\_ZoneName?: string | null The display name of the Cloudflare zone. Cloudflare extension.