---
title: Bad Debt
---

[Skip to content](#_top)

[API Reference](https://developers.cloudflare.com/api/typescript)

[Billing](https://developers.cloudflare.com/api/typescript/resources/billing)

Copy Markdown

Open in **Claude**Open in **ChatGPT**Open in **Cursor**

---

**Copy Markdown****View as Markdown**

# Bad Debt

##### [Get Account Bad Debt](https://developers.cloudflare.com/api/typescript/resources/billing/subresources/bad_debt/methods/get)

client.billing.badDebt.get(BadDebtGetParams {account\_id } params, RequestOptionsoptions?): [BadDebtGetResponse](<https://developers.cloudflare.com/api/typescript/resources/billing#(resource)%20billing.bad_debt%20%3E%20(model)%20bad_debt_get_response%20%3E%20(schema)>) {already\_paid, bad\_debt\_status, invoices, total\_debt\_amount }

GET/accounts/{account\_id}/billing/bad-debt

##### ModelsExpand Collapse

<details>

<summary>

BadDebtGetResponse {already\_paid, bad\_debt\_status, invoices, total\_debt\_amount }

</summary>

already\_paid?: number

Amount already paid towards the debt.

<a href="#(resource)%20billing.bad_debt%20%3E%20(model)%20bad_debt_get_response%20%3E%20(schema)%20%3E%20(property)%20already_paid">Link to this property</a>

bad\_debt\_status?: string

The current bad debt status of the account.

<a href="#(resource)%20billing.bad_debt%20%3E%20(model)%20bad_debt_get_response%20%3E%20(schema)%20%3E%20(property)%20bad_debt_status">Link to this property</a>

<details>

<summary>

invoices?: Array&lt;Invoice&gt;

List of outstanding invoices contributing to bad debt.

</summary>

id?: string

Billing history item identifier.

<a href="#(resource)%20billing.bad_debt%20%3E%20(model)%20bad_debt_get_response%20%3E%20(schema)%20%3E%20(property)%20invoices%20%3E%20(items)%20%3E%20(property)%20id">Link to this property</a>

action?: string

The billing item action.

<a href="#(resource)%20billing.bad_debt%20%3E%20(model)%20bad_debt_get_response%20%3E%20(schema)%20%3E%20(property)%20invoices%20%3E%20(items)%20%3E%20(property)%20action">Link to this property</a>

amount?: number

The amount associated with this billing item.

<a href="#(resource)%20billing.bad_debt%20%3E%20(model)%20bad_debt_get_response%20%3E%20(schema)%20%3E%20(property)%20invoices%20%3E%20(items)%20%3E%20(property)%20amount">Link to this property</a>

amount\_to\_pay?: number

The amount remaining to pay.

<a href="#(resource)%20billing.bad_debt%20%3E%20(model)%20bad_debt_get_response%20%3E%20(schema)%20%3E%20(property)%20invoices%20%3E%20(items)%20%3E%20(property)%20amount_to_pay">Link to this property</a>

currency?: string

The currency of the billing item.

<a href="#(resource)%20billing.bad_debt%20%3E%20(model)%20bad_debt_get_response%20%3E%20(schema)%20%3E%20(property)%20invoices%20%3E%20(items)%20%3E%20(property)%20currency">Link to this property</a>

description?: string

The billing item description.

<a href="#(resource)%20billing.bad_debt%20%3E%20(model)%20bad_debt_get_response%20%3E%20(schema)%20%3E%20(property)%20invoices%20%3E%20(items)%20%3E%20(property)%20description">Link to this property</a>

external\_invoice\_id?: string

The external invoice identifier.

<a href="#(resource)%20billing.bad_debt%20%3E%20(model)%20bad_debt_get_response%20%3E%20(schema)%20%3E%20(property)%20invoices%20%3E%20(items)%20%3E%20(property)%20external_invoice_id">Link to this property</a>

hosted\_invoice\_url?: string

URL to the hosted invoice.

<a href="#(resource)%20billing.bad_debt%20%3E%20(model)%20bad_debt_get_response%20%3E%20(schema)%20%3E%20(property)%20invoices%20%3E%20(items)%20%3E%20(property)%20hosted_invoice_url">Link to this property</a>

invoice\_id?: string

The associated invoice identifier.

<a href="#(resource)%20billing.bad_debt%20%3E%20(model)%20bad_debt_get_response%20%3E%20(schema)%20%3E%20(property)%20invoices%20%3E%20(items)%20%3E%20(property)%20invoice_id">Link to this property</a>

occurred\_at?: string

When the billing event occurred.

formatdate-time

<a href="#(resource)%20billing.bad_debt%20%3E%20(model)%20bad_debt_get_response%20%3E%20(schema)%20%3E%20(property)%20invoices%20%3E%20(items)%20%3E%20(property)%20occurred_at">Link to this property</a>

receipt\_id?: string

The associated receipt identifier.

<a href="#(resource)%20billing.bad_debt%20%3E%20(model)%20bad_debt_get_response%20%3E%20(schema)%20%3E%20(property)%20invoices%20%3E%20(items)%20%3E%20(property)%20receipt_id">Link to this property</a>

source?: string

The source of the billing item.

<a href="#(resource)%20billing.bad_debt%20%3E%20(model)%20bad_debt_get_response%20%3E%20(schema)%20%3E%20(property)%20invoices%20%3E%20(items)%20%3E%20(property)%20source">Link to this property</a>

source\_invoice\_id?: string

The source invoice identifier.

<a href="#(resource)%20billing.bad_debt%20%3E%20(model)%20bad_debt_get_response%20%3E%20(schema)%20%3E%20(property)%20invoices%20%3E%20(items)%20%3E%20(property)%20source_invoice_id">Link to this property</a>

status?: string

The status of the billing item.

<a href="#(resource)%20billing.bad_debt%20%3E%20(model)%20bad_debt_get_response%20%3E%20(schema)%20%3E%20(property)%20invoices%20%3E%20(items)%20%3E%20(property)%20status">Link to this property</a>

type?: string

The billing item type.

<a href="#(resource)%20billing.bad_debt%20%3E%20(model)%20bad_debt_get_response%20%3E%20(schema)%20%3E%20(property)%20invoices%20%3E%20(items)%20%3E%20(property)%20type">Link to this property</a>

</details>

<a href="#(resource)%20billing.bad_debt%20%3E%20(model)%20bad_debt_get_response%20%3E%20(schema)%20%3E%20(property)%20invoices">Link to this property</a>

total\_debt\_amount?: number

Total outstanding debt amount.

<a href="#(resource)%20billing.bad_debt%20%3E%20(model)%20bad_debt_get_response%20%3E%20(schema)%20%3E%20(property)%20total_debt_amount">Link to this property</a>

</details>

[Link to this property](<#(resource)%20billing.bad_debt%20%3E%20(model)%20bad_debt_get_response%20%3E%20(schema)>)