- Name
object
- Type
- string
- Description
Type of object is always
event
.
required- Name
id
- Type
- string
- Description
Unique identifier for the event.
Example:evt_0SNlurA049MEWV5gNTcQ5A07h3Ol
required- Name
data
- Type
- object PREVIEW
- Description
- Name
object
- Type
- string
- Description
Type of object is always
addon
.
required- Name
id
- Type
- string
- Description
Unique identifier for the add-on.
Example:add_0SNlurA049MEWV4VxLfwJc7PJtHc
required- Name
allowances
- Type
- object
- Description
- The allowances included in the add-on.
required- Name
data
- Type
- integer DEPRECATED
- Description
The data allowance in bytes included in this add-on. A value of
-1
indicates unlimited data.Example:10000000000
required- Name
dataUnit
- Type
- string DEPRECATED
- Description
The unit of the data value is always
byte
.
required- Name
description
- Type
- nullable string
- Description
The description of the add-on.
Example:Disable international roaming.
required- Name
name
- Type
- string
- Description
Name for the add-on.
Example:1GB Data Top-up
required- Name
price
- Type
- object
- Description
- The price of the add-on.
required- Name
provider
- Type
- string
- Description
The ID of the network provider supported by this add-on.
Example:p5
required- Name
recurrenceType
- Type
- string
- Description
The recurrence type the add-on.
Example:oneTime
Allowed values:oneTime, recurring
required- Name
sms
- Type
- integer DEPRECATED
- Description
The sms allowance included in this add-on. A value of
-1
indicates unlimited sms.Example:100
required- Name
smsUnit
- Type
- string DEPRECATED
- Description
The unit of the sms value is always
sms
.
required- Name
status
- Type
- string
- Description
The current status of the add-on.
Allowed values:draft, available, archived
required- Name
type
- Type
- string
- Description
The type of the add-on.
Example:topUp
Allowed values:topUp, other
required- Name
validity
- Type
- nullable object
- Description
- The optional validity of the add-on. Add-ons without a set validity will inherit the validity of the subscribed plan.
required- Name
voice
- Type
- integer DEPRECATED
- Description
The voice call allowance in seconds included in this add-on. A value of
-1
indicates unlimited voice calls.Example:30000
required- Name
voiceUnit
- Type
- string DEPRECATED
- Description
The unit of the voice value is always
second
.
required- Name
createdAt
- Type
- string
- Description
Time when the add-on was created .
Example:2021-01-21T19:12:28Z
required
required- Name
datacontenttype
- Type
- string
- Description
The RFC 2046 content-type.
Example:application/json
Default:application/json
required- Name
project
- Type
- string
- Description
Unique identifier for the project where the event occurred.
Example:gigs
required- Name
source
- Type
- string
- Description
URI identifying the event source.
Example:https://api.gigs.com
Default:https://api.gigs.com
required- Name
specversion
- Type
- string
- Description
The CloudEvents spec version.
Example:1.0
Default:1.0
required- Name
time
- Type
- string
- Description
Time when the event occurred.
Example:2022-03-16T14:12:42Z
required- Name
type
- Type
- string
- Description
Type is always
com.gigs.addon.deleted
.
required- Name
version
- Type
- string
- Description
API version used to serialize the data and the event itself.
Default:2024-08-29
required
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.deleted",
"version": "2024-08-29"
}