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
metadata
Type
Metadata
Description
A set of key-value pairs, to store metadata related to the resource.
Name
allowances
Type
object
Description
Usage allowances included in the plan - i.e. how many bytes of data, voice minutes & sms messages the user has access to.
Name
dataBytes
Type
nullable integer
Description
The data allowance in bytes. A value of null indicates unlimited data.
Example: 10000000000
Name
voiceSeconds
Type
nullable integer
Description
The voice call allowance in seconds. A value of null indicates unlimited calls.
Example: 30000
Name
smsMessages
Type
nullable integer
Description
The SMS allowance in messages. A value of null indicates unlimited SMS.
Example: 100
Name
coverage
Type
object
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
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
object
Description
Usage limits for the plan - i.e. the maximum available bandwidth, fair-use data limits and throttling threshold.
Name
dataBytes
Type
nullable integer
Description
The maximum amount of data that can be used in bytes. A value of null indicates unlimited data.
Example: 100000000000
Name
bandwidthBitsPerSecond
Type
nullable integer
Description
The maximum bandwidth in bits per second. A value of null indicates unlimited bandwidth.
Name
throttling
Type
nullable object
Description
The throttling configuration for the plan, if any.
Name
name
Type
string
Description
The plan's name, meant to be displayable to the users.
Example: "Gigs Global"
Name
price
Type
object
Description
The price of the plan.
Name
amount
Type
integer
Description
The price amount in the currency's minor unit, e.g. "cents" for many currencies.
Example: 999
>= 0
Name
currency
Type
string
Description
Three-letter ISO 4217 currency code. Must be a supported currency.
Example: "USD"
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: available archived pending draft
Name
validity
Type
object
Description
Plan validity information - i.e. subscription period length, and the minimum number of periods before the plan can be ended.

Example

{
  "object": "plan",
  "id": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
  "metadata": {},
  "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.",
  "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"
}