CognitiveX Docs
API

PUT /api/billing/payg-cap

Set Payg Cap

PUT /api/billing/payg-cap

Set Payg Cap

Authentication: Authorization: Bearer <key> or X-API-Key: <key>. Create keys at developers.cognitivx.io/keys.

Parameters

NameInTypeRequiredDescription
X-Org-IDheaderstring | nullNo-

Request body

A JSON request body is required.

FieldTypeRequiredDescription
monthly_cap_usdnumber | nullYes-

Example request

curl -X PUT https://api.cognitivx.io/api/billing/payg-cap \
  -H "Authorization: Bearer icog_..." \
  -H "Content-Type: application/json" \
  -d '{
    "monthly_cap_usd": 0
  }'

Example response

200 application/json

{
  "monthly_cap_usd": 0,
  "spent_this_month_usd": 0
}

Responses

StatusDescription
200Success. Returns the response body shown below.
422Request validation failed. detail lists each offending field.