get_plan opens a plan’s compensations
and members; a compensation’s calculation is read per statement with
get_statement_compensation.
Parameters
Body
Body
string
A plan name or a plan id. A name matches as one phrase anywhere in the
plan’s name, ignoring case and accents (words are not matched separately). A
24-character hex value is read as a plan id and refused when no plan of this
environment has it.
boolean
True: only archived plans. False: only the others. It applies to a search by
id too.
string
Id of a sandbox from list_sandboxes, to read it instead of the live
environment. Omit it for live, the company’s real data, unless the question
is explicitly about a sandbox. Never a name, never the live id.
integer
Rows per page, 1 to 250. Default 50.
integer
Rows to skip. Omit it for the first page, never null or the string ‘None’;
for the next page pass the previous next_offset.