com.gigs.usageThreshold.exceeded

Deprecated

This event is deprecated and will be removed in the future. Please use com.gigs.usageNotification.created instead. That event fires with type thresholdExceeded at the same time as this one.

Fires whenever a data, sms or voice usage threshold is exceeded. The currently-supported thresholds are 70%, 90% and 100%.

Name
object
Type
string
required
Description
Type of object is always event.
Allowed values: event
Name
id
Type
string
required
Description
Unique identifier for the event.
Example: "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
Name
data
Type
UsageThresholdExceeded
required
Description
Name
datacontenttype
Type
string
required
Description
The RFC 2046 content-type.
Example: "application/json"
Default: application/json
Name
project
Type
string
required
Description
Unique identifier for the project where the event occurred.
Example: "gigs"
Name
source
Type
string
required
Description
URI identifying the event source.
Example: "https://api.gigs.com"
Default: https://api.gigs.com
Name
specversion
Type
string
required
Description
The CloudEvents spec version.
Example: "1.0"
Default: 1.0
Name
time
Type
string
required
Description
Time when the event occurred.
Example: "2022-03-16T14:12:42Z"
Name
type
Type
string
required
Description
Type is always com.gigs.usageThreshold.exceeded.
Allowed values: com.gigs.usageThreshold.exceeded
Name
version
Type
string
required
Description
API version used to serialize the data and the event itself.
Default: 2024-12-20

Example

{
  "object": "event",
  "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
  "data": {
    "object": "usageThresholdExceeded",
    "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
    "project": "test",
    "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
    "subscriptionAddons": [
      "sad_0SNlurA049MEWV2UNWPbDfW5B40U"
    ],
    "thresholdPercentage": 75,
    "type": "data",
    "unit": "byte",
    "usageAt": "2021-01-21T19:38:34Z"
  },
  "datacontenttype": "application/json",
  "project": "gigs",
  "source": "https://api.gigs.com",
  "specversion": "1.0",
  "time": "2022-03-16T14:12:42Z",
  "type": "com.gigs.usageThreshold.exceeded",
  "version": "2024-12-20"
}