Skip to content
Start here

Unpaid Invoice

Get Unpaid Invoices
client.billing.unpaidInvoice.get(UnpaidInvoiceGetParams { account_id } params, RequestOptionsoptions?): 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.