Get billing status
well_get_billing_statusRead the billing status of this workspace: the plan, its status (trialing, active, past_due, suspended, canceled or trial_ended), the trial-end date or the renewal date, a scheduled cancellation or plan change, the tokens left, and the link to the workspace's billing page in Well. Use it when the person asks which plan the workspace is on, whether the trial or the subscription still runs, when it renews or ends, how many tokens are left, or where to manage billing ("quel est mon forfait ?", "when does my trial end?", "how many tokens do we have left?").
Answer in plain text from summary and the fields. There is no card. Give billing_url exactly as returned and build no link of your own. Say a date, a count or a plan name only as the tool returned it.
This tool only reads. It changes no plan, takes no payment and cancels nothing. To change the plan, pay, cancel or change the card, the person uses the billing page.
Only a workspace owner or admin reads billing. For any other member the call returns outcome: "not_admin" and no plan, date or link: say that only an owner or an admin of the workspace sees billing, and that they can ask one of them. outcome: "billing_off": Well is free during the launch, the workspace has nothing to pay, and Well tells the person before any charge; say so, and give billing_url, where an owner or an admin tells the Well team they want to pay. outcome: "no_plan": the workspace has no plan or trial on record yet; give the billing link. outcome: "charged_to_company": this is the person's personal space and the company workspace they belong to pays for their work here, so it has no plan of its own; say so, give no plan, date, token count or link, and say that the company's owners and admins see its plan.
When the token authorizes one workspace, call this directly — no workspace call is needed first. When it authorizes several, this read will not guess which one you mean: pass workspace_id on the call.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| workspace_id | No | Target workspace. Omit when the token authorizes one workspace. Required when it authorizes several: this read reports one workspace's own figures and will not choose which. | |
| conversation_id | No | The conversation id returned by the previous Well result, in its meta under well/conversation_id, in its structuredContent, or in its JSON text block. Pass it back on every call in the same conversation, including a call a card makes, so the chosen workspace and the earlier answers still apply. It decides the conversation on its own: nothing the host states about the session replaces it. Omit it only on the first call of a conversation. | |
| workspace_scope | No | Restrict this call to the family: the token's primary workspace plus the company workspaces under it that you are a member of. Unrelated authorized workspaces drop out of the read; row reads merge across the family, while a per-workspace figure still reports exactly one workspace. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| plan | No | The plan's name, or null when the workspace has none. | |
| error | No | ||
| status | No | trialing, active, past_due (a payment failed), canceled, or trial_ended. | |
| ends_at | No | The date (YYYY-MM-DD) a running plan stops, when a cancellation is scheduled and the plan does not renew. | |
| outcome | No | read: the plan and its dates follow. not_admin: the caller is not an owner or an admin, so nothing else is returned. billing_off: Well is free during the launch, so there is nothing to pay yet. no_plan: the workspace has no plan or trial on record yet. charged_to_company: a personal space whose work the person's company workspace pays for, so nothing else is returned. | |
| success | Yes | ||
| summary | No | The plain-text answer, in English. Say it in the person's language; change no figure, date or link. | |
| plan_key | No | ||
| next_plan | No | The plan the workspace moves to at `next_plan_at`, when a change is scheduled. | |
| renews_at | No | The next renewal date (YYYY-MM-DD) of an active plan that renews. | |
| billing_url | No | The workspace's billing page in Well. Give it exactly as returned. Absent for a caller who is not an owner or an admin. | |
| tokens_left | No | The tokens left in the workspace's pool, plan and top-ups together, or null when Well does not know it now. | |
| next_plan_at | No | ||
| workspace_id | No | ||
| trial_ends_at | No | The date (UTC, YYYY-MM-DD) the free trial ends, when there is one. The trial still runs while `status` is trialing. | |
| conversation_id | No | The conversation this result belongs to. Pass it back as the conversation_id argument on every later Well call in the same conversation. | |
| newly_connected | No | Tools that connected to this workspace since the last result and that no session was told about yet, oldest first. Present only when at least one tool is new. The connected-line rule says when to tell an entry; when it does, one line per entry, in the person's language: "<name> is connected.". Never fold several entries into one sentence. Each entry comes back once, on one result only: never repeat its line later. | |
| resolved_workspace | No | The workspace that answered, when the caller named none and the token authorizes several. | |
| conversation_id_note | No | Present only when the server opened a fresh lane, stating that no choice recorded earlier was read. | |
| conversation_id_source | No | Where the conversation id came from: the host's own request meta, the caller's argument, or a fresh lane the server opened. |