# Billing # Profiles ## Billing Profile Details `client.billing.profiles.get(ProfileGetParamsparams, RequestOptionsoptions?): ProfileGetResponse` **get** `/accounts/{account_id}/billing/profile` Gets the current billing profile for the account. ### Parameters - `params: ProfileGetParams` - `account_id: string` Identifier ### Returns - `ProfileGetResponse` - `id?: string` Billing item identifier tag. - `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` - `device_data?: string` - `edited_on?: string` - `enterprise_billing_email?: string` - `enterprise_primary_email?: string` - `first_name?: string` - `is_partner?: boolean` - `last_name?: string` - `next_bill_date?: string` - `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` ### Example ```typescript import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); const profile = await client.billing.profiles.get({ account_id: '023e105f4ecef8ad9ca31a8372d0c353', }); console.log(profile.id); ``` #### Response ```json { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "id": "b69a9f3492637782896352daae219e7d", "account_type": "type", "address": "123 Main Street", "address2": "Apt 1", "balance": "0", "card_expiry_month": 12, "card_expiry_year": 2099, "card_number": "4242424242424242", "city": "Anytown", "company": "Company", "country": "Anycountry", "created_on": "2014-03-01T12:21:59.3456Z", "device_data": "sample_data", "edited_on": "2014-03-01T12:21:59.3456Z", "enterprise_billing_email": "johndoe@gmail.com", "enterprise_primary_email": "johndoe@gmail.com", "first_name": "John", "is_partner": false, "last_name": "Doe", "next_bill_date": "2014-03-01T12:21:59.3456Z", "payment_address": "123 Main Street", "payment_address2": "Apt 1", "payment_city": "Anytown", "payment_country": "Anycountry", "payment_email": "johndoe@gmail.com", "payment_first_name": "John", "payment_gateway": "gateway", "payment_last_name": "Doe", "payment_nonce": "abc123", "payment_state": "state", "payment_zipcode": "12345", "primary_email": "johndoe@gmail.com", "state": "AnyState", "tax_id_type": "type", "telephone": "1234567899", "use_legacy": false, "validation_code": "1111", "vat": "GB123456789", "zipcode": "12345" }, "success": true } ``` ## Domain Types ### Profile Get Response - `ProfileGetResponse` - `id?: string` Billing item identifier tag. - `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` - `device_data?: string` - `edited_on?: string` - `enterprise_billing_email?: string` - `enterprise_primary_email?: string` - `first_name?: string` - `is_partner?: boolean` - `last_name?: string` - `next_bill_date?: string` - `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` # Usage ## Get PayGo Account Billable Usage (Version 1, Alpha) `client.billing.usage.paygo(UsagePaygoParamsparams, RequestOptionsoptions?): UsagePaygoResponse` **get** `/accounts/{account_id}/paygo-usage` Returns billable usage data for PayGo (self-serve) accounts. When no query parameters are provided, returns usage for the current billing period. ### Parameters - `params: UsagePaygoParams` - `account_id: string` Path param: Represents a Cloudflare resource identifier tag. - `from?: string` Query param: Start date for the usage query (ISO 8601). - `to?: string` Query param: End date for the usage query (ISO 8601). ### Returns - `UsagePaygoResponse = Array` 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. - `ChargePeriodEnd: string` Indicates the end of the charge period. - `ChargePeriodStart: string` Indicates the start of the charge period. - `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. - `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. ### Example ```typescript import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); const response = await client.billing.usage.paygo({ account_id: '023e105f4ecef8ad9ca31a8372d0c353', }); console.log(response); ``` #### Response ```json { "errors": [ { "message": "message", "code": 0 } ], "messages": [ { "message": "message", "code": 0 } ], "result": [ { "BillingCurrency": "USD", "BillingPeriodStart": "2025-02-01T00:00:00Z", "ChargePeriodEnd": "2025-02-02T00:00:00Z", "ChargePeriodStart": "2025-02-01T00:00:00Z", "ConsumedQuantity": 150000, "ConsumedUnit": "GB-months", "ContractedCost": 0.75, "CumulatedContractedCost": 2.25, "CumulatedPricingQuantity": 4500000, "PricingQuantity": 150000, "ServiceName": "Workers Standard", "ServiceFamilyName": "Workers", "SubscriptionId": "3F3CD4CQ6N7FXO7IK6NVFJBOYA", "ZoneId": "023e105f4ecef8ad9ca31a8372d0c353", "ZoneName": "example.com" } ], "success": true } ``` ## Get Account Usage (Version 2, Alpha, Restricted) `client.billing.usage.get(UsageGetParamsparams, RequestOptionsoptions?): UsageGetResponse` **get** `/accounts/{account_id}/billable/usage` Returns cost and usage data for a single Cloudflare account, aligned with the [FinOps FOCUS v1.3](https://focus.finops.org/focus-specification/v1-3/) Cost and Usage dataset specification. Each record represents one billable metric for one account on one day. This includes all metered usage, including usage that falls within free-tier allowances and may result in zero cost. **Note:** Cost and pricing fields are not yet populated and will be absent from responses until billing integration is complete. When `from` and `to` are omitted, defaults to the start of the current month through today. The maximum date range is 31 days. ### Parameters - `params: UsageGetParams` - `account_id: string` Path param: Represents a Cloudflare resource identifier tag. - `from?: string` Query param: Start date for the usage query (ISO 8601). Required if `to` is set. When omitted along with `to`, defaults to the start of the current month. Filters by charge period (when consumption happened), not billing period. The maximum date range is 31 days. - `metric_id?: Array` Query param: Filter results by one or more billable metric ids. Repeat the parameter to filter by multiple metrics. Maximum 10 values. - `to?: string` Query param: End date for the usage query (ISO 8601). Required if `from` is set. When omitted along with `from`, defaults to today. Filters by charge period (when consumption happened), not billing period. The maximum date range is 31 days. ### Returns - `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. - `"Usage"` - `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. - `"Usage-Based"` - `ChargePeriodEnd: string` Exclusive end of the time interval during which the usage was consumed. - `ChargePeriodStart: string` Inclusive start of the time interval during which the usage was consumed. - `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. - `BillingPeriodStart?: string | null` Inclusive start of the billing cycle that contains this usage record. - `ChargeClass?: "Correction" | null` Indicates whether the row represents a correction to one or more charges invoiced in a previous billing period. - `"Correction"` - `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. ### Example ```typescript import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); const usages = await client.billing.usage.get({ account_id: '023e105f4ecef8ad9ca31a8372d0c353' }); console.log(usages); ``` #### Response ```json { "errors": [ { "message": "message", "code": 0 } ], "messages": [ { "message": "message", "code": 0 } ], "result": [ { "BillingAccountId": "023e105f4ecef8ad9ca31a8372d0c353", "BillingAccountName": "My Account", "ChargeCategory": "Usage", "ChargeDescription": "Workers Standard Requests — daily usage", "ChargeFrequency": "Usage-Based", "ChargePeriodEnd": "2025-05-02T00:00:00Z", "ChargePeriodStart": "2025-05-01T00:00:00Z", "ConsumedQuantity": 150000, "ConsumedUnit": "Requests", "HostProviderName": "Cloudflare", "InvoiceIssuerName": "Cloudflare", "ServiceProviderName": "Cloudflare", "x_BillableMetricName": "Workers Standard Requests", "BilledCost": 0, "BillingCurrency": "USD", "BillingPeriodEnd": "2025-06-01T00:00:00Z", "BillingPeriodStart": "2025-05-01T00:00:00Z", "ChargeClass": "Correction", "ContractedCost": 0.75, "ContractedUnitPrice": 0.000005, "EffectiveCost": 0, "ListCost": 0.75, "ListUnitPrice": 0.000005, "PricingQuantity": 150000, "PricingUnit": "Requests", "RegionId": "EEUR", "RegionName": "Eastern Europe", "SubAccountId": "c9bd752d-9ca8-411d-b804-be44a758057f", "SubAccountName": "My Subscription", "x_BillableMetricId": "workers_standard_requests", "x_ProductFamilyName": "Workers", "x_ZoneId": "023e105f4ecef8ad9ca31a8372d0c353", "x_ZoneName": "example.com" } ], "success": true } ``` ## Domain Types ### Usage Paygo Response - `UsagePaygoResponse = Array` 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. - `ChargePeriodEnd: string` Indicates the end of the charge period. - `ChargePeriodStart: string` Indicates the start of the charge period. - `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. - `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. ### Usage Get Response - `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. - `"Usage"` - `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. - `"Usage-Based"` - `ChargePeriodEnd: string` Exclusive end of the time interval during which the usage was consumed. - `ChargePeriodStart: string` Inclusive start of the time interval during which the usage was consumed. - `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. - `BillingPeriodStart?: string | null` Inclusive start of the billing cycle that contains this usage record. - `ChargeClass?: "Correction" | null` Indicates whether the row represents a correction to one or more charges invoiced in a previous billing period. - `"Correction"` - `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.