Plan
Plans define the network options and parameters offered to the end user, e.g. 'Unlimited data, voice & text'. Plan allowances (data, sms, voice) and limits are configurable, and Gigs will work with you to find the best balance for your users.
- Name
- object
- Type
- string
- Description
Type of object is always
plan.Allowed values:plan
- Name
- id
- Type
- string
- Description
Unique identifier for the plan.
Example:"pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
- Name
- activationTrigger
- Type
- string
- Description
Indicates when a subscription will activate.
creation: As soon as it is created. The user does not need to take any further action.usageStarted: When the user starts using subscription allowance on their device.
Example:"creation"Allowed values:creationusageStarted
- Name
- allowances
- Type
- Allowances
- Description
- Usage allowances included in the plan - i.e. how many bytes of data, voice minutes & sms messages the user has access to.
- Name
- coverage
- Type
- Coverage
- Description
- The geographic coverage of the plan.
- Name
- createdAt
- Type
- string
- Description
Time when the plan was created.
Example:"2021-01-21T19:38:34Z"
- Name
- description
- Type
- nullable string
- 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
- firstPeriodTrigger
- Type
- string
- Status
- PREVIEW
- Description
Indicates when a subscription's first period will start.
creation: As soon as the subscription is created.activation: When the subscription's status transitions frompendingtoactive.
Example:"creation"Allowed values:activationcreation
- Name
- image
- Type
- nullable string
- Description
The plan's image, meant to be displayable to the users.
Example:"https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png"
- Name
- limits
- Type
- Limits
- Description
- Usage limits for the plan - i.e. the maximum available bandwidth, fair-use data limits and throttling threshold.
- Name
- name
- Type
- string
- Description
The plan's name, meant to be displayable to the users.
Example:"Gigs Global"
- Name
- price
- Type
- Price
- Description
- The price of the plan.
- Name
- provider
- Type
- string
- Description
The ID of the network provider supported by this plan.
Example:"p5"
- Name
- requirements
- Type
- object
- Description
- Required information that must be collected from the user in order to create a subscription with this plan.
- Name
- simTypes
- Type
- array
- Description
List of SIM types supported by this plan. Can be
eSIM,pSIM, or both.Example:["eSIM","pSIM"]
- Name
- status
- Type
- string
- Description
- Allowed values:
availablearchivedpendingdraft
- Name
- validity
- Type
- Validity
- Description
- Plan validity information - i.e. subscription period length, and the minimum number of periods before the plan can be ended.
Plan object
{
"object": "plan",
"id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
"metadata": {},
"activationTrigger": "creation",
"allowances": {
"dataBytes": 10000000000,
"voiceSeconds": 30000,
"smsMessages": 100
},
"coverage": {
"object": "coverage",
"id": "de",
"countries": [
"DE",
"FR",
"US"
],
"name": "Europe"
},
"createdAt": "2021-01-21T19:38:34.0Z",
"description": "A data plan you will love! Operates in most countries of the world.",
"firstPeriodTrigger": "creation",
"image": "https://i.gigscdn.com/pr/nTZpgaEj5dTQ2Jo/original.png",
"limits": {
"dataBytes": 100000000000,
"bandwidthBitsPerSecond": 100000000,
"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"
],
"status": "available",
"validity": {
"minimumPeriods": 12,
"type": "recurring",
"unit": "day",
"value": 7
},
"data": 10000000000,
"dataUnit": "byte",
"sms": 100,
"smsUnit": "message",
"voice": 30000,
"voiceUnit": "second"
}