Skip to content
Start here

Bad Debt

Get Account Bad Debt
GET/accounts/{account_id}/billing/bad-debt
ModelsExpand Collapse
BadDebtGetResponse object { already_paid, bad_debt_status, invoices, total_debt_amount }
already_paid: optional number

Amount already paid towards the debt.

bad_debt_status: optional string

The current bad debt status of the account.

invoices: optional array of object { id, action, amount, 12 more }

List of outstanding invoices contributing to bad debt.

id: optional string

Billing history item identifier.

action: optional string

The billing item action.

amount: optional number

The amount associated with this billing item.

amount_to_pay: optional number

The amount remaining to pay.

currency: optional string

The currency of the billing item.

description: optional string

The billing item description.

external_invoice_id: optional string

The external invoice identifier.

hosted_invoice_url: optional string

URL to the hosted invoice.

invoice_id: optional string

The associated invoice identifier.

occurred_at: optional string

When the billing event occurred.

formatdate-time
receipt_id: optional string

The associated receipt identifier.

source: optional string

The source of the billing item.

source_invoice_id: optional string

The source invoice identifier.

status: optional string

The status of the billing item.

type: optional string

The billing item type.

total_debt_amount: optional number

Total outstanding debt amount.