Skip to main content
GET
Get a suspended server's overdue 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

server
string
required

The server UUID

Example:

"ecc6f4f1"

Response

InvoiceData · object | null

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

id
integer
required

The id ID.

Example:

18342

number
string
required

The value of number.

Example:

"18342"

status
string
required

The value of status.

Example:

"Unpaid"

date
string | null
required

The date and time for date, in UTC.

Example:

"2026-09-11T00:00:00+00:00"

due_date
string | null
required

The value of due_date.

Example:

"2026-10-02T00:00:00+00:00"

date_paid
string | null
required

The value of date_paid.

Example:

null

subtotal
string
required

The value of subtotal.

Example:

"12.00"

credit
string
required

The available account credit, formatted for display.

Example:

"0.00"

tax
string
required

The value of tax.

Example:

"0.00"

total
string
required

The value of total.

Example:

"12.00"

currency
string | null
required

The three-letter currency code used for monetary amounts.

Example:

"USD"

payment_method
string | null
required

The value of payment_method.

Example:

"Paddle"

url
string | null
required

The complete URL.

Example:

"https://clients.advinservers.com/viewinvoice.php?id=18342"

balance
string

What is still owed.

items

The value of items.

transactions

The value of transactions.

tax_rate
string | null

The two levels apart, so a viewer can show "GST 5%" and "PST 7%" as their own lines rather than labelling their sum with the first of the two rates.

tax_rate_2
string | null

The value of tax_rate_2.

tax_amount
string

The value of tax_amount.

tax_amount_2
string

The value of tax_amount_2.

pay_to
InvoicePartyData · object | null

Who the invoice is payable to, or null where the operator has none of it on file.

Example:
billed_to
InvoicePartyData · object | null

Who the invoice was raised for, or null where the billing record could not be read.

Example: