CorefinityCorefinityDocs
Open the Control PanelControl Panel
Billing · 13 of 17

corestack_billing_contracts_list

Billing contracts.

Scope readNo secrets returned
On this page

When to use it

List a billing account's active contract lines: what each covers and what it costs a month.

Through the REST API (/api/corestack/billing/…) the account is account, as on the Billing pages; account_id, this tool's name, is accepted there too as its alias.

Ask for it

Prompt
Using the Corefinity MCP server, call corestack_billing_contracts_list. (Billing contracts.) Tell me what it returned.

Inputs

account_idinteger

One of your company's billing accounts (corestack_billing_account_get gives its id); omitted, the company's default account. At least 1.

Example call

tools/call
{
  "name": "corestack_billing_contracts_list",
  "arguments": {}
}

If it is refused

ReasonWhat to do
invalid_argumentsThe arguments do not match the tool's input schema, or the Control Panel refused a field. Fix the fields named in the answer and call again.
tenant_mismatchThe object does not exist or the token may not see it. Check the id.
scope_requiredThe token lacks a scope this call needs. Open the link in the answer to add it, then call again.
pin_refusedThe grant is limited to chosen clusters, sites or environments, and this call is outside them. Open the link in the answer to widen it.
rate_limitedToo many calls. Wait for the number of seconds the answer names.
temporarily_unavailableThe Control Panel could not answer just now. Nothing was started; try again shortly.
internal_errorSomething went wrong on our side. Quote the trace id to support.

The answer

One row per contract line. Each line's contract says when that contract bills from, in the words the Control Panel's Billing page uses:

  • billing_starts: started, or on_delivery while its site or CoreCluster is still being created. Nothing is billed for it and its free trial has not started yet.
  • billing_starts_at: the first hour it bills (ISO 8601, UTC). When a create took longer to finish, it is when the site or CoreCluster was first ready, and the free trial runs its full length from then. It is null while the contract is on_delivery, and for a contract opened before this field existed (its starts_on is then its first day).
  • billing_starts_note: the sentence to show while the contract is on_delivery, "Billing starts when your site is ready." or "Billing starts when your CoreCluster is ready."; otherwise null.
  • billing_period: monthly or annual — how often the contract is invoiced.
  • first_billed_at: the first hour the contract was charged for (ISO 8601, UTC), or null while nothing has been charged yet (during a free trial).
  • money_back: the money-back guarantee it was opened with — {days, until, state} — or null when it carries none. until is when the window ends (ISO 8601, UTC), or null until the first paid hour ("from your first paid day"); state is available, claimed, refunded or expired.

The same task elsewhere

Was this helpful?
Open in ClaudeOpen in ChatGPT