com.gigs.subscriptionChange.created

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 subscriptionChange.
Name
id
Type
string
required
Description
Unique identifier for the subscription change.
Example: sch_0SNlurA049MEWV3bE0SMtbIEJApp
Name
failureCode
Type
nullable string
required
Description
An error code indicating the reason for a failed subscription change.
Name
plan
Type
nullable object
required
Description
The plan to which the subscription should be changed.
Name
sim
Type
nullable object
required
Description
The SIM to which the subscription should be changed.
Name
status
Type
string
required
Description
The current status of the subscription change.
Allowed values: pending, applied, failed
Name
subscription
Type
nullable string
required
Description
Unique identifier of the subscription to be changed.
Example: sub_0SNlurA049MEWV2gSfSxi00xlPIi
Name
appliedAt
Type
nullable string
required
Description
Time when the subscription change was applied.
Example: 2021-01-21T19:36:57Z
Name
createdAt
Type
string
required
Description
Time when the subscription change was created.
Example: 2021-01-21T19:12:28Z
Name
scheduledAt
Type
string
required
Description
Approximate time when the change should take place.
Example: 2021-01-21T19:12:28Z
Name
datacontenttype
Type
string
required
Description
The RFC 2046 content-type.
Example: application/json
Default: application/json
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.subscriptionChange.created.
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": "subscriptionChange",
    "id": "sch_0SNlurA049MEWV3bE0SMtbIEJApp",
    "plan": {
      "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"
    },
    "sim": {
      "object": "sim",
      "id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
      "iccid": "89883070000007537119",
      "provider": "p9",
      "status": "inactive",
      "type": "eSIM",
      "createdAt": "2021-01-21T19:38:34Z"
    },
    "status": "pending",
    "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
    "appliedAt": "2021-01-21T19:36:57Z",
    "createdAt": "2021-01-21T19:12:28Z",
    "scheduledAt": "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.subscriptionChange.created",
  "version": "2024-08-29"
}