com.gigs.subscriptionAddon.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
PREVIEW
required
Description
Name
object
Type
string
required
Description
Type of object is always subscriptionAddon.
Name
id
Type
string
required
Description
Unique identifier for the subscription add-on.
Example: sad_0SNlurA049MEWV2UNWPbDfW5B40U
Name
addon
Type
object
PREVIEW
required
Description
Name
currentPeriod
Type
nullable object
required
Description
Current subscription add-on period. Only present for active subscription add-ons.
Name
status
Type
string
required
Description
The current status of the subscription add-on.
Allowed values: pending, active, ended
Name
subscription
Type
string
required
Description
Unique identifier of the subscription the add-on applies to.
Example: sub_0SNlurA049MEWV2gSfSxi00xlPIi
Name
user
Type
string
required
Description
Unique identifier of the user the subscription add-on belongs to.
Example: usr_0SNlurA049MEWV4OpCwsNyC9Kn2d
Name
activatedAt
Type
nullable string
required
Description
Time when the subscription add-on was activated.
Example: 2021-01-15T12:36:57Z
Name
canceledAt
Type
nullable string
required
Description
Time when the subscription add-on was canceled.
Example: 2021-01-22T19:39:53Z
Name
createdAt
Type
string
required
Description
Time when the subscription add-on was created.
Example: 2021-01-15T12:30:28Z
Name
endedAt
Type
string
required
Description
Time when the subscription add-on was ended.
Example: 2021-01-30T23: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.subscriptionAddon.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": "subscriptionAddon",
    "id": "sad_0SNlurA049MEWV2UNWPbDfW5B40U",
    "addon": {
      "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"
    },
    "currentPeriod": {
      "number": 1,
      "start": "2021-01-21T19:32:13Z",
      "end": "2021-02-20T19:38:34Z"
    },
    "status": "pending",
    "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
    "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
    "activatedAt": "2021-01-15T12:36:57Z",
    "canceledAt": "2021-01-22T19:39:53Z",
    "createdAt": "2021-01-15T12:30:28Z",
    "endedAt": "2021-01-30T23:12:28Z"
  },
  "datacontenttype": "application/json",
  "project": "gigs",
  "source": "https://api.gigs.com",
  "specversion": "1.0",
  "time": "2022-03-16T14:12:42Z",
  "type": "com.gigs.subscriptionAddon.created",
  "version": "2024-08-29"
}