com.gigs.addon.updated

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 addon.
Name
id
Type
string
required
Description
Unique identifier for the add-on.
Example: add_0SNlurA049MEWV4VxLfwJc7PJtHc
Name
allowances
Type
object
required
Description
The allowances included in the add-on.
Name
data
Type
integer
DEPRECATED
required
Description
The data allowance in bytes included in this add-on. A value of -1 indicates unlimited data.
Example: 10000000000
Name
dataUnit
Type
string
DEPRECATED
required
Description
The unit of the data value is always byte.
Name
description
Type
nullable string
required
Description
The description of the add-on.
Example: Disable international roaming.
Name
name
Type
string
required
Description
Name for the add-on.
Example: 1GB Data Top-up
Name
price
Type
object
required
Description
The price of the add-on.
Name
provider
Type
string
required
Description
The ID of the network provider supported by this add-on.
Example: p5
Name
recurrenceType
Type
string
required
Description
The recurrence type the add-on.
Example: oneTime
Allowed values: oneTime, recurring
Name
sms
Type
integer
DEPRECATED
required
Description
The sms allowance included in this add-on. A value of -1 indicates unlimited sms.
Example: 100
Name
smsUnit
Type
string
DEPRECATED
required
Description
The unit of the sms value is always sms.
Name
status
Type
string
required
Description
The current status of the add-on.
Allowed values: draft, available, archived
Name
type
Type
string
required
Description
The type of the add-on.
Example: topUp
Allowed values: topUp, other
Name
validity
Type
nullable object
required
Description
The optional validity of the add-on. Add-ons without a set validity will inherit the validity of the subscribed plan.
Name
voice
Type
integer
DEPRECATED
required
Description
The voice call allowance in seconds included in this add-on. A value of -1 indicates unlimited voice calls.
Example: 30000
Name
voiceUnit
Type
string
DEPRECATED
required
Description
The unit of the voice value is always second.
Name
createdAt
Type
string
required
Description
Time when the add-on was created .
Example: 2021-01-21T19:12:28Z
Name
datacontenttype
Type
string
required
Description
The RFC 2046 content-type.
Example: application/json
Default: application/json
Name
previousData
Type
object
Description
Present only for events of type `*.updated`. Contains the values fields in the schema had prior to the update. This field is the result of a shallow diff of the previous schema (i.e., if a nested field has changed, then the entire object will be included).
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.addon.updated.
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": "addon",
    "id": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
    "allowances": {
      "dataBytes": 10000000000,
      "voiceSeconds": 30000,
      "smsMessages": 100
    },
    "data": 10000000000,
    "dataUnit": "byte",
    "description": "Disable international roaming.",
    "name": "1GB Data Top-up",
    "price": {
      "amount": 999,
      "currency": "USD"
    },
    "provider": "p5",
    "recurrenceType": "oneTime",
    "sms": 100,
    "smsUnit": "message",
    "status": "draft",
    "type": "topUp",
    "validity": {
      "unit": "day",
      "value": 7
    },
    "voice": 30000,
    "voiceUnit": "second",
    "createdAt": "2021-01-21T19:12:28Z"
  },
  "datacontenttype": "application/json",
  "project": "gigs",
  "source": "https://api.gigs.com",
  "specversion": "1.0",
  "time": "2022-03-16T14:12:42Z",
  "type": "com.gigs.addon.updated",
  "version": "2024-08-29"
}