WEBHOOK
measurement.reported
{
  "type": "measurement.reported",
  "messageId": "a6ce...",
  "traceId": "549a...",
  "currentChange": 1,
  "usageUsedPercentage": 75,
  "currentUsage": 75,
  "hasUnlimitedUsage": false,
  "usageLimit": 100,
  "usagePeriodAnchor": "2022-02-21T00:00:00.000Z",
  "usagePeriodStart": "2022-08-21T00:00:00.000Z",
  "usagePeriodEnd": "2022-09-21T00:00:00.000Z",
  "resetPeriod": "MONTH",
  "resetPeriodConfiguration": {
    "accordingTo": "SubscriptionStart"
  },
  "feature": {
    "id": "feature-test-id",
    "name": "feature-test-name",
    "unit": "seat",
    "units": "seats",
    "description": "feature test description",
    "featureType": "NUMBER",
    "meterType": "INCREMENTAL",
    "status": "ACTIVE"
  },
  "customer": {
    "entityId": "customer-uuid",
    "id": "customer-test-id",
    "name": "customer-test-name",
    "email": "john@example.com"
  },
  "resource": null,
  "activeSubscriptions": [
    {
      "id": "subscription-test-id",
      "startDate": "2022-03-10T00:00:00.001Z",
      "plan": {
        "id": "plan-test-id",
        "name": "plan-test-name",
        "description": "plan description test",
        "status": "PUBLISHED"
      },
      "addons": [
        {
          "id": "addon-test-id",
          "name": "addon-test-name",
          "description": "addon test description",
          "status": "PUBLISHED",
          "quantity": 5
        }
      ],
      "metadata": {
        "testKey": "example value"
      }
    }
  ]
}

Body

application/json
type
string

Event type discriminator.

Allowed value: "measurement.reported"
messageId
string

Unique webhook message ID.

traceId
string

Correlation ID for tracing.

currentChange
number

Increment/decrement amount reported in this measurement.

usageUsedPercentage
number

Percentage of usage consumed relative to limit.

currentUsage
number

Total usage after applying this measurement.

hasUnlimitedUsage
boolean

Whether the entitlement is unlimited.

usageLimit
number | null

Max usage for the period when not unlimited.

usagePeriodAnchor
string<date-time>

Anchor timestamp used to compute the usage window.

usagePeriodStart
string<date-time>

Start of the usage window that this measurement belongs to.

usagePeriodEnd
string<date-time>

End of the usage window that this measurement belongs to.

resetPeriod
string

Interval at which usage resets (e.g.

resetPeriodConfiguration
object

Configuration that defines how the reset anchor is chosen.

feature
object

Canonical representation of a feature that can be packaged in plans or add-ons.

customer
object

Customer context for whom the measurement is reported.

resource
any

Resource context if the entitlement is resource-scoped.

activeSubscriptions
object[]

Subscriptions active at the time of measurement.