seats.limit_reached

{ "event": "seats.limit_reached", "timestamp": "2026-06-23T14:30:00.000Z", "organizationId": "8f14e45f-ceea-4e7a-9c3d-1c2b3a4d5e6f", "mode": "live", "apiVersion": "2026-08-27", "data": { "customerId": "user_123", "subscriptionId": "sub_1a2b3c4d", "featureCode": "editors", "currentSeats": 5, "includedSeats": 5 } }

When this fires

When a seat change moves the count from below the plan’s included seat limit to at or above it. It fires once per crossing — removing seats and re-adding past the limit fires it again. Plans with unlimited seats never fire it.

Seats are not blocked at the limit: counts above the included amount are allowed and billed as overage when the plan enables it.

Use it to prompt an upgrade to a higher tier before overage kicks in.

Body

application/json

string

required

event

string

required

Allowed value: "seats.limit_reached"

timestamp

string

required

organizationId

string

required

mode

enum<string>

required

Available options:

live,

sandbox

apiVersion

string

required

data

object

required

Show child attributes

Response

200

Return any 2xx status code to acknowledge receipt of the event.

Overview

Events

seats.limit_reached

When this fires

Body

Response

​When this fires

Body

Response

When this fires