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.
Name
id
Type
string
required
Description
Unique identifier for the event.
Example: evt_0SNlurA049MEWV5gNTcQ5A07h3Ol
Name
data
Type
object
PREVIEW
required
Description
Name
object
Type
string
required
Description
Type of object is always usageThresholdExceeded.
Name
allowance
Type
integer
required
Description
Indicates the absolute usage allowance in the subscription period. The value is in units specified by the unit field.
Name
plan
Type
string
required
Description
Unique plan identifier for the plan that provided the allowance.
Example: pln_0SNlurA049MEWV3V0q7gjQbM4EVo
Name
project
Type
string
required
Description
Unique project identifier.
Example: test
Name
subscription
Type
string
required
Description
Unique subscription identifier.
Example: sub_0SNlurA049MEWV2gSfSxi00xlPIi
Name
subscriptionAddons
Type
nullable array
required
Description
List of unique subscription add-on identifiers for add-ons that contributed to the allowance.
Example: sad_0SNlurA049MEWV2UNWPbDfW5B40U
Name
thresholdPercentage
Type
integer
required
Description
Indicates the usage threshold percentage which was exceeded.
Example: 75
>= 0
<= 100
Name
type
Type
string
required
Description
The usage type for the exceeded threshold.
Example: data
Allowed values: data, voice, sms
Name
unit
Type
string
required
Description
The unit of the usage and allowance values.
Example: byte
Allowed values: byte, second, message
Name
usage
Type
integer
required
Description
Indicates the absolute usage amount in the subscription period, at the time the threshold was exceeded. The value is in units specified by the unit field.
>= 0
Name
usageAt
Type
string
required
Description
Time associated to the usage that exceeded the threshold.
Example: 2021-01-21T19:38:34Z
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.
Name
version
Type
string
required
Description
API version used to serialize the data and the event itself.
Default: 2024-08-29

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-08-29"
}