com.gigs.usageNotification.created

Triggered when a new usage notification is created.

The currently-supported types of usage notification are:

started, which is fired when the subscription is first used.
throttled, which is fired when the subscription has had its data usage throttled to a lower bandwidth.
thresholdExceeded, which is fired when the subscription has used 70%, 90% and 100% of its data, sms or voice allowance.

Name
object
Type
string
Description
Type of object is always event.
Allowed values: event
Name
id
Type
string
Description
Unique identifier for the event.
Example: "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
Name
data
Type
UsageNotification
Description
Example: {"object":"usageNotification","subscription":"sub_0SNlurA049MEWV2gSfSxi00xlPIi","thresholdExceeded":null,"throttled":{"thresholdBytes":10000000000,"bandwidthBitsPerSecond":512000,"until":"2021-02-20T19:38:34Z"},"type":"throttled"}
Name
datacontenttype
Type
string
Description
The RFC 2046 content-type.
Example: "application/json"
Default: application/json
Name
project
Type
string
Description
Unique identifier for the project where the event occurred.
Example: "gigs"
Name
source
Type
string
Description
URI identifying the event source.
Example: "https://api.gigs.com"
Default: https://api.gigs.com
Name
specversion
Type
string
Description
The CloudEvents spec version.
Example: "1.0"
Default: 1.0
Name
time
Type
string
Description
Time when the event occurred.
Example: "2022-03-16T14:12:42Z"
Name
type
Type
string
Description
Type is always com.gigs.usageNotification.created.
Allowed values: com.gigs.usageNotification.created
Name
version
Type
string
Description
API version used to serialize the data and the event itself.
Default: 2024-12-20

Example

{
  "object": "event",
  "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
  "data": {
    "object": "usageNotification",
    "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
    "thresholdExceeded": null,
    "throttled": {
      "thresholdBytes": 10000000000,
      "bandwidthBitsPerSecond": 512000,
      "until": "2021-02-20T19:38:34Z"
    },
    "type": "throttled"
  },
  "datacontenttype": "application/json",
  "project": "gigs",
  "source": "https://api.gigs.com",
  "specversion": "1.0",
  "time": "2022-03-16T14:12:42.0Z",
  "type": "com.gigs.usageNotification.created",
  "version": "2024-12-20"
}