Environments Create Environment
environments_create_environmentDestructive
Create a costing environment, a named set of machines, tools, rates and
overrides that calculations are priced in. By default it starts as a copy of
your default environment; source can start it blank (tools only) or empty.
Counts against your plan's environment limit.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Human-readable name for the new environment. | |
| empty | No | Skip the documented default of attaching every tool in your crib to the new environment. With explicit tool membership (each environment prices only the tools attached to it), an empty environment unambiguously means 'deliberately empty'. | |
| region | No | Geographic region this environment prices for (e.g. DE, US). | |
| source | No | What the new environment starts from. ``baseline_copy`` (the default): a copy of your default environment — its machines, tools, rates and overrides. ``blank``: a new environment with every tool of your crib attached and no machines. ``empty``: nothing attached. Omitted → ``baseline_copy`` (or ``empty`` when the legacy ``empty: true`` is sent). | |
| currency | No | ISO 4217 currency code the environment's rates are denominated in. | EUR |
| valid_to | No | ISO date (YYYY-MM-DD) the environment stops being effective; null = open-ended. | |
| valid_from | Yes | ISO date (YYYY-MM-DD) from which the environment is effective. | |
| description | No | Optional longer description of the environment. |