Billing

Validate Billing Address

client.billing.addressValidation(, ?): BillingAddressValidationResponse { validated_addresses }

POST/billing/address-validation

ModelsExpand Collapse

BillingAddressValidationResponse { validated_addresses }

validated_addresses?: Array<ValidatedAddress>

List of validated address suggestions.

address?: string

Validated address line 1.

address2?: string

Validated address line 2.

city?: string

Validated city.

country?: string

Validated country code.

state?: string

Validated state or province.

validation_code?: string

The validation result code.

zipcode?: string

Validated postal or zip code.

BillingProfiles

Get Billing Profile

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

GET/accounts/{account_id}/billing/profile

Create Billing Profile

client.billing.profiles.create(, ?): ProfileCreateResponse { id, account_type, address, 35 more }

POST/accounts/{account_id}/billing/profile

Update Billing Profile

client.billing.profiles.update(, ?): ProfileUpdateResponse { id, account_type, address, 35 more }

PUT/accounts/{account_id}/billing/profile

Delete Billing Profile

client.billing.profiles.delete(, ?): void

DELETE/accounts/{account_id}/billing/profile

Update Billing Email

client.billing.profiles.updateBillingEmail(, ?): ProfileUpdateBillingEmailResponse { id, account_type, address, 35 more }

PATCH/accounts/{account_id}/billing/profile

ModelsExpand Collapse

ProfileGetResponse { id, account_type, address, 35 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

validation_code?: string

vat?: string

zipcode?: string

ProfileCreateResponse { id, account_type, address, 35 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

validation_code?: string

vat?: string

zipcode?: string

ProfileUpdateResponse { id, account_type, address, 35 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

validation_code?: string

vat?: string

zipcode?: string

ProfileUpdateBillingEmailResponse { id, account_type, address, 35 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

validation_code?: string

vat?: string

zipcode?: string

BillingProfilesPayment Method

Create Payment Intent for Billing Profile

client.billing.profiles.paymentMethod.create(, ?): PaymentMethodCreateResponse { client_secret, intent_type }

POST/accounts/{account_id}/billing/profile/payment-method

ModelsExpand Collapse

PaymentMethodCreateResponse { client_secret, intent_type }

client_secret?: string

The Stripe client secret for frontend payment method collection.

intent_type?: string

The type of Stripe intent created.

BillingUsage

Get Account Billable Usage Info (Version 1, Alpha)

Deprecated

client.billing.usage.paygoInfo(, ?): UsagePaygoInfoResponse { covered, subscriptions }

GET/accounts/{account_id}/billable-usage/info

Get Account Billable Usage (Version 1, Alpha)

Deprecated

client.billing.usage.paygo(, ?): UsagePaygoResponse { BilledCost, BillingAccountId, BillingAccountName, 24 more }

GET/accounts/{account_id}/billable-usage

Get Account Usage (Version 2, Alpha, Restricted)

Deprecated

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

GET/accounts/{account_id}/billable/usage

Get Account Billable Usage Info (Version 1, Alpha)

client.billing.usage.getAccountUsageInfoV1(, ?): UsageGetAccountUsageInfoV1Response { covered, subscriptions }

GET/accounts/{account_id}/billable-usage/info

Get Account Billable Usage (Version 1, Alpha)

client.billing.usage.getAccountUsageV1(, ?): UsageGetAccountUsageV1Response { BilledCost, BillingAccountId, BillingAccountName, 24 more }

GET/accounts/{account_id}/billable-usage

Get Account Usage (Version 2, Alpha, Restricted)

client.billing.usage.getAccountUsageV2(, ?): UsageGetAccountUsageV2Response { BillingAccountId, BillingAccountName, ChargeCategory, 33 more }

GET/accounts/{account_id}/billable/usage

ModelsExpand Collapse

UsagePaygoInfoResponse { covered, subscriptions }

Contains the usage info.

covered: boolean

Indicates whether the account is covered.

subscriptions: Array<Subscription>

List of subscriptions for the account.

id: string

The identifier for the Cloudflare subscription.

billing_cycle_anchor_timestamp: string

The subscription billing cycle anchor timestamp.

formatdate-time

start_timestamp: string

The subscription start timestamp.

formatdate-time

end_timestamp?: string

The subscription end timestamp. Omitted for active subscriptions; present only when the subscription has been cancelled.

formatdate-time

UsagePaygoResponse = Array<UsagePaygoResponseItem>

Contains the array of billable usage records.

BilledCost: number

The amount invoiced for this charge. PayGo is billed directly by Cloudflare, so this equals ContractedCost.

BillingAccountId: string

The identifier of the account the charge is billed to (account tag).

BillingAccountName: string | null

The display name of the billing account. Null when the name could not be resolved.

BillingCurrency: string

Specifies the billing currency code (ISO 4217).

BillingPeriodStart: string

Indicates the start of the billing period. There is no BillingPeriodEnd counterpart; see the known gaps described on this schema.

formatdate-time

ChargeCategory: "Usage"

Describes the nature of the charge. Always “Usage” for this endpoint, which only returns metered usage.

ChargeClass: string | null

Indicates whether the row corrects a previously invoiced billing period. Always null for this endpoint, which does not return corrections.

ChargeDescription: string | null

A human-readable summary of the charge.

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 portion of usage that is actually subject to a unit price.

EffectiveCost: number

The amortized cost of the charge. PayGo has no upfront commitments, so this equals ContractedCost.

HostProviderName: string

The provider that hosts the infrastructure or platform the service runs on.

InvoiceIssuerName: string

The entity that issues the invoice for this charge.

ListCost: number

The cost at published list prices, before any discount. PayGo has no commitment discounts, so this equals ContractedCost.

PricingQuantity: number

Specifies the pricing quantity for this charge period.

PricingUnit: string

The unit that PricingQuantity is expressed in. Unlike ConsumedUnit this is never empty; it falls back to “Count” when the service has no explicit unit.

ServiceName: string

Identifies the Cloudflare service.

ServiceProviderName: string

The provider of the purchased 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.

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

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

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.

Tags?: Record<string, string | true>

Tag values for the requested GroupBy keys. Omitted when GroupBy is not provided. Missing keys are omitted, and key-only tags are returned as boolean true. All other tag values are strings.

One of the following:

string

true

x_ProductCategoryName?: string

The product category the charge belongs to (e.g., “Developer”, “Cloudflare One”). Cloudflare extension; replaces FOCUS ServiceCategory.

x_ProductFamilyId?: string

The unique identifier for the product family in the Cloudflare catalog. Cloudflare extension; replaces FOCUS ServiceId.

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.

UsageGetAccountUsageInfoV1Response { covered, subscriptions }

Contains the usage info.

covered: boolean

Indicates whether the account is covered.

subscriptions: Array<Subscription>

List of subscriptions for the account.

id: string

The identifier for the Cloudflare subscription.

billing_cycle_anchor_timestamp: string

The subscription billing cycle anchor timestamp.

formatdate-time

start_timestamp: string

The subscription start timestamp.

formatdate-time

end_timestamp?: string

The subscription end timestamp. Omitted for active subscriptions; present only when the subscription has been cancelled.

formatdate-time

UsageGetAccountUsageV1Response = Array<UsageGetAccountUsageV1ResponseItem>

Contains the array of billable usage records.

BilledCost: number

The amount invoiced for this charge. PayGo is billed directly by Cloudflare, so this equals ContractedCost.

BillingAccountId: string

The identifier of the account the charge is billed to (account tag).

BillingAccountName: string | null

The display name of the billing account. Null when the name could not be resolved.

BillingCurrency: string

Specifies the billing currency code (ISO 4217).

BillingPeriodStart: string

Indicates the start of the billing period. There is no BillingPeriodEnd counterpart; see the known gaps described on this schema.

formatdate-time

ChargeCategory: "Usage"

Describes the nature of the charge. Always “Usage” for this endpoint, which only returns metered usage.

ChargeClass: string | null

Indicates whether the row corrects a previously invoiced billing period. Always null for this endpoint, which does not return corrections.

ChargeDescription: string | null

A human-readable summary of the charge.

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 portion of usage that is actually subject to a unit price.

EffectiveCost: number

The amortized cost of the charge. PayGo has no upfront commitments, so this equals ContractedCost.

HostProviderName: string

The provider that hosts the infrastructure or platform the service runs on.

InvoiceIssuerName: string

The entity that issues the invoice for this charge.

ListCost: number

The cost at published list prices, before any discount. PayGo has no commitment discounts, so this equals ContractedCost.

PricingQuantity: number

Specifies the pricing quantity for this charge period.

PricingUnit: string

The unit that PricingQuantity is expressed in. Unlike ConsumedUnit this is never empty; it falls back to “Count” when the service has no explicit unit.

ServiceName: string

Identifies the Cloudflare service.

ServiceProviderName: string

The provider of the purchased 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.

UsageGetAccountUsageV2Response = Array<UsageGetAccountUsageV2ResponseItem>

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

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

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.

Tags?: Record<string, string | true>

Tag values for the requested GroupBy keys. Omitted when GroupBy is not provided. Missing keys are omitted, and key-only tags are returned as boolean true. All other tag values are strings.

One of the following:

string

true

x_ProductCategoryName?: string

The product category the charge belongs to (e.g., “Developer”, “Cloudflare One”). Cloudflare extension; replaces FOCUS ServiceCategory.

x_ProductFamilyId?: string

The unique identifier for the product family in the Cloudflare catalog. Cloudflare extension; replaces FOCUS ServiceId.

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.

BillingCredits

Get Account Credits

client.billing.credits.get(, ?): CreditGetResponse { confirmed_balance_cents, currency, days_remaining, 7 more }

GET/accounts/{account_id}/billing/credits

ModelsExpand Collapse

CreditGetResponse { confirmed_balance_cents, currency, days_remaining, 7 more }

confirmed_balance_cents?: number

The confirmed credit balance in cents.

formatint64

currency?: string

Currency of the credit balance.

days_remaining?: number

Days remaining until the credits expire.

formatint64

eligible?: boolean

Whether the account is eligible to receive credits.

has_record?: boolean

Whether a credit record exists for the account.

original_amount_cents?: number

The original credit amount in cents.

formatint64

percent_consumed?: number

Percentage of the original credit amount consumed.

formatdouble

projected_depletion_date?: string

Projected date when the credits will be depleted.

formatdate-time

valid_from?: string

When the credits become valid.

formatdate-time

valid_to?: string

When the credits expire.

formatdate-time

BillingHistory

Get Account Billing History

client.billing.history.list(, ?): V4PagePaginationArray<HistoryListResponse { id, action, amount, 12 more } >

GET/accounts/{account_id}/billing/history

ModelsExpand Collapse

HistoryListResponse { id, action, amount, 12 more }

id?: string

Billing history item identifier.

action?: string

The billing item action.

amount?: number

The amount associated with this billing item.

amount_to_pay?: number

The amount remaining to pay.

currency?: string

The currency of the billing item.

description?: string

The billing item description.

external_invoice_id?: string

The external invoice identifier.

hosted_invoice_url?: string

URL to the hosted invoice.

invoice_id?: string

The associated invoice identifier.

occurred_at?: string

When the billing event occurred.

formatdate-time

receipt_id?: string

The associated receipt identifier.

source?: string

The source of the billing item.

source_invoice_id?: string

The source invoice identifier.

status?: string

The status of the billing item.

type?: string

The billing item type.

BillingBad Debt

Get Account Bad Debt

client.billing.badDebt.get(, ?): BadDebtGetResponse { already_paid, bad_debt_status, invoices, total_debt_amount }

GET/accounts/{account_id}/billing/bad-debt

ModelsExpand Collapse

BadDebtGetResponse { already_paid, bad_debt_status, invoices, total_debt_amount }

already_paid?: number

Amount already paid towards the debt.

bad_debt_status?: string

The current bad debt status of the account.

invoices?: Array<Invoice>

List of outstanding invoices contributing to bad debt.

id?: string

Billing history item identifier.

action?: string

The billing item action.

amount?: number

The amount associated with this billing item.

amount_to_pay?: number

The amount remaining to pay.

currency?: string

The currency of the billing item.

description?: string

The billing item description.

external_invoice_id?: string

The external invoice identifier.

hosted_invoice_url?: string

URL to the hosted invoice.

invoice_id?: string

The associated invoice identifier.

occurred_at?: string

When the billing event occurred.

formatdate-time

receipt_id?: string

The associated receipt identifier.

source?: string

The source of the billing item.

source_invoice_id?: string

The source invoice identifier.

status?: string

The status of the billing item.

type?: string

The billing item type.

total_debt_amount?: number

Total outstanding debt amount.

BillingUnpaid Invoice

Get Unpaid Invoices

client.billing.unpaidInvoice.get(, ?): UnpaidInvoiceGetResponse { invoices }

GET/accounts/{account_id}/billing/unpaid-invoice

ModelsExpand Collapse

UnpaidInvoiceGetResponse { invoices }

invoices?: Array<Invoice>

List of unpaid invoices.

id?: string

Billing history item identifier.

action?: string

The billing item action.

amount?: number

The amount associated with this billing item.

amount_to_pay?: number

The amount remaining to pay.

currency?: string

The currency of the billing item.

description?: string

The billing item description.

external_invoice_id?: string

The external invoice identifier.

hosted_invoice_url?: string

URL to the hosted invoice.

invoice_id?: string

The associated invoice identifier.

occurred_at?: string

When the billing event occurred.

formatdate-time

receipt_id?: string

The associated receipt identifier.

source?: string

The source of the billing item.

source_invoice_id?: string

The source invoice identifier.

status?: string

The status of the billing item.

type?: string

The billing item type.

BillingRate Plans

Get Rate Plan by Public Key

client.billing.ratePlans.get(, ?): RatePlanGetResponse { id, components, currency, public_name }

GET/billing/rate_plans/{public_key}

ModelsExpand Collapse

RatePlanGetResponse { id, components, currency, public_name }

id?: string

The uppercase rate plan public key.

components?: Array<Record<string, unknown>>

Pricing components that make up this rate plan.

currency?: string

Currency of the rate plan pricing.

public_name?: string

Human-readable description of the rate plan.