Skip to main content
PUT
/
billing
/
hard-cap
cURL
curl --request PUT \
  --url https://api.useanima.sh/v1/billing/hard-cap \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled": true,
  "monthlyCapCents": 1,
  "meters": {
    "email": {
      "enabled": true,
      "capCents": 1
    },
    "sms": {
      "enabled": true,
      "capCents": 1
    },
    "voice": {
      "enabled": true,
      "capCents": 1
    }
  }
}
'
{
  "enabled": true,
  "monthlyCapCents": 1,
  "meters": {
    "email": {
      "enabled": true,
      "capCents": 1
    },
    "sms": {
      "enabled": true,
      "capCents": 1
    },
    "voice": {
      "enabled": true,
      "capCents": 1
    }
  }
}

Authorizations

​
Authorization
string
header
required

JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer

Body

application/json

Patch for hard-cap settings; missing fields preserve current values

​
enabled
boolean

Global toggle

​
monthlyCapCents
integer

Default monthly cap

Required range: x >= 0
​
meters
object

Per-meter overrides; partial (only changed fields)

Response

200 - application/json

OK

Hard-cap settings for the requesting org

​
enabled
boolean
required

Global hard-cap toggle. When false ALL meters bypass enforcement.

​
monthlyCapCents
integer
required

Default monthly cap when no per-meter override applies

Required range: x >= 0
​
meters
object
required

Per-meter configuration; each meter can override mode/cap independently