POST /api/billing/switch-to-payg

POST /api/billing/switch-to-payg

Switch To Payg

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

Parameters

Name	In	Type	Required	Description
`X-Org-ID`	header	string \| null	No	-

Request body

A JSON request body is accepted.

Field	Type	Required	Description
`refund_method`	string	No	Defaults to `"credit"`.

Example request

curl -X POST https://api.cognitivx.io/api/billing/switch-to-payg \
  -H "Authorization: Bearer icog_..." \
  -H "Content-Type: application/json" \
  -d '{
    "refund_method": "credit"
  }'

Example response

200 application/json

{
  "already_payg": false,
  "refunded_usd": 0,
  "refund_method": "string",
  "new_tier": "string",
  "requires_topup": false
}

Responses

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