Get Account Bad Debt

billing.bad_debt.get() -> BadDebtGetResponse

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

Gets bad debt information for an account, including outstanding invoices and total debt amount.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

ParametersExpand Collapse

account_id: str

Identifier

maxLength32

ReturnsExpand Collapse

class BadDebtGetResponse: …

already_paid: Optional[float]

Amount already paid towards the debt.

bad_debt_status: Optional[str]

The current bad debt status of the account.

invoices: Optional[List[Invoice]]

List of outstanding invoices contributing to bad debt.

id: Optional[str]

Billing history item identifier.

action: Optional[str]

The billing item action.

amount: Optional[float]

The amount associated with this billing item.

amount_to_pay: Optional[float]

The amount remaining to pay.

currency: Optional[str]

The currency of the billing item.

description: Optional[str]

The billing item description.

external_invoice_id: Optional[str]

The external invoice identifier.

hosted_invoice_url: Optional[str]

URL to the hosted invoice.

invoice_id: Optional[str]

The associated invoice identifier.

occurred_at: Optional[datetime]

When the billing event occurred.

formatdate-time

receipt_id: Optional[str]

The associated receipt identifier.

source: Optional[str]

The source of the billing item.

source_invoice_id: Optional[str]

The source invoice identifier.

status: Optional[str]

The status of the billing item.

type: Optional[str]

The billing item type.

total_debt_amount: Optional[float]

Total outstanding debt amount.

Get Account Bad Debt

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
bad_debt = client.billing.bad_debt.get(
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(bad_debt.already_paid)

{
  "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": {
    "already_paid": 0,
    "bad_debt_status": "active",
    "invoices": [
      {
        "id": "b69a9f3492637782896352daae219e7d",
        "action": "subscription",
        "amount": 20.99,
        "amount_to_pay": 0,
        "currency": "USD",
        "description": "The billing item description",
        "external_invoice_id": "external_invoice_id",
        "hosted_invoice_url": "hosted_invoice_url",
        "invoice_id": "invoice_id",
        "occurred_at": "2014-03-01T12:21:59.3456Z",
        "receipt_id": "receipt_id",
        "source": "source",
        "source_invoice_id": "source_invoice_id",
        "status": "status",
        "type": "charge"
      }
    ],
    "total_debt_amount": 20.99
  },
  "success": true
}

Returns Examples

{
  "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": {
    "already_paid": 0,
    "bad_debt_status": "active",
    "invoices": [
      {
        "id": "b69a9f3492637782896352daae219e7d",
        "action": "subscription",
        "amount": 20.99,
        "amount_to_pay": 0,
        "currency": "USD",
        "description": "The billing item description",
        "external_invoice_id": "external_invoice_id",
        "hosted_invoice_url": "hosted_invoice_url",
        "invoice_id": "invoice_id",
        "occurred_at": "2014-03-01T12:21:59.3456Z",
        "receipt_id": "receipt_id",
        "source": "source",
        "source_invoice_id": "source_invoice_id",
        "status": "status",
        "type": "charge"
      }
    ],
    "total_debt_amount": 20.99
  },
  "success": true
}