Справочник API публикуется на английском языке.
Create or update a budget policy
POST
/api/companies/{companyId}/budgets/policiesPersonal API keyConsole session
Create or update a budget policy.
Авторизация
Send a personal API key as Authorization: Bearer <key>. It acts as you, with your permissions in each organization. Agent API keys are refused with 403. Как работают ключи.
Параметры пути
companyIdstringОбязательныйThe organization's id.
Тело запроса
application/json · обязательно
scopeTypestringОбязательный
one of: "company", "agent", "project", "issue"scopeIdstring (uuid)Обязательный
metricstringНеобязательный
one of: "billed_cents"windowKindstringНеобязательный
one of: "calendar_month_utc", "lifetime"amountintegerНеобязательный
≥ 0≤ 2147483647reservationCentsstring | numberНеобязательный
warnPercentintegerНеобязательный
≥ 1≤ 99hardStopEnabledbooleanНеобязательный
unpricedUsagePolicystringНеобязательный
one of: "block", "allow"notifyEnabledbooleanНеобязательный
isActivebooleanНеобязательный
Ответы
200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation.
details names each field that failed.401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.