- 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
- Description
- Name
object
- Type
- string
- Description
Type of object is always
subscription
.
required- Name
id
- Type
- string
- Description
Unique identifier for the subscription.
Example:sub_0SNlurA049MEWV2gSfSxi00xlPIi
required- Name
metadata
- Type
- object PREVIEW
- Description
- A set of key-value pairs, to store metadata related to the resource.
required- Name
cancellationDetails
- Type
- nullable object
- Description
- Details about the cancellation of the subscription.
required- Name
currentPeriod
- Type
- nullable object
- Description
- Current subscription period. Only present for active subscriptions.
required- Name
phoneNumber
- Type
- nullable string
- Description
The phone number attached to the SIM in E.164 format. Only available for voice plans.
Example:+19591234567
required- Name
plan
- Type
- object
- Description
required- Name
porting
- Type
- nullable object
- Description
- Current porting (if any) related with the subscription.
required- Name
sim
- Type
- nullable object
- Description
required- Name
status
- Type
- string
- Description
The current status of the subscription. Note that the
initiated
status is currently only available when using the Billing API, where it implies that the subscription's first invoice has not yet been paid.Allowed values:pending, initiated, active, ended
required- Name
user
- Type
- object
- Description
required- Name
activatedAt
- Type
- nullable string
- Description
Time when the subscription was activated.
Example:2021-01-21T19:38:34Z
required- Name
canceledAt
- Type
- nullable string
- Description
Time when the subscription was canceled.
Example:2021-01-29T13:22:51Z
required- Name
createdAt
- Type
- string
- Description
Time when the subscription was created.
Example:2021-01-21T19:32:13Z
required- Name
earliestEndAt
- Type
- nullable string PREVIEW
- Description
Earliest time at which the subscription can currently be ended. It depends on the minimum period of the plan. Only present if the subscription has not yet been ended.
Example:2021-02-20T19:38:34Z
required- Name
endedAt
- Type
- nullable string
- Description
Time when the subscription was ended.
Example:2021-02-20T19:38:34Z
required- Name
firstUsageAt
- Type
- nullable string
- Description
Time when the subscription was first used.
Example:2021-01-21T19:38:34Z
required
required- Name
datacontenttype
- Type
- string
- Description
The RFC 2046 content-type.
Example:application/json
Default:application/json
required- 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
- 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.subscription.updated
.
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": "subscription",
"id": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
"cancellationDetails": {
"cause": "cancellationRequested",
"userReason": "connectivityIssues"
},
"currentPeriod": {
"number": 1,
"start": "2021-01-21T19:32:13Z",
"end": "2021-02-20T19:38:34Z"
},
"phoneNumber": "+19591234567",
"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"
},
"porting": {
"object": "porting",
"id": "prt_0SNlurA049MEWV39s2kSYqaat7ZS",
"accountNumber": "123456789",
"accountPinExists": true,
"address": {
"city": "New York City",
"country": "US",
"line1": "129 West 81st Street",
"line2": "Apartment 5A",
"postalCode": "10024",
"state": "NY"
},
"birthday": "2017-07-21",
"declinedCode": "portingPhoneNumberPortProtected",
"declinedMessage": "The phone number has port protection on the provider.",
"donorProvider": {
"object": "serviceProvider",
"id": "svp_0SNlurA01K6GY5L0XJffY8",
"name": "AT&T",
"recipientProviders": [
"p3"
]
},
"donorProviderApproval": true,
"firstName": "Jerry",
"lastName": "Seinfeld",
"phoneNumber": "+19591234567",
"provider": "p9",
"recipientProvider": {
"object": "serviceProvider",
"id": "svp_0SNlurA01K6GY5L0XJffY8",
"name": "AT&T",
"recipientProviders": [
"p3"
]
},
"required": [
"accountNumber",
"accountPin",
"address",
"birthday",
"donorProvider",
"donorProviderApproval",
"firstName",
"lastName"
],
"status": "draft",
"subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
"user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
"canceledAt": "2021-01-21T19:39:53Z",
"completedAt": "2021-01-21T19:36:57Z",
"createdAt": "2021-01-21T19:12:28Z",
"expiredAt": "2021-01-21T19:39:53Z",
"lastDeclinedAt": "2021-01-21T19:31:13Z",
"lastRequestedAt": "2021-01-21T19:22:31Z"
},
"sim": {
"object": "sim",
"id": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
"iccid": "89883070000007537119",
"provider": "p9",
"status": "inactive",
"type": "eSIM",
"createdAt": "2021-01-21T19:38:34Z"
},
"status": "pending",
"user": {
"object": "user",
"id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
"birthday": "2017-07-21",
"email": "jerry@example.com",
"emailVerified": true,
"fullName": "Jerry Seinfeld",
"preferredLocale": "en-US",
"createdAt": "2021-01-21T19:38:34Z"
},
"activatedAt": "2021-01-21T19:38:34Z",
"canceledAt": "2021-01-29T13:22:51Z",
"createdAt": "2021-01-21T19:32:13Z",
"earliestEndAt": "2021-02-20T19:38:34Z",
"endedAt": "2021-02-20T19:38:34Z",
"firstUsageAt": "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.subscription.updated",
"version": "2024-08-29"
}