Get a month of usage
Answers what the account accrued in one calendar month (UTC): the month's total, each day's total (a day on which nothing accrued is left out) and each contract line with its hours and its own days. credits_applied lists the credits applied to invoices whose period starts in the month, as negative amounts.
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.
The month, as YYYY-MM. Left out, the current month (UTC).
Returns
200 The month's usage.
Fields of the 200 answer
Fields of each item
The credit applied, as a negative amount.
Fields
Fields
At least 1.
Fields
At least 1.
Fields of each item
Fields
Format: date.
Fields of each item
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.
packageaddonuatFields of each item
Fields
Format: date.
The month, as YYYY-MM.
Fields
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/usage \
-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/usage');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/corestack/billing/usage', {
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/usage",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"credits_applied": [],
"currency": "GBP",
"days": [
{
"amount": {
"amount": "19.35",
"currency": "GBP"
},
"day": "2027-01-01"
},
{
"amount": {
"amount": "19.35",
"currency": "GBP"
},
"day": "2027-01-02"
},
{
"amount": {
"amount": "19.35",
"currency": "GBP"
},
"day": "2027-01-03"
}
],
"lines": [
{
"amount": {
"amount": "337.10",
"currency": "GBP"
},
"contract_line": {
"id": 9001,
"kind": "package",
"label": "CC8 · Northwind UK 1"
},
"days": [
{
"amount": {
"amount": "19.35",
"currency": "GBP"
},
"day": "2027-01-01",
"hours": 24
},
{
"amount": {
"amount": "19.35",
"currency": "GBP"
},
"day": "2027-01-02",
"hours": 24
},
{
"amount": {
"amount": "19.35",
"currency": "GBP"
},
"day": "2027-01-03",
"hours": 24
}
],
"hours": 418
}
],
"month": "2027-01",
"total": {
"amount": "337.10",
"currency": "GBP"
}
}{
"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
}