Skip to content
Cloudflare API
Start here
API Reference

Billing

BillingProfiles

Billing Profile Details
Deprecated
billing.profiles.get(ProfileGetParams**kwargs) -> ProfileGetResponse
GET/accounts/{account_id}/billing/profile
ModelsExpand Collapse
class ProfileGetResponse: …
id: Optional[str]

Billing item identifier tag.

maxLength32
account_type: Optional[str]
address: Optional[str]
address2: Optional[str]
balance: Optional[str]
card_expiry_month: Optional[int]
card_expiry_year: Optional[int]
card_number: Optional[str]
city: Optional[str]
company: Optional[str]
country: Optional[str]
created_on: Optional[datetime]
formatdate-time
device_data: Optional[str]
edited_on: Optional[datetime]
formatdate-time
enterprise_billing_email: Optional[str]
enterprise_primary_email: Optional[str]
first_name: Optional[str]
is_partner: Optional[bool]
last_name: Optional[str]
next_bill_date: Optional[datetime]
formatdate-time
payment_address: Optional[str]
payment_address2: Optional[str]
payment_city: Optional[str]
payment_country: Optional[str]
payment_email: Optional[str]
payment_first_name: Optional[str]
payment_gateway: Optional[str]
payment_last_name: Optional[str]
payment_nonce: Optional[str]
payment_state: Optional[str]
payment_zipcode: Optional[str]
primary_email: Optional[str]
state: Optional[str]
tax_id_type: Optional[str]
telephone: Optional[str]
use_legacy: Optional[bool]
validation_code: Optional[str]
vat: Optional[str]
zipcode: Optional[str]

BillingUsage

Get PayGo Account Billable Usage (Beta)
billing.usage.paygo(UsagePaygoParams**kwargs) -> UsagePaygoResponse
GET/accounts/{account_id}/billing/usage/paygo
ModelsExpand Collapse
List[UsagePaygoResponseItem]

Contains the array of billable usage records.

billing_currency: str

Specifies the billing currency code (ISO 4217).

billing_period_start: datetime

Indicates the start of the billing period.

formatdate-time
charge_period_end: datetime

Indicates the end of the charge period.

formatdate-time
charge_period_start: datetime

Indicates the start of the charge period.

formatdate-time
consumed_quantity: float

Specifies the quantity consumed during this charge period.

consumed_unit: str

Specifies the unit of measurement for consumed quantity.

contracted_cost: float

Specifies the cost for this charge period in the billing currency.

cumulated_contracted_cost: float

Specifies the cumulated cost for the billing period in the billing currency.

cumulated_pricing_quantity: int

Specifies the cumulated pricing quantity for the billing period.

pricing_quantity: int

Specifies the pricing quantity for this charge period.

service_name: str

Identifies the Cloudflare service.