Create budget alert

Add an alert threshold to the company’s budget. Requires CompanyAdmin role.

POST /api/v3/billing/budget/alerts

Create budget alert

cURL

curl --request POST \
  --url https://paradigm.lighton.ai/api/v3/billing/budget/alerts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "threshold_value": "<string>"
}
'

201

{
  "id": 123,
  "is_enabled": true,
  "threshold_type": "<string>",
  "threshold_value": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

threshold_type · enum<string> · required

'percentage' of budget or 'absolute' EUR amount.

Available options: percentage, absolute

threshold_value · string · required

e.g. 75.00 for 75% or 500.00 for 500 EUR.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

is_enabled · boolean · default: true

Whether this alert is active.

Response

201

application/json

id · integer · required

is_enabled · boolean · required

threshold_type · string · required

threshold_value · string · required

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$