com.gigs.usageBalance.thresholdReached

Fires when a usage balance reaches a configured threshold.

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
actor
Type
Actor
Description
Example: {"type":"user","user":"usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"},{"type":"apiKey","apiKey":"apk_0SNlurA049MEWV4wRq2ql6SYZxiY"},{"type":"member","member":"mbr_0SNlurA020zhzt0CwsIr53"},{"type":"system"}
Name
data
Type
UsageBalance
Description
A usage balance represent the amount of usage consumed from an Allowance for a given Subscription in a certain Period.
Example: {"object":"usageBalance","id":"ubl_0V9n0zo90CE0NuvcsN0j88","allowance":{"object":"allowance","name":"Long distance calls while roaming in Germany","type":"data","coverage":{"object":"coverage","id":"de","countries":["DE","FR","US"],"name":"Europe"},"limit":500,"unit":"bytes"},"subscription":"sub_0SNlurA049MEWV2gSfSxi00xlPIi","source":{"type":"subscriptionPeriod","subscriptionPeriod":4,"subscriptionAddon":null},"unit":"bytes","used":230,"limit":500,"remaining":270,"usedPercent":46,"remainingPercent":54,"usableFrom":"2026-01-03T13:41:24Z","usableUntil":"2026-02-03T13:41:24Z"}
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.usageBalance.thresholdReached.
Allowed values: com.gigs.usageBalance.thresholdReached
Name
version
Type
string
Description
API version used to serialize the data and the event itself.
Default: 2026-01-29

Example

{
  "object": "event",
  "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
  "actor": {
    "type": "user",
    "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
  },
  "data": {
    "object": "usageBalance",
    "id": "ubl_0V9n0zo90CE0NuvcsN0j88",
    "allowance": {
      "object": "allowance",
      "name": "Long distance calls while roaming in Germany",
      "type": "data",
      "coverage": {
        "object": "coverage",
        "id": "de",
        "countries": [
          "DE",
          "FR",
          "US"
        ],
        "name": "Europe"
      },
      "limit": 500,
      "unit": "bytes"
    },
    "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
    "source": {
      "type": "subscriptionPeriod",
      "subscriptionPeriod": 4,
      "subscriptionAddon": null
    },
    "unit": "bytes",
    "used": 230,
    "limit": 500,
    "remaining": 270,
    "usedPercent": 46,
    "remainingPercent": 54,
    "usableFrom": "2026-01-03T13:41:24Z",
    "usableUntil": "2026-02-03T13:41:24Z"
  },
  "datacontenttype": "application/json",
  "project": "gigs",
  "source": "https://api.gigs.com",
  "specversion": "1.0",
  "time": "2022-03-16T14:12:42.0Z",
  "type": "com.gigs.usageBalance.thresholdReached",
  "version": "2026-01-29"
}