Skip to content
Start here

Bad Debt

Get Account Bad Debt
client.billing.badDebt.get(BadDebtGetParams { account_id } params, RequestOptionsoptions?): 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.