com.gigs.plan.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
required
Description
Name
object
Type
string
required
Description
Type of object is always plan.
Name
id
Type
string
required
Description
Unique identifier for the plan.
Example: pln_0SNlurA049MEWV3V0q7gjQbM4EVo
Name
metadata
Type
object
PREVIEW
required
Description
A set of key-value pairs, to store metadata related to the resource.
Name
allowances
Type
object
required
Description
The allowances included in the plan.
Name
coverage
Type
object
required
Description
The geographic coverage of the plan.
Name
data
Type
integer
DEPRECATED
required
Description
The data allowance in bytes included in this plan. 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 plan's description, meant to be displayable to the users.
Example: A data plan you will love! Operates in most countries of the world.
Name
image
Type
nullable string
required
Description
The plan's image, meant to be displayable to the users.
Example: https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png
Name
limits
Type
object
required
Description
The limitations of the plan.
Name
name
Type
string
required
Description
The plan's name, meant to be displayable to the users.
Example: Gigs Global
Name
price
Type
object
required
Description
The price of the plan.
Name
provider
Type
string
required
Description
The ID of the network provider supported by this plan.
Example: p5
Name
requirements
Type
object
required
Description
Name
simTypes
Type
array
required
Description
List of SIM types supported by this plan. Can be eSIM, pSIM, or both.
Example: eSIM,pSIM
Name
sms
Type
integer
DEPRECATED
required
Description
The sms allowance included in this plan. A value of -1 indicates unlimited sms.
Example: 100
Name
smsUnit
Type
string
DEPRECATED
required
Description
The unit of the sms value is always message.
Name
status
Type
string
required
Description
Allowed values: available, archived, pending, draft
Name
validity
Type
object
required
Description
The validity of the plan.
Name
voice
Type
integer
DEPRECATED
required
Description
The voice allowance included in this plan. A value of -1 indicates unlimited voice.
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 plan was created.
Example: 2021-01-21T19:38:34Z
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.plan.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": "plan",
    "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
    "allowances": {
      "dataBytes": 10000000000,
      "voiceSeconds": 30000,
      "smsMessages": 100
    },
    "coverage": {
      "object": "coverage",
      "id": "de",
      "countries": [
        "DE",
        "FR",
        "US"
      ],
      "name": "Europe"
    },
    "data": 10000000000,
    "dataUnit": "byte",
    "description": "A data plan you will love! Operates in most countries of the world.",
    "image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
    "limits": {
      "dataBytes": 100000000000,
      "throttling": {
        "thresholdBytes": 10000000000,
        "bandwidthBitsPerSecond": 512000
      }
    },
    "name": "Gigs Global",
    "price": {
      "amount": 999,
      "currency": "USD"
    },
    "provider": "p5",
    "requirements": {
      "address": "present",
      "device": "none",
      "user.birthday": "none",
      "user.fullName": "present"
    },
    "simTypes": [
      "eSIM",
      "pSIM"
    ],
    "sms": 100,
    "smsUnit": "message",
    "status": "available",
    "validity": {
      "minimumPeriods": 12,
      "type": "recurring",
      "unit": "day",
      "value": 7
    },
    "voice": 30000,
    "voiceUnit": "second",
    "createdAt": "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.plan.updated",
  "version": "2024-08-29"
}