Billing

BillingProfiles

Billing Profile Details

Deprecated

GET/accounts/{account_id}/billing/profile

ModelsExpand Collapse

ProfileGetResponse object { id, account_type, address, 36 more }

id: optional string

Billing item identifier tag.

maxLength32

account_type: optional string

address: optional string

address2: optional string

balance: optional string

card_expiry_month: optional number

card_expiry_year: optional number

card_number: optional string

city: optional string

company: optional string

country: optional string

created_on: optional string

formatdate-time

device_data: optional string

edited_on: optional string

formatdate-time

enterprise_billing_email: optional string

enterprise_primary_email: optional string

first_name: optional string

is_partner: optional boolean

last_name: optional string

next_bill_date: optional string

formatdate-time

payment_address: optional string

payment_address2: optional string

payment_city: optional string

payment_country: optional string

payment_email: optional string

payment_first_name: optional string

payment_gateway: optional string

payment_last_name: optional string

payment_nonce: optional string

payment_state: optional string

payment_zipcode: optional string

primary_email: optional string

state: optional string

tax_id_type: optional string

telephone: optional string

use_legacy: optional boolean

validation_code: optional string

vat: optional string

zipcode: optional string

BillingUsage

Get PayGo Account Billable Usage (Version 1, Alpha)

GET/accounts/{account_id}/paygo-usage

Get Account Usage (Version 2, Alpha, Restricted)

GET/accounts/{account_id}/billable/usage

ModelsExpand Collapse

UsagePaygoResponse = array of object { BillingCurrency, BillingPeriodStart, ChargePeriodEnd, 9 more }

Contains the array of billable usage records.

BillingCurrency: string

Specifies the billing currency code (ISO 4217).

BillingPeriodStart: string

Indicates the start of the billing period.

formatdate-time

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.

PricingQuantity: number

Specifies the pricing quantity for this charge period.

ServiceName: string

Identifies the Cloudflare service.

ServiceFamilyName: optional string

Identifies the product family for the Cloudflare service.

UsageGetResponse = array of object { BillingAccountId, BillingAccountName, ChargeCategory, 30 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_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_BillableMetricId: optional string

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

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.