corestack_ billing_ contracts_ list
Billing contracts.
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
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
{
"name": "corestack_billing_contracts_list",
"arguments": {}
}If it is refused
| Reason | What to do |
|---|---|
invalid_arguments | The 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_mismatch | The object does not exist or the token may not see it. Check the id. |
scope_required | The token lacks a scope this call needs. Open the link in the answer to add it, then call again. |
pin_refused | The 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_limited | Too many calls. Wait for the number of seconds the answer names. |
temporarily_unavailable | The Control Panel could not answer just now. Nothing was started; try again shortly. |
internal_error | Something 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, oron_deliverywhile 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 isnullwhile the contract ison_delivery, and for a contract opened before this field existed (itsstarts_onis then its first day).billing_starts_note: the sentence to show while the contract ison_delivery, "Billing starts when your site is ready." or "Billing starts when your CoreCluster is ready."; otherwisenull.billing_period:monthlyorannual— how often the contract is invoiced.first_billed_at: the first hour the contract was charged for (ISO 8601, UTC), ornullwhile nothing has been charged yet (during a free trial).money_back: the money-back guarantee it was opened with —{days, until, state}— ornullwhen it carries none.untilis when the window ends (ISO 8601, UTC), ornulluntil the first paid hour ("from your first paid day");stateisavailable,claimed,refundedorexpired.
The same task elsewhere
Was this helpful?