CognitiveX Docs
API

POST /api/admin/payg/{user_id}/adjust

Payg Adjust

POST /api/admin/payg/{user_id}/adjust

Payg Adjust

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

Parameters

NameInTypeRequiredDescription
user_idpathstring (uuid)Yes-
X-Org-IDheaderstring | nullNo-

Request body

A JSON request body is required.

FieldTypeRequiredDescription
amount_usdnumberYes-
reasonstringYes-

Example request

curl -X POST https://api.cognitivx.io/api/admin/payg/{user_id}/adjust \
  -H "Authorization: Bearer icog_..." \
  -H "Content-Type: application/json" \
  -d '{
    "amount_usd": 0,
    "reason": "string"
  }'

Example response

200 application/json

{}

Responses

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