Plans

List Plans (Combined Filters)

All plan filters can be combined. This example returns multi-country European plans with IR1 sponsor profile.

Get Single Plan

Returns detailed information about a specific plan. Only returns enabled plans that are accessible to your organization.

Same fields as the list response. Global plans that have an org-specific copy (same provider_plan_id) are hidden.

Path Parameter:

Response:

Code
 
{
  "success": true,
  "data": {
    "id": 1,
    "name": "Europe 1GB - 7 Days",
    "retail_price": "4.50",
    "currency": "EUR",
    "data_gb": 1.0,
    "validity_days": 7,
    "sponsor_profile": "IR1",
    "coverage_type": "regional",
    "regions": [
      {"code": "EU", "name": "Europe & UK"}
    ],
    "coverage": {
      "countries": ["HR", "DE", "FR", "IT", "ES"],
      "total_countries": 32,
      "total_operators": 85
    }
  }
}

Errors:

• 404 NOT_FOUND – Plan not found (or disabled/excluded for your org)

Get Plan Coverage

Returns the full detailed coverage for a specific plan — all countries and their operators with network types.

Use this for displaying a detailed coverage map. For a quick summary, use the coverage field in GET /v1/plans or GET /v1/plans/{id}.

Path Parameter:

Response:

Code
 
{
  "success": true,
  "data": {
    "plan_id": 1,
    "plan_name": "Europe 1GB - 7 Days",
    "countries": [
      {
        "country_id": 48,
        "iso2": "HR",
        "iso3": "HRV",
        "name": "Croatia",
        "operators": [
          {
            "operator_name": "A1 HR",
            "sponsor_name": "A1 Telekom Austria",
            "tadig": "HRVVIP",
            "network_types": "2G, 3G, 4G"
          },
          {
            "operator_name": "T-Mobile HR",
            "sponsor_name": "Deutsche Telekom",
            "tadig": "HRVTMO",
            "network_types": "2G, 3G, 4G, 5G"
          }
        ]
      },
      {
        "country_id": 53,
        "iso2": "DE",
        "iso3": "DEU",
        "name": "Germany",
        "operators": ["..."]
      }
    ],
    "total_countries": 32,
    "total_operators": 85
  }
}

Errors:

• 404 NOT_FOUND – Plan not found (or disabled/excluded for your org)

Get Coverage Regions

Returns all available coverage regions with their codes and display labels. Use region codes to filter plans via GET /v1/plans?region=EU.

Response:

Code
 
{
  "success": true,
  "data": [
    {"code": "EU", "name": "Europe & UK"},
    {"code": "AF", "name": "Africa"},
    {"code": "AS", "name": "Asia"},
    {"code": "LA", "name": "Latin America"},
    {"code": "NA", "name": "North America"},
    {"code": "OC", "name": "Oceania"}
  ]
}

Notes:

• Region codes are: EU, AF, AS, LA, NA, OC
• Each region contains a predefined set of ISO 3166-1 alpha-2 country codes
• A plan matches a region if at least one of its coverage countries belongs to that region