Add-ons

The Add-on resource

Properties

Name
object
Type
string
Description
Type of object is always addon.
Name
id
Type
string
Description
Unique identifier for the add-on.
Example: add_0SNlurA049MEWV4VxLfwJc7PJtHc
Name
allowances
Type
object
Description
The allowances included in the add-on.
Name
data
Type
integer
DEPRECATED
Description
The data allowance in bytes included in this add-on. A value of -1 indicates unlimited data.
Example: 10000000000
Name
dataUnit
Type
string
DEPRECATED
Description
The unit of the data value is always byte.
Name
description
Type
nullable string
Description
The description of the add-on.
Example: Disable international roaming.
Name
name
Type
string
Description
Name for the add-on.
Example: 1GB Data Top-up
Name
plans
Type
array
Description
The plans this add-on is compatible with.
Name
price
Type
object
Description
The price of the add-on.
Name
provider
Type
string
Description
The ID of the network provider supported by this add-on.
Example: p5
Name
recurrenceType
Type
string
Description
The recurrence type the add-on.
Example: oneTime
Allowed values: oneTime, recurring
Name
sms
Type
integer
DEPRECATED
Description
The sms allowance included in this add-on. A value of -1 indicates unlimited sms.
Example: 100
Name
smsUnit
Type
string
DEPRECATED
Description
The unit of the sms value is always sms.
Name
status
Type
string
Description
The current status of the add-on.
Allowed values: draft, available, archived
Name
type
Type
string
Description
The type of the add-on.
Example: topUp
Allowed values: topUp, other
Name
validity
Type
nullable object
Description
The optional validity of the add-on. Add-ons without a set validity will inherit the validity of the subscribed plan.
Name
voice
Type
integer
DEPRECATED
Description
The voice call allowance in seconds included in this add-on. A value of -1 indicates unlimited voice calls.
Example: 30000
Name
voiceUnit
Type
string
DEPRECATED
Description
The unit of the voice value is always second.
Name
createdAt
Type
string
Description
Time when the add-on was created .
Example: 2021-01-21T19:12:28Z

Response

{
  "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"
}

POST/projects/{project}/addons/{addon}/archive

Archive an add-on

Set the status of an add-on to archived. An archived add-on can not be added to subscriptions.

Path Parameters

Name
project
Type
string
required
Description
The unique identifier for the project.
Example: gigs
Name
addon
Type
string
required
Description
The unique identifier for the add-on.
Example: add_0SNlurA049MEWV4VxLfwJc7PJtHc

Response Schemas

Name
object
Type
string
required
Description
Type of object is always addon.
Name
id
Type
string
required
Description
Unique identifier for the add-on.
Example: add_0SNlurA049MEWV4VxLfwJc7PJtHc
Name
allowances
Type
object
required
Description
The allowances included in the add-on.
Name
data
Type
integer
DEPRECATED
required
Description
The data allowance in bytes included in this add-on. A value of -1 indicates unlimited data.
Example: 10000000000
Name
dataUnit
Type
string
DEPRECATED
required
Description
The unit of the data value is always byte.
Name
description
Type
nullable string
required
Description
The description of the add-on.
Example: Disable international roaming.
Name
name
Type
string
required
Description
Name for the add-on.
Example: 1GB Data Top-up
Name
plans
Type
array
required
Description
The plans this add-on is compatible with.
Name
price
Type
object
required
Description
The price of the add-on.
Name
provider
Type
string
required
Description
The ID of the network provider supported by this add-on.
Example: p5
Name
recurrenceType
Type
string
required
Description
The recurrence type the add-on.
Example: oneTime
Allowed values: oneTime, recurring
Name
sms
Type
integer
DEPRECATED
required
Description
The sms allowance included in this add-on. A value of -1 indicates unlimited sms.
Example: 100
Name
smsUnit
Type
string
DEPRECATED
required
Description
The unit of the sms value is always sms.
Name
status
Type
string
required
Description
The current status of the add-on.
Allowed values: draft, available, archived
Name
type
Type
string
required
Description
The type of the add-on.
Example: topUp
Allowed values: topUp, other
Name
validity
Type
nullable object
required
Description
The optional validity of the add-on. Add-ons without a set validity will inherit the validity of the subscribed plan.
Name
voice
Type
integer
DEPRECATED
required
Description
The voice call allowance in seconds included in this add-on. A value of -1 indicates unlimited voice calls.
Example: 30000
Name
voiceUnit
Type
string
DEPRECATED
required
Description
The unit of the voice value is always second.
Name
createdAt
Type
string
required
Description
Time when the add-on was created .
Example: 2021-01-21T19:12:28Z

Request

POST

/projects/{project}/addons/{addon}/archive

curl https://api.gigs.com/projects/{project}/addons/{addon}/archive \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer {token}" \
-H "Accept: application/json"

Response

{
  "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",
  "plans": [
    "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
  ],
  "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"
}

GET/projects/{project}/addons/{addon}

Retrieve an add-on

Retrieves the details of an existing add-on.

Path Parameters

Name
project
Type
string
required
Description
The unique identifier for the project.
Example: gigs
Name
addon
Type
string
required
Description
The unique identifier for the add-on.
Example: add_0SNlurA049MEWV4VxLfwJc7PJtHc

Response Schemas

Name
object
Type
string
required
Description
Type of object is always addon.
Name
id
Type
string
required
Description
Unique identifier for the add-on.
Example: add_0SNlurA049MEWV4VxLfwJc7PJtHc
Name
allowances
Type
object
required
Description
The allowances included in the add-on.
Name
data
Type
integer
DEPRECATED
required
Description
The data allowance in bytes included in this add-on. A value of -1 indicates unlimited data.
Example: 10000000000
Name
dataUnit
Type
string
DEPRECATED
required
Description
The unit of the data value is always byte.
Name
description
Type
nullable string
required
Description
The description of the add-on.
Example: Disable international roaming.
Name
name
Type
string
required
Description
Name for the add-on.
Example: 1GB Data Top-up
Name
plans
Type
array
required
Description
The plans this add-on is compatible with.
Name
price
Type
object
required
Description
The price of the add-on.
Name
provider
Type
string
required
Description
The ID of the network provider supported by this add-on.
Example: p5
Name
recurrenceType
Type
string
required
Description
The recurrence type the add-on.
Example: oneTime
Allowed values: oneTime, recurring
Name
sms
Type
integer
DEPRECATED
required
Description
The sms allowance included in this add-on. A value of -1 indicates unlimited sms.
Example: 100
Name
smsUnit
Type
string
DEPRECATED
required
Description
The unit of the sms value is always sms.
Name
status
Type
string
required
Description
The current status of the add-on.
Allowed values: draft, available, archived
Name
type
Type
string
required
Description
The type of the add-on.
Example: topUp
Allowed values: topUp, other
Name
validity
Type
nullable object
required
Description
The optional validity of the add-on. Add-ons without a set validity will inherit the validity of the subscribed plan.
Name
voice
Type
integer
DEPRECATED
required
Description
The voice call allowance in seconds included in this add-on. A value of -1 indicates unlimited voice calls.
Example: 30000
Name
voiceUnit
Type
string
DEPRECATED
required
Description
The unit of the voice value is always second.
Name
createdAt
Type
string
required
Description
Time when the add-on was created .
Example: 2021-01-21T19:12:28Z

Request

GET

/projects/{project}/addons/{addon}

curl https://api.gigs.com/projects/{project}/addons/{addon} \
-X GET \
-H "Content-type: application/json" \
-H "Authorization: Bearer {token}" \
-H "Accept: application/json"

Response

{
  "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",
  "plans": [
    "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
  ],
  "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"
}

PATCH/projects/{project}/addons/{addon}

Update an add-on

Updates an add-on's name and description.

Body

Name
name
Type
nullable string
Description
The name of the add-on, meant to be displayable to users.
Example: 1GB Data Top-up
Name
description
Type
nullable string
Description
The description of the add-on.
Example: Disable international roaming.

Path Parameters

Name
project
Type
string
required
Description
The unique identifier for the project.
Example: gigs
Name
addon
Type
string
required
Description
The unique identifier for the add-on.
Example: add_0SNlurA049MEWV4VxLfwJc7PJtHc

Response Schemas

Name
object
Type
string
required
Description
Type of object is always addon.
Name
id
Type
string
required
Description
Unique identifier for the add-on.
Example: add_0SNlurA049MEWV4VxLfwJc7PJtHc
Name
allowances
Type
object
required
Description
The allowances included in the add-on.
Name
data
Type
integer
DEPRECATED
required
Description
The data allowance in bytes included in this add-on. A value of -1 indicates unlimited data.
Example: 10000000000
Name
dataUnit
Type
string
DEPRECATED
required
Description
The unit of the data value is always byte.
Name
description
Type
nullable string
required
Description
The description of the add-on.
Example: Disable international roaming.
Name
name
Type
string
required
Description
Name for the add-on.
Example: 1GB Data Top-up
Name
plans
Type
array
required
Description
The plans this add-on is compatible with.
Name
price
Type
object
required
Description
The price of the add-on.
Name
provider
Type
string
required
Description
The ID of the network provider supported by this add-on.
Example: p5
Name
recurrenceType
Type
string
required
Description
The recurrence type the add-on.
Example: oneTime
Allowed values: oneTime, recurring
Name
sms
Type
integer
DEPRECATED
required
Description
The sms allowance included in this add-on. A value of -1 indicates unlimited sms.
Example: 100
Name
smsUnit
Type
string
DEPRECATED
required
Description
The unit of the sms value is always sms.
Name
status
Type
string
required
Description
The current status of the add-on.
Allowed values: draft, available, archived
Name
type
Type
string
required
Description
The type of the add-on.
Example: topUp
Allowed values: topUp, other
Name
validity
Type
nullable object
required
Description
The optional validity of the add-on. Add-ons without a set validity will inherit the validity of the subscribed plan.
Name
voice
Type
integer
DEPRECATED
required
Description
The voice call allowance in seconds included in this add-on. A value of -1 indicates unlimited voice calls.
Example: 30000
Name
voiceUnit
Type
string
DEPRECATED
required
Description
The unit of the voice value is always second.
Name
createdAt
Type
string
required
Description
Time when the add-on was created .
Example: 2021-01-21T19:12:28Z

Request

PATCH

/projects/{project}/addons/{addon}

curl https://api.gigs.com/projects/{project}/addons/{addon} \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer {token}" \
-H "Accept: application/json" \
-d "{\"name\":\"1GB Data Top-up\",\"description\":\"Disable international roaming.\"}"

Response

{
  "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",
  "plans": [
    "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
  ],
  "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"
}

POST/projects/{project}/addons/{addon}/publish

Publish an add-on

Set the status of an add-on to available. Available add-ons can be added to subscriptions.

Path Parameters

Name
project
Type
string
required
Description
The unique identifier for the project.
Example: gigs
Name
addon
Type
string
required
Description
The unique identifier for the add-on.
Example: add_0SNlurA049MEWV4VxLfwJc7PJtHc

Response Schemas

Name
object
Type
string
required
Description
Type of object is always addon.
Name
id
Type
string
required
Description
Unique identifier for the add-on.
Example: add_0SNlurA049MEWV4VxLfwJc7PJtHc
Name
allowances
Type
object
required
Description
The allowances included in the add-on.
Name
data
Type
integer
DEPRECATED
required
Description
The data allowance in bytes included in this add-on. A value of -1 indicates unlimited data.
Example: 10000000000
Name
dataUnit
Type
string
DEPRECATED
required
Description
The unit of the data value is always byte.
Name
description
Type
nullable string
required
Description
The description of the add-on.
Example: Disable international roaming.
Name
name
Type
string
required
Description
Name for the add-on.
Example: 1GB Data Top-up
Name
plans
Type
array
required
Description
The plans this add-on is compatible with.
Name
price
Type
object
required
Description
The price of the add-on.
Name
provider
Type
string
required
Description
The ID of the network provider supported by this add-on.
Example: p5
Name
recurrenceType
Type
string
required
Description
The recurrence type the add-on.
Example: oneTime
Allowed values: oneTime, recurring
Name
sms
Type
integer
DEPRECATED
required
Description
The sms allowance included in this add-on. A value of -1 indicates unlimited sms.
Example: 100
Name
smsUnit
Type
string
DEPRECATED
required
Description
The unit of the sms value is always sms.
Name
status
Type
string
required
Description
The current status of the add-on.
Allowed values: draft, available, archived
Name
type
Type
string
required
Description
The type of the add-on.
Example: topUp
Allowed values: topUp, other
Name
validity
Type
nullable object
required
Description
The optional validity of the add-on. Add-ons without a set validity will inherit the validity of the subscribed plan.
Name
voice
Type
integer
DEPRECATED
required
Description
The voice call allowance in seconds included in this add-on. A value of -1 indicates unlimited voice calls.
Example: 30000
Name
voiceUnit
Type
string
DEPRECATED
required
Description
The unit of the voice value is always second.
Name
createdAt
Type
string
required
Description
Time when the add-on was created .
Example: 2021-01-21T19:12:28Z

Request

POST

/projects/{project}/addons/{addon}/publish

curl https://api.gigs.com/projects/{project}/addons/{addon}/publish \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer {token}" \
-H "Accept: application/json"

Response

{
  "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",
  "plans": [
    "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
  ],
  "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"
}

GET/projects/{project}/addons

List all add-ons

List add-ons. By default only add-ons with a status of 'available' are returned.

Path Parameters

Name
project
Type
string
required
Description
The unique identifier for the project.
Example: gigs

Query Parameters

Name
after
Type
string
Description
A cursor for use in pagination. The after parameter takes an object ID that defines the position in the list, only items immediately following the item with that ID will be returned.
Name
before
Type
string
Description
A cursor for use in pagination. The before parameter takes an object ID that defines the position in the list, only items immediately preceding the item with that ID will be returned.
Name
limit
Type
integer
Description
The limit of items to be returned in the list, between 0 and 200.
Default: 10
>= 0
<= 200
Name
provider
Type
string
Description
The provider of the add-on to be filtered by.
Example: p4
Name
plan
Type
string
Description
Limit the list of add-ons to those compatible with the given plan id.
Example: pln_0SNlurA049MEWV3V0q7gjQbM4EVo
Name
status
Type
string
Description
The status of the add-on to be filtered by.
Example: available
Name
type
Type
string
Description
The type of the add-on to be filtered by.
Example: topUp
Name
recurrenceType
Type
string
Description
The recurrence type of the add-on to be filtered by.
Example: oneTime

Response Schemas

Name
object
Type
string
required
Description
Type of object is always list.
Name
items
Type
array
required
Description
List of objects of type `addon`.
Name
moreItemsAfter
Type
nullable string
required
Description
A unique identifier to be used as after pagination parameter if more items are available sorted after the current batch of items.
Name
moreItemsBefore
Type
nullable string
required
Description
A unique identifier to be used as before pagination parameter if more items are available sorted before the current batch of items.

Request

GET

/projects/{project}/addons

curl https://api.gigs.com/projects/{project}/addons \
-X GET \
-H "Content-type: application/json" \
-H "Authorization: Bearer {token}" \
-H "Accept: application/json"

Response

{
  "object": "list",
  "items": [
    {
      "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",
      "plans": [
        "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
      ],
      "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"
    }
  ],
  "moreItemsAfter": null,
  "moreItemsBefore": null
}