Get budget control
Gets whether budgets are checked, and over what period.
GET/v1/workspaces/{regionId}/budget-control
Returns
200 OK with the object shown in the response.
More details
Returns the workspace's budget control setting: off, warn or block, and the period budgets cover.
Any member of the buyer workspace, whatever their procurement role.
Response fields
mode"off" | "warn" | "block"off: budgets aren't checked. warn: an order or request over its cost center's budget goes ahead with a warning. block: it is refused with 409 over_budget.
period"month" | "quarter" | "year"The period a budget covers and spend is counted over.
Errors
- 401 Unauthorized - No credential was presented, or the Bearer token / X-Api-Key value is missing, invalid, expired, or revoked.
- 403 Forbidden - The caller's Bearer token or API key doesn't grant access to this workspace (regionId), or lacks the required role.
curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/budget-control" \
-H "X-Api-Key: $PLEAXY_API_KEY"{
"mode": "off" | "warn" | "block",
"period": "month" | "quarter" | "year",
"updatedAt": "string",
"updatedBy": "string"
}