Billing

BillingProfiles

Billing Profile Details

Deprecated

client.billing.profiles.get(, ?): ProfileGetResponse { id, account_type, address, 36 more }

GET/accounts/{account_id}/billing/profile

ModelsExpand Collapse

ProfileGetResponse { id, account_type, address, 36 more }

id?: string

Billing item identifier tag.

maxLength32

account_type?: string

address?: string

address2?: string

balance?: string

card_expiry_month?: number

card_expiry_year?: number

card_number?: string

city?: string

company?: string

country?: string

created_on?: string

formatdate-time

device_data?: string

edited_on?: string

formatdate-time

enterprise_billing_email?: string

enterprise_primary_email?: string

first_name?: string

is_partner?: boolean

last_name?: string

next_bill_date?: string

formatdate-time

payment_address?: string

payment_address2?: string

payment_city?: string

payment_country?: string

payment_email?: string

payment_first_name?: string

payment_gateway?: string

payment_last_name?: string

payment_nonce?: string

payment_state?: string

payment_zipcode?: string

primary_email?: string

state?: string

tax_id_type?: string

telephone?: string

use_legacy?: boolean

validation_code?: string

vat?: string

zipcode?: string

BillingUsage

Get PayGo Account Billable Usage (Version 1, Alpha)

client.billing.usage.paygo(, ?): UsagePaygoResponse { BillingCurrency, BillingPeriodStart, ChargePeriodEnd, 9 more }

GET/accounts/{account_id}/paygo-usage

Get Account Usage (Version 2, Alpha, Restricted)

client.billing.usage.get(, ?): UsageGetResponse { BillingAccountId, BillingAccountName, ChargeCategory, 30 more }

GET/accounts/{account_id}/billable/usage

ModelsExpand Collapse

UsagePaygoResponse = Array<UsagePaygoResponseItem>

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?: string

Identifies the product family for the Cloudflare service.

UsageGetResponse = Array<UsageGetResponseItem>

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?: 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.

x_BillableMetricId?: string

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

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.