CorefinityCorefinityDocs
Open the Control PanelControl Panel
Billing · 15 of 16

Get the account's standing

Answers where the billing account stands on unpaid invoices: what is overdue, each invoice being followed up with its dates, the services that are suspended and what brings them back. A company with no billing account yet answers good with empty lists.

GET/api/corestack/billing/standing

Query parameters

accountinteger

The billing account to read, by its id (see GET /corestack/billing/account). Left out, the request acts on your company's default billing account. An account that does not exist and one that is not your company's answer the same 404. At least 1.

account_idinteger

The same as account, under the name the MCP tools use. Send one of the two: when they name different accounts the request is refused 422 invalid on account_id. At least 1.

Returns

200 The account's standing.

Fields of the 200 answer
casesarray of objectsRequired

The unpaid invoices being followed up, the one due first at the top.

Fields of each item
currencystringRequired
delete_onstring or nullRequired

When the data is deleted. The same moment as retrieval_until. Format: date-time.

disputedbooleanRequired

Whether the invoice has an open dispute.

due_atstring or nullRequired

Format: date-time.

final_notice_atstring or nullRequired

When the final notice was sent. Format: date-time.

invoice_idintegerRequired

At least 1.

numberstringRequired

The invoice number.

outstandingnumberRequired

What is left to pay on the invoice, in currency.

overdue_daysintegerRequired

Whole days since the invoice was due.

retrieval_untilstring or nullRequired

Until when the data of ended services is kept. Format: date-time.

stagestringRequired

How far the follow-up has gone. final_notice: a final notice has been sent. suspended: the services are suspended. terminated: the services have ended and their data is kept until retrieval_until. settled_in_retrieval: the invoice was settled after the services ended. deleting: the data is being deleted.

final_noticesuspendedterminatedsettled_in_retrievaldeleting
suspend_onstring or nullRequired

When the services are suspended if the invoice is still unpaid. Format: date-time.

suspended_atstring or nullRequired

Format: date-time.

terminate_onstring or nullRequired

When the services end if the invoice is still unpaid. Format: date-time.

terminated_atstring or nullRequired

Format: date-time.

paused_untilstring or nullRequired

When Corefinity has paused the follow-up for your company, until when. Format: date-time.

restoreobjectRequired

What brings suspended services back. how is none when nothing is suspended or the data is being deleted, pay_invoices while paying the invoices brings them back by itself, and staff_reinstatement once the services have ended and Corefinity has to reinstate them. The other fields depend on how.

Fields
automaticboolean

Whether the services come back without anyone at Corefinity acting.

contactstring

With staff_reinstatement, how to ask for it.

howstringRequired
nonepay_invoicesstaff_reinstatement
invoice_idsarray of integers

With pay_invoices, the invoices to pay.

pay_urlsarray of strings

With pay_invoices, the page of each invoice in the Control Panel, as a path.

promisestring

With pay_invoices, how soon the services are back once the payment has cleared.

retrieval_untilstring or null

With staff_reinstatement, until when the data is kept. Format: date-time.

settledboolean

With staff_reinstatement, whether the invoice has been paid.

statestringRequired

The most advanced fact of the account. good: nothing is overdue. overdue: an invoice is past its due date. final_notice: a final notice has been sent. suspended: services are suspended. retrieval: services have ended and their data is still kept.

goodoverduefinal_noticesuspendedretrieval
suspended_servicesarray of objectsRequired
Fields of each item
idintegerRequired

At least 1.

namestringRequired

The site's domain or the CoreCluster's name. Empty when it is no longer your company's.

phasestringRequired
suspendedretrieval
sincestring or nullRequired

Format: date-time.

typestringRequired
sitecluster

If it is refused

StatusReasonWhat to do
401noneSend a valid token as Authorization: Bearer <token>.
403billing_forbiddenBilling is for the organisation's owner and billing contacts. Ask one of them to do this.
403company_unavailableYour company is unavailable.
403scope_requiredUse a token with the scope named in scope.
403two_factor_requiredTurn on two-factor on your account, then send again.
404feature_offThis feature is not on for your organisation yet.
422invalidFix the field named in field; errors says why.
429rate_limitedWait for the seconds in Retry-After.

Reasons are listed by name in Errors and refusals.

The same task elsewhere

curl https://manage.corefinity.com/api/corestack/billing/standing \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
{
  "cases": [
    {
      "currency": "GBP",
      "delete_on": null,
      "disputed": false,
      "due_at": "2026-11-01T00:00:00Z",
      "final_notice_at": "2026-11-07T06:00:00Z",
      "invoice_id": 8140,
      "number": "CF-100057",
      "outstanding": 240,
      "overdue_days": 8,
      "retrieval_until": null,
      "stage": "final_notice",
      "suspend_on": "2026-11-16T10:00:00Z",
      "suspended_at": null,
      "terminate_on": null,
      "terminated_at": null
    }
  ],
  "paused_until": null,
  "restore": {
    "how": "none"
  },
  "state": "final_notice",
  "suspended_services": []
}
Try it
Held in this tab's memory only. Never stored or sent to us.

Use a token with only the read scope. How to make one

Was this helpful?
Open in ClaudeOpen in ChatGPT