To let an assistant use these tools, grant Organisation on the consent screen, or just
Subcontext plan & credit under its Fine-tune. The scope is subscription.
Read tools work with Read only or Read & write access; write tools only with
Read & write.
Your assistant doesn't see these tools straight away. It finds them with search_tools or
describe_tools, and runs one with use_tool, passing its name and
arguments. Most assistants do this for you: just ask for what you want.
What your assistant is told about this group
Your organisation's own Subcontext account (not insurance premiums: those are the billing group): plan, prepaid credit or usage this month, saved cards, invoices and VAT number. Almost everything is owner-only. change_plan, top_up_credit, set_auto_top_up and pay_subscription_invoice SPEND MONEY: preview first and get the user's clear agreement to the amount. Adding a card and card security checks (3D Secure) happen in the dashboard.
The descriptions below are the ones your assistant reads, so they're written for it. When a connection covers more than one
organisation, the assistant passes org (the organisation's slug, from list_orgs) to say which one.
get_subscription
Read Get the SaaS subscription
The org's Subcontext plan and subscription: current plan (at the price this org pays), any scheduled downgrade, status and cancellation, the plans it may switch to, and the latest invoices. Owner-only.
Arguments
| Field | Type | Description |
|---|---|---|
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
list_subscription_plans
Read List Subcontext plans
The billable plans this org can choose (public plans plus any assigned to it) and the one it is on. Any member may look; changing plan is owner-only (preview_plan_change, change_plan).
Arguments
| Field | Type | Description |
|---|---|---|
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
get_credit_balance
Read Get credit balance or usage
What the org has to spend. Prepay orgs: credit balance, what is available after holds, automatic top-up settings and recent movements. Arrears orgs: month-to-date AI and channel spend against each plan allowance, and the overage so far. Owner-only.
Arguments
| Field | Type | Description |
|---|---|---|
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
list_credit_history
Read List credit history
The full prepaid-credit ledger, usage debits included, newest first, 25 per page (more: true when another page follows). Prepay orgs only. Owner-only.
Arguments
| Field | Type | Description |
|---|---|---|
| page | integer | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
list_subscription_invoices
Read List Subcontext invoices
The org's invoices from Subcontext (plan, credit top-ups, usage), newest first, 25 per page. card_payable marks one pay_subscription_invoice can settle. Owner-only.
Arguments
| Field | Type | Description |
|---|---|---|
| page | integer | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
get_subscription_invoice
Read Get a Subcontext invoice
One of the org's Subcontext invoices. The PDF downloads from the dashboard. Owner-only.
Arguments
| Field | Type | Description |
|---|---|---|
| invoice_id required | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
list_saved_cards
Read List saved cards
The cards saved for Subcontext billing, the default (what the renewal charges) first. Adding a card happens in the dashboard's secure card form. Owner-only.
Arguments
| Field | Type | Description |
|---|---|---|
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
preview_plan_change
Read Preview a plan change
Stripe's real figures for moving to another plan: an upgrade charges a prorated amount today; a downgrade takes effect at the end of the period. Changes nothing. Show these numbers to the user before change_plan. Owner-only.
Arguments
| Field | Type | Description |
|---|---|---|
| plan_key required | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
change_plan
Write Change the Subcontext plan
SPENDS MONEY on an upgrade. Moves the org to another plan: an upgrade charges the prorated difference to the default card now; a downgrade is scheduled for the period end. Always run preview_plan_change and get the user's explicit agreement to the amount first. If the bank asks for 3D Secure, the user finishes it on the Billing page. Owner-only.
Arguments
| Field | Type | Description |
|---|---|---|
| plan_key required | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
cancel_plan_downgrade
Write Cancel a scheduled downgrade
Drops a scheduled downgrade so the org stays on its current plan. Owner-only.
Arguments
| Field | Type | Description |
|---|---|---|
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
cancel_subscription
Write Cancel the Subcontext subscription
Cancels at the end of the paid period: access continues until access_until, and resume_subscription undoes it before then. Confirm with the user first. reason is one of too_expensive, not_using, missing, switching, temporary, other. Owner-only.
Arguments
| Field | Type | Description |
|---|---|---|
| reason | string |
One of: "too_expensive", "not_using", "missing", "switching", "temporary", "other"
|
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
resume_subscription
Write Resume the Subcontext subscription
Undoes a cancellation while the paid period is still running. Owner-only.
Arguments
| Field | Type | Description |
|---|---|---|
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
top_up_credit
Write Buy prepaid credit
SPENDS MONEY. Buys prepaid credit: amount_gbp is one of 10, 20, 50, 100, 200, 300, 500, 1000, charged to the chosen saved card (list_saved_cards) or the default. Confirm the amount and card with the user first. Prepay orgs only. Owner-only.
Arguments
| Field | Type | Description |
|---|---|---|
| amount_gbp required | integer |
One of: 10, 20, 50, 100, 200, 300, 500, 1000
|
| payment_method_id | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
set_auto_top_up
Write Set automatic top-ups
Commits the org to repeat card payments. Turns automatic credit top-ups on or off: when credit reaches its last 10%, amount_gbp is bought on the default card, up to ceiling_gbp a month. Confirm with the user first. Prepay orgs only. Owner-only.
Arguments
| Field | Type | Description |
|---|---|---|
| enabled required | boolean | |
| amount_gbp required | integer |
One of: 10, 20, 50, 100, 200, 300, 500, 1000
|
| ceiling_gbp | integer | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
set_tax_number
Write Set the VAT number
Sets the VAT (or local tax) number on the org's invoices, which decides whether VAT is charged or reverse-charged. Blank clears it. Owner-only.
Arguments
| Field | Type | Description |
|---|---|---|
| tax_id required | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
set_default_card
Write Set the default card
Makes a saved card (list_saved_cards) the default: what the monthly renewal charges and what top-ups use unless another is picked. Owner-only.
Arguments
| Field | Type | Description |
|---|---|---|
| payment_method_id required | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
remove_saved_card
Write Remove a saved card
Removes a saved card. The default card can't go while another card exists, and the last card can't go while the subscription renews on it. Owner-only.
Arguments
| Field | Type | Description |
|---|---|---|
| payment_method_id required | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
pay_subscription_invoice
Write Pay a Subcontext invoice
SPENDS MONEY. Pays one of the org's pending invoices (card_payable in list_subscription_invoices) with a saved card, or the default. Confirm the invoice, amount and card with the user first. If the bank asks for 3D Secure, the user finishes it on the invoice's payment page (payment_url). Owner-only.
Arguments
| Field | Type | Description |
|---|---|---|
| invoice_id required | string | |
| payment_method_id | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |