get_plan.
Which environment it lands in comes from the plan, so a plan you can’t access
reads exactly like one that doesn’t exist — a plan living in a sandbox you may
not read included. There is no sandbox_id argument on this tool for the same
reason.
Available only where the Qobra write tools beta is enabled. Every write to the
live environment is recorded in the audit trail as the Qobra MCP agent;
writes to a sandbox are not audited.
Parameters
Body
Body
string
required
Id of the plan the compensation hangs off — the id list_plans returns.
The plan also decides which environment the compensation lands in, so
there is no sandbox argument here.
string
required
Display name of the compensation, as people will read it on the plan —
‘New business commission’, ‘Q1 accelerator’.
string
How often the compensation is calculated. Defaults to
EACH_MONTH.string
YYYY-MM; the first month the compensation applies to. Pass it with
end_date to bound the compensation to a window, or omit both to leave
it recurring (applying every period).string
YYYY-MM; the last month the compensation applies to, included. Goes
together with
start_date.Response
Body
Body
object
The compensation as it now exists — the same row get_plan lists on the
plan, so the id can be reused straight away.