Skip to content
Cloudflare API
Start here
API Reference

Billing

BillingProfiles

Billing Profile Details
Deprecated
client.billing.profiles.get(ProfileGetParams { account_id } params, RequestOptionsoptions?): 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 (Beta)
client.billing.usage.paygo(UsagePaygoParams { account_id, from, to } params, RequestOptionsoptions?): UsagePaygoResponse { BillingCurrency, BillingPeriodStart, ChargePeriodEnd, 8 more }
GET/accounts/{account_id}/billing/usage/paygo
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

Specifies the unit of measurement for consumed quantity.

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.