Skip to main content
GET
Get a postpaid invoice

Authorizations

Authorization
string
header
required

Your API key, sent as a bearer token. Create one in the control panel under API Keys, give it only the permissions the integration needs, and copy it when it is created. It cannot be shown again. Each key is restricted to one owned team. The key determines the team for every request.

Path Parameters

invoice
string | null
required

The invoice uuid short

Example:

18342

Response

The record, as a JSON object. There is no envelope.

An account's invoice for one calendar month, covering every postpaid team it owns, billed by the hour.

id
string | null
required

Null for a month with nothing billed yet, which has no row.

Example:

"8f9b2a4c-6d1e-4f3a-9b7c-2e5d8a1f4c6b"

uuid_short
string | null
required

The value of uuid_short.

Example:

"Uuid short"

month
string
required

The value of month.

Example:

"2026-09"

month_label
string
required

The value of month_label.

Example:

"September 2026"

status
enum<string>
required

The value of status.

Available options:
draft,
unpaid,
credit_hold,
suspended,
termination_pending,
paid,
deferred,
cancelled
Example:

"unpaid"

status_label
string
required

The value of status_label.

Example:

"Unpaid"

total
string
required

The value of total.

Example:

"16.00"

currency
string
required

The three-letter currency code used for monetary amounts.

Example:

"USD"

invoice_date
string | null
required

On a draft, the dates it will be issued (the next month's first day) and due.

Example:

"Invoice date"

due_date
string | null
required

The value of due_date.

Example:

"2026-10-07"

credit_hold_date
string | null
required

The value of credit_hold_date.

Example:

"2026-10-14"

suspension_date
string | null
required

The value of suspension_date.

Example:

"2026-10-14"

termination_date
string | null
required

The value of termination_date.

Example:

"2026-10-21"

paid_at
string | null
required

When payment was recorded, in UTC.

Example:

null

invoice_id
integer | null
required

The published invoice, paid like any other through the invoice endpoints. Null until it is published.

Example:

18342

can_pay
boolean
required

Whether the customer can pay.

Example:

true

lines
PostpaidInvoiceLineData · object[] | null
required

The value of lines.

Example: