Get the billing account
Answers your company's billing account: its details and VAT basis, its balance, its card or Direct Debit mandate, its contract lines, the next invoice and what you may do; with=details adds the billing contacts and the countries the billing address may be in. Editing the details, paying an invoice and adding or removing a card or mandate are done in the Control Panel.
Query parameters
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.
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.
details adds billing_contacts and countries, which are null without it.
detailsReturns
200 The billing account.
Fields of the 200 answer
Whether invoices are collected automatically.
Fields
What has accrued this month so far.
Fields
What has accrued and is not invoiced yet, plus what is outstanding on open invoices.
Fields
Fields
The last hour that was accrued. Format: date-time.
Fields of each item
What the line has accrued this month.
Fields
A line of a contract, by name.
Fields
At least 1.
package, an addon (extra cores, memory, disk, log storage, a dedicated IP address) or uat, a staging environment.
packageaddonuatThe line's price for one hour, with six decimal places.
Fields
Fields
Format: date-time.
What is due on open invoices.
Fields
This month (UTC).
Fields
Format: date-time.
Format: date-time.
Fields of each item
Fields
Format: date-time.
At least 1.
usage_mtdinvoicepaymentrefundcredit_appliedcredit_grantadjustmentThe last hour the running figure counts. Format: date-time.
With with=details, the company's owners and then its billing contacts. Otherwise null.
Fields
At least 1.
Fields of each item
Fields
metered: billed by the hour.
monthlyannualon_delivery while the site or CoreCluster is still being created: nothing is billed and the free trial has not started.
startedon_deliveryThe first hour the contract bills from. null while on_delivery, and for an older contract, whose starts_on is its first day. Format: date-time.
While on_delivery, the sentence the Control Panel shows. Otherwise null.
The first hour the contract was charged for. Format: date-time.
At least 1.
The money-back guarantee the contract was opened with, or null when it has none.
Format: date.
draftactiveexpiredcancelledFormat: date-time.
The price for one hour, with six decimal places.
Fields
At least 1.
packageaddonuatWhat changes the line's price, such as the Performance server type or the region.
Fields of each item
Fields
Fields
cs CoreStack, cc CoreCluster, cse CoreStack Enterprise.
cscccseStandardPerformanceFormat: date-time.
What the line is for.
Fields
Its page in the Control Panel, as a path.
Fields
At least 1.
siteclusterWhat one of quantity is, for an add-on (core or GB).
When the line ends, for one that a change has replaced. null while it runs on. Format: date-time.
With with=details, the countries the billing address may be in. Otherwise null.
Whether the currency is fixed. It is, from the account's first invoice.
The card that is charged first, or null.
The demos billed to this account. A demo bills nothing until it is kept.
Fields of each item
Format: date-time.
At least 1.
Format: date-time.
At least 1.
What every open contract line costs a month in all.
Fields
The next invoice, or null when none is due.
The purchase order reference written on invoices.
What you may do with the account.
Fields
Whether you may pay an invoice. Paying is done in the Control Panel.
billing_forbidden when you may not read the account, else null.
The account's free trial, or null.
The VAT basis of the account.
Fields
Whether Corefinity has recorded the buyer as a business or a consumer, when it has.
An open check of the account's VAT by Corefinity, or null.
The country VAT is judged for, as a two-letter code.
How VAT applies, such as standard, reverse_charge or outside_scope.
The basis in words, as invoices carry it.
Fields
The state of the VAT number. none: there is no number. pending: it is being checked. valid and invalid: the outcome. unverified: it could not be checked. not_applicable: numbers of that country are not checked.
validunverifiedinvalidnonenot_applicablependingFormat: date-time.
The version of the billing details. Send it back when you save the VAT number.
If it is refused
| Status | Reason | What to do |
|---|---|---|
401 | none | Send a valid token as Authorization: Bearer <token>. |
403 | billing_forbidden | Billing is for the organisation's owner and billing contacts. Ask one of them to do this. |
403 | company_unavailable | Your company is unavailable. |
403 | scope_required | Use a token with the scope named in scope. |
403 | two_factor_required | Turn on two-factor on your account, then send again. |
404 | feature_off | This feature is not on for your organisation yet. |
422 | invalid | Fix the field named in field; errors says why. |
429 | rate_limited | Wait 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/account \
-H "Authorization: Bearer $COREFINITY_TOKEN" \
-H "Accept: application/json"use Illuminate\Support\Facades\Http;
$response = Http::withToken(env('COREFINITY_TOKEN'))
->acceptJson()
->get('https://manage.corefinity.com/api/corestack/billing/account');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/corestack/billing/account', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
Accept: 'application/json',
},
});
// An answer with no body (204) has nothing to parse.
const text = await res.text();
const data = text && JSON.parse(text);import os
import requests
res = requests.get(
"https://manage.corefinity.com/api/corestack/billing/account",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"address": {
"city": "Manchester",
"country": "GB",
"line1": "14 Quay Street",
"line2": null,
"postcode": "M1 1AA"
},
"auto_charge": true,
"backup_method": null,
"balance": {
"accrued_this_period": {
"amount": "337.10",
"currency": "GBP"
},
"balance": {
"amount": "1057.10",
"currency": "GBP"
},
"credits_available": {
"amount": "25.00",
"currency": "GBP"
},
"currency": "GBP",
"last_accrual_at": null,
"lines": [
{
"accrued": {
"amount": "337.10",
"currency": "GBP"
},
"contract_line": {
"id": 9001,
"kind": "package",
"label": "CC8"
},
"hourly": {
"amount": "0.806452",
"currency": "GBP"
},
"hours": 418,
"monthly": {
"amount": "600.00",
"currency": "GBP"
}
}
],
"next_invoice_at": "2027-02-01T00:30:00Z",
"outstanding": {
"amount": "720.00",
"currency": "GBP"
},
"period": {
"end": "2027-02-01T00:00:00Z",
"start": "2027-01-01T00:00:00Z"
},
"recent_activity": [
{
"amount": {
"amount": "337.10",
"currency": "GBP"
},
"contract_id": 5120,
"currency": "GBP",
"kind": "usage_mtd",
"product": "CC8 · Northwind UK 1",
"through": null
},
{
"amount": {
"amount": "25.00",
"currency": "GBP"
},
"at": "2027-01-12T14:20:00Z",
"description": "Credit granted · Goodwill credit",
"invoice": null,
"kind": "credit_grant"
},
{
"amount": {
"amount": "720.00",
"currency": "GBP"
},
"at": "2027-01-01T00:30:00Z",
"description": "Invoice CF-100057",
"invoice": {
"id": 8140,
"number": "CF-100057"
},
"kind": "invoice"
},
{
"amount": {
"amount": "-660.00",
"currency": "GBP"
},
"at": "2026-12-01T00:31:12Z",
"description": "Payment for CF-100042",
"invoice": {
"id": 8123,
"number": "CF-100042"
},
"kind": "payment"
},
{
"amount": {
"amount": "-60.00",
"currency": "GBP"
},
"at": "2026-12-01T00:30:00Z",
"description": "Credit applied to CF-100042",
"invoice": {
"id": 8123,
"number": "CF-100042"
},
"kind": "credit_applied"
},
{
"amount": {
"amount": "720.00",
"currency": "GBP"
},
"at": "2026-12-01T00:30:00Z",
"description": "Invoice CF-100042",
"invoice": {
"id": 8123,
"number": "CF-100042"
},
"kind": "invoice"
},
{
"amount": {
"amount": "50.00",
"currency": "GBP"
},
"at": "2026-11-01T09:00:00Z",
"description": "Credit granted · Welcome credit",
"invoice": null,
"kind": "credit_grant"
}
]
},
"billing_contacts": [
{
"email": "[email protected]",
"id": 2051,
"name": "Maya Okafor",
"role": "owner"
}
],
"billing_email": "[email protected]",
"billing_name": "Northwind Digital Ltd",
"company": {
"id": 1180,
"name": "Northwind Digital"
},
"contracts": [
{
"contract": {
"billing_model": "metered",
"billing_period": "monthly",
"billing_starts": "started",
"billing_starts_at": "2026-11-01T01:00:00Z",
"billing_starts_note": null,
"first_billed_at": "2027-01-01T00:00:00Z",
"id": 5120,
"money_back": null,
"reference": "MC-1180-1",
"starts_on": "2026-11-01",
"status": "active",
"trial_ends_at": null
},
"hourly": {
"amount": "0.806452",
"currency": "GBP"
},
"id": 9001,
"kind": "package",
"label": "CC8 · Northwind UK 1",
"modifiers": [],
"monthly": {
"amount": "600.00",
"currency": "GBP"
},
"product": {
"line": "cc",
"region": "United Kingdom",
"server_type": "Standard"
},
"quantity": 1,
"since": "2026-11-01T01:00:00Z",
"subject": {
"href": "/managed-clusters/clusters/1017",
"ref": {
"id": 1017,
"name": "Northwind UK 1"
},
"type": "cluster"
},
"unit": null,
"until": null
}
],
"countries": [
{
"code": "GB",
"name": "United Kingdom"
},
{
"code": "IE",
"name": "Ireland"
},
{
"code": "US",
"name": "United States"
}
],
"currency": "GBP",
"currency_locked": false,
"default_method": {
"added_at": "2026-11-01T09:05:00Z",
"brand": "visa",
"exp_month": 12,
"exp_year": 2030,
"id": 4410,
"kind": "card",
"label": null,
"last4": "4242",
"provider": "stripe",
"role": "primary",
"state": "active",
"wallet": null
},
"demos": [],
"id": 3107,
"is_default": true,
"mandate": null,
"monthly_total": {
"amount": "600.00",
"currency": "GBP"
},
"name": "Northwind Digital's default billing account",
"next_invoice": {
"estimate": {
"amount": "937.10",
"currency": "GBP"
},
"issues_at": "2027-02-01T00:30:00Z",
"period_end": "2027-02-01T00:00:00Z",
"trial": false
},
"po_reference": "PO-2027-014",
"rights": {
"can_edit": true,
"can_pay": false,
"can_view": true,
"reason": null
},
"trial": null,
"vat": {
"buyer": null,
"check": null,
"country": "GB",
"kind": "standard",
"label": "UK VAT 20 %",
"rate_percent": 20,
"validation": {
"state": "none",
"validated_at": null
}
},
"vat_number": null,
"version": 1184934486
}{
"message": "Unauthenticated."
}{
"code": "billing_forbidden",
"message": "Billing is available to your company's owner and billing contacts.",
"reason": "billing_forbidden"
}{
"code": "feature_off",
"message": "Not found.",
"reason": "feature_off"
}{
"code": "invalid",
"errors": {
"account_id": [
"Send account or account_id, not both: they name different billing accounts."
]
},
"field": "account_id",
"message": "Send account or account_id, not both: they name different billing accounts.",
"reason": "invalid"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}