Skip to main content
GET
/
plans
List data plans
curl --request GET \
  --url https://dashboard.hologram.io/api/1/plans \
  --header 'Authorization: Basic <encoded-value>'
{
  "success": true,
  "limit": 2,
  "size": 2,
  "continues": true,
  "links": {
    "path": "/api/1/plans",
    "base": "staging.teamhologram.ninja",
    "next": "/api/1/plans?limit=2&startafter=1678"
  },
  "lastid": 1133,
  "data": [
    {
      "id": 2096,
      "partnerid": 1,
      "name": "Global G3 Standard Flat Rate",
      "description": "G3 Standard Global flat-rate PayGo",
      "data": 0,
      "recurring": 1,
      "enabled": 1,
      "billingperiod": 1,
      "groupid": 1199,
      "developerplan": 0,
      "display_category": "standard",
      "cellular_coverage_region_id": 6,
      "use_variable_rates": false,
      "is_dynamic_pool": false,
      "tiers": {
        "BASE": {
          "devicecount": 0,
          "zones": {
            "global": {
              "amount": "1.000000",
              "sms": "0.190000",
              "overage": "0.030000",
              "carriers": {
                "13": {
                  "apn": "hologram"
                }
              }
            }
          }
        }
      },
      "cellular_coverage_region": {
        "id": 6,
        "display_name": "Global – G3 SIMs",
        "description": "Lowest-cost global coverage for G3 standalone SIMs"
      },
      "zones": {
        "Global": {
          "amount": "1.000000",
          "sms": "0.190000",
          "overage": "0.030000",
          "carriers": {
            "13": {
              "apn": "hologram"
            }
          }
        }
      },
      "amountGlobal": "1.000000",
      "smsGlobal": "0.190000",
      "overageGlobal": "0.030000"
    },
    {
      "id": 1678,
      "partnerid": 1,
      "name": "Global All Standard Flat Rate",
      "description": "Global All Standard Flat Rate",
      "data": 0,
      "recurring": 1,
      "enabled": 1,
      "billingperiod": 1,
      "groupid": 776,
      "developerplan": 0,
      "display_category": "standard",
      "cellular_coverage_region_id": 4,
      "use_variable_rates": false,
      "is_dynamic_pool": false,
      "tiers": {
        "BASE": {
          "devicecount": 0,
          "zones": {
            "Global": {
              "amount": "1.000000",
              "sms": "0.190000",
              "overage": "0.210000",
              "carriers": {
                "2": {
                  "apn": "hologram"
                },
                "8": {
                  "apn": "hologram"
                },
                "11": {
                  "apn": "hologram"
                },
                "12": {
                  "apn": "hologram"
                },
                "13": {
                  "apn": "hologram"
                }
              }
            }
          }
        }
      },
      "cellular_coverage_region": {
        "id": 4,
        "display_name": "Global",
        "description": "Connect to our network of carriers in 180+ countries"
      },
      "current_tier": "BASE",
      "zones": {
        "Global": {
          "amount": "1.000000",
          "sms": "0.190000",
          "overage": "0.210000",
          "carriers": {
            "2": {
              "apn": "hologram"
            },
            "8": {
              "apn": "hologram"
            },
            "11": {
              "apn": "hologram"
            },
            "12": {
              "apn": "hologram"
            },
            "13": {
              "apn": "hologram"
            }
          }
        }
      },
      "amountGlobal": "1.000000",
      "smsGlobal": "0.190000",
      "overageGlobal": "0.210000"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.hologram.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

HTTP Basic authentication using API keys. Set the username to apikey and the password to your API key.

You can find your API key on the Hologram Dashboard under Account Settings.

Query Parameters

​
orgid
integer
Example:

144

​
limit
integer

Maximum number of items to return in a single request. For endpoints that support pagination, use this with corresponding /pages endpoints to manage large result sets.

Example:

50

​
id
integer
​
ids
string

Comma-separated list of IDs to filter by.

Example:

"101,102,103"

​
startafter
integer
Example:

102544

Response

200 - application/json

OK

​
continues
boolean

Displays if there is another page of results.

Example:

true

​
data
object[]
​
limit
integer

The max number of items to return in a single response

Example:

10

​
links
object

Pagination navigation links for fetching additional pages of results

​
size
integer

The number of values returned

Example:

216

​
success
boolean

Whether the request was successful or not

Example:

true