Skip to Content
🚀 Trusted by travel businesses worldwide - Roamify eSIM API
eSIMs ModulePackages

eSIM API - Package(s)

Table of Contents

Ways to get eSIM packages

To get a list of eSIM packages, you need to send a GET request to the /api/esim/packages endpoint.

⚠️

Watch out property “withUsageCheck”, if it is set to false, usage check won’t be supported, find instructions in the notes property

The request body should contain the following parameters:

  • country: The country code of the eSIM packages. This is an optional field of type string. If you do not provide a country code, the API will return a list of all available eSIM packages. It follows the ISO 3166-1 alpha-2  format.
  • geography: The geography of the eSIM packages. This is an optional field of type string. It can be any of the following values:
    • local: Local packages
    • regional: Regional packages
    • global: Global packages

Usage examples

Here is an example of how you can get a list of eSIM packages using Roamify eSIM API.

Example Request 1: Get all eSIM packages

curl --request GET \
--url 'https://api-dev.getroamify.com/api/esim/packages' \
--header 'Authorization: Bearer Access Token' \
--header 'Content-Type: application/json'


Example Request 2: Get eSIM packages for a specific country

curl --request GET \
--url 'https://api-dev.getroamify.com/api/esim/packages?country=US' \
--header 'Authorization: Bearer Access Token' \
--header 'Content-Type: application/json'

Example Request 3: Get eSIM packages for a specific geography

curl --request GET \
--url 'https://api-dev.getroamify.com/api/esim/packages?geography=global' \
--header 'Authorization: Bearer Access Token' \
--header 'Content-Type: application/json'

Sample Response

{
	"status": "success",
	"data": {
		"packages": [
			{
				"id": "afghanistan-esims",
				"countryName": "Afghanistan",
				"countryCode": "AF",
				"countrySlug": "afghanistan",
				"region": "Asia",
				"geography": "local",
				"minPrice": 5,
				"maxPrice": 5,
				"image": "https://imagedelivery.net/uUE6LNs_ci8SFBH4_n66dQ/countries/flags/afghanistan/public",
				"signals": [
					{
						"code": "AF",
						"name": "Afghanistan",
						"networks": [
							"3G",
							"4G"
						],
						"carriers": [
							"MTN"
						]
					}
				],
				"packages": [
					{
						"packageId": "esim-afghanistan-7days-1gb-all",
						"package": "1 GB - 7 Days",
						"plan": "data-only",
						"activation": "first-use",
						"day": 7,
						"price": 5,
						"isUnlimited": false,
						"isAPNAutomatic": true,
						"apn": "globaldata",
						"apnUsername": "",
						"apnPassword": "",
						"dataAmount": 1024,
						"dataUnit": "MB",
						"callType": "all",
						"callAmount": -1,
						"callUnit": "",
						"smsType": "all",
						"smsAmount": -1,
						"smsUnit": "",
						"withSMS": false,
						"withCall": false,
						"withHotspot": true,
						"withDataRoaming": true,
						"withDestinationInstall": false,
		                "withUsageCheck": true,
						"notes": []
					},
					{
						"packageId": "esim-afghanistan-15days-2gb-all",
						"package": "2 GB - 15 Days",
						"plan": "data-only",
						"activation": "first-use",
						"day": 15,
						"price": 5,
						"isUnlimited": false,
						"isAPNAutomatic": true,
						"apn": "globaldata",
						"apnUsername": "",
						"apnPassword": "",
						"dataAmount": 2048,
						"dataUnit": "MB",
						"callType": "all",
						"callAmount": -1,
						"callUnit": "",
						"smsType": "all",
						"smsAmount": -1,
						"smsUnit": "",
						"withSMS": false,
						"withCall": false,
						"withHotspot": true,
						"withDataRoaming": true,
						"withDestinationInstall": false,
                        "withUsageCheck": true,
						"notes": []
					},
					{
						"packageId": "esim-afghanistan-15days-3gb-all",
						"package": "3 GB - 15 Days",
						"plan": "data-only",
						"activation": "first-use",
						"day": 15,
						"price": 5,
						"isUnlimited": false,
						"isAPNAutomatic": true,
						"apn": "globaldata",
						"apnUsername": "",
						"apnPassword": "",
						"dataAmount": 3072,
						"dataUnit": "MB",
						"callType": "all",
						"callAmount": -1,
						"callUnit": "",
						"smsType": "all",
						"smsAmount": -1,
						"smsUnit": "",
						"withSMS": false,
						"withCall": false,
						"withHotspot": true,
						"withDataRoaming": true,
						"withDestinationInstall": false,
                        "withUsageCheck": true,
						"notes": []
					},
					{
						"packageId": "esim-afghanistan-30days-3gb-all",
						"package": "3 GB - 30 Days",
						"plan": "data-only",
						"activation": "first-use",
						"day": 30,
						"price": 5,
						"isUnlimited": false,
						"isAPNAutomatic": true,
						"apn": "globaldata",
						"apnUsername": "",
						"apnPassword": "",
						"dataAmount": 3072,
						"dataUnit": "MB",
						"callType": "all",
						"callAmount": -1,
						"callUnit": "",
						"smsType": "all",
						"smsAmount": -1,
						"smsUnit": "",
						"withSMS": false,
						"withCall": false,
						"withHotspot": true,
						"withDataRoaming": true,
						"withDestinationInstall": false,
                        "withUsageCheck": true,
						"notes": []
					},
					{
						"packageId": "esim-afghanistan-15days-5gb-all",
						"package": "5 GB - 15 Days",
						"plan": "data-only",
						"activation": "first-use",
						"day": 15,
						"price": 5,
						"isUnlimited": false,
						"isAPNAutomatic": true,
						"apn": "globaldata",
						"apnUsername": "",
						"apnPassword": "",
						"dataAmount": 5120,
						"dataUnit": "MB",
						"callType": "all",
						"callAmount": -1,
						"callUnit": "",
						"smsType": "all",
						"smsAmount": -1,
						"smsUnit": "",
						"withSMS": false,
						"withCall": false,
						"withHotspot": true,
						"withDataRoaming": true,
						"withDestinationInstall": false,
                        "withUsageCheck": true,
						"notes": []
					},
					{
						"packageId": "esim-afghanistan-30days-5gb-all",
						"package": "5 GB - 30 Days",
						"plan": "data-only",
						"activation": "first-use",
						"day": 30,
						"price": 5,
						"isUnlimited": false,
						"isAPNAutomatic": true,
						"apn": "globaldata",
						"apnUsername": "",
						"apnPassword": "",
						"dataAmount": 5120,
						"dataUnit": "MB",
						"callType": "all",
						"callAmount": -1,
						"callUnit": "",
						"smsType": "all",
						"smsAmount": -1,
						"smsUnit": "",
						"withSMS": false,
						"withCall": false,
						"withHotspot": true,
						"withDataRoaming": true,
						"withDestinationInstall": false,
                        "withUsageCheck": true,
						"notes": []
					}
				]
			}
        ]
    }
}
Last updated on
CountriesOrders