{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"92ddba61-00f2-4c12-b2c5-07fa103b5dfc","name":"esimpop","description":"## esimpop API Documentation for Providers\n\n#### Version - V1\n\nVersion 1 - DEC 12, 2023 - Initial Release\n\n### Environments and Endpoints\n\n#### Production:\n\n[https://esimpop.com](https://esimpop.com)\n\n#### Staging:\n\n[https://staging.esimpop.com](https://staging.esimpop.com)\n\n# **API Data Fields**\n\n**These are the valid esimpop API data fields used within the esimpop API.**\n\n| **Field** | **Name** | **Type** | MOC | **Example** |\n| --- | --- | --- | --- | --- |\n| **eSIM provider name**  <br>  <br>The business name of the eSIM plan provider. | Provider | string | Mandatory | {  <br>\"Provider\": \"esimjust4u\",  <br>...  <br>} |\n| **eSIM plan ID**  <br>  <br>The unique identifier for the eSIM plan product. | id | string | Mandatory | {  <br>...  <br>\"id\": \"esimplanid01\",  <br>...  <br>} |\n| **eSIM plan name**  <br>  <br>The name or title of the eSIM plan product. | Name | string | Mandatory | {  <br>...  <br>\"Name\": \"The Ultimate Plan - 10GB 10 Days\",  <br>...  <br>} |\n| **Mobile Network Operator details**  <br>  <br>An array containing the Mobile Network Operator (MNO) details, with each object containing a value for the Mobile Country Code (MCC) and the Mobile Network Code (MNC). | MNO | JSON object array | Mandatory | {  <br>...  <br>\"MNO\": \\[  <br>{  <br>\"MCC\": \"520\",  <br>\"MNC\": \"03\"  <br>},  <br>{  <br>\"MCC\": \"505\",  <br>\"MNC\": \"01\"  <br>}  <br>\\],  <br>...  <br>} |\n| **eSIM plan description**  <br>  <br>The description of the eSIM plan product.  <br>  <br><u><i>\\*This field is suppressed, but will be available in the future.</i></u> | Description | string | Optional | {  <br>...  <br>\"Description\": \"Limited time offer! Purchase now and get a 20% discount off your next xplan!\",  <br>...  <br>} |\n| **eSIM plan type**  <br>  <br>The plan type of eSIM product.  <br>  <br>Eg: data, datavoice, subscription, etc. | Type | string | Mandatory | {  <br>...  <br>\"Type\": \"data\",  <br>...  <br>} |\n| **eSIM plan speed**  <br>  <br>The speed of eSIM plan product.  <br>  <br>Eg: 1, 0  <br>****Note: If the plan speed is 4G or greater the value should be “1”. If nothing is supplied the speed will default to “0” and display as standard (ie less than 4G. So, 3G - or even 2G in immature markets).** | Speed | number | Optional | {  <br>...  <br>\"Speed\": 1,  <br>...  <br>} |\n| **Price**  <br>  <br>The price for the eSIM plan in 2 decimal places. | Price | float | Mandatory | {  <br>...  <br>\"Price\": 14.00,  <br>...  <br>} |\n| **Currency**  <br>  <br>The ISO 4217 three-letter currency code for the price. | Currency | string | Mandatory | {  <br>...  <br>\"Currency\": \"AUD\",  <br>...  <br>} |\n| **Data allowance**  <br>  <br>The amount of megabytes included in the eSim plan.  <br>  <br>Eg: 1000 for 1 gigabyte.  <br>_**Note: If the plan is unlimited the value to be passed is -1**_ | Data Allowance | integer | Mandatory | {  <br>...  <br>\"Data Allowance\": 10000,  <br>...  <br>} |\n| **Coverage**  <br>  <br>A comma-separated list of ISO 3166 (Alpha-2) country codes that the eSim plan product covers. | Coverage | string | Mandatory | {  <br>...  <br>\"Coverage\": \"AF,AU,US\",  <br>...  <br>} |\n| **eSIM plan features**  <br>  <br>Values must be separated by comma to generate each Feature.  <br>Eg:  <br>every instance of Features value to display a list of values in an array. (Refer existing Providers for direction.) | Features | Array of strings | Optional | {  <br>...  <br>\"Features\": \\[  <br>\"Limited Offer\",  <br>\"Exclusive Rewards\"  <br>\\],  <br>...  <br>} |\n| **Plan billing type**  <br>  <br>Use “subscription” if the eSIM plan is a subscription product. Otherwise, use “prepaid”. | Billing Type | string | Mandatory | {  <br>...  <br>\"Billing Type\": \"prepaid\",  <br>...  <br>} |\n| **(Subscription) term label / interval**  <br>  <br><u><i>\\*For “subscription” Billing Type.</i></u>  <br>  <br>Enter either “day”, “week”, or “month” to describe the term or interval of the eSim subscription product.  <br>  <br>Eg: Enter “month” for a 3 month plan. | Subscription Unit | string | Optional | {  <br>...  <br>\"Subscription Unit\": \"month\",  <br>...  <br>} |\n| **(Subscription) term period**  <br>  <br><u><i>\\*For “subscription” Billing Type.</i></u>  <br>  <br>The number of days, weeks, or months (term) the data is valid.  <br>  <br>Eg: Enter “3” for for a 3 month plan. | Subscription Term | integer | Optional | {  <br>...  <br>\"Subscription Term\": 3,  <br>...  <br>} |\n| **(Prepaid) term label / interval**  <br>  <br><u><i>\\*For “prepaid” Billing Type.<br></i></u>  <br>Enter either “day”, “week”, or “month” to describe the term or interval of the eSim prepaid product.  <br>  <br>Eg: Enter “day” for a 7 day plan. | Prepaid Unit | string | Mandatory | {  <br>...  <br>\"Prepaid Unit\": \"day\",  <br>...  <br>} |\n| **(Prepaid) term period**  <br>  <br><u><i>\\*For “prepaid” Billing Type.</i></u>  <br>  <br>The number of days, weeks, or months (term) the data is valid.  <br>  <br>Eg: Enter “7” for a 7 day plan | Prepaid Term | integer | Mandatory | {  <br>...  <br>\"Prepaid Term\": 7,  <br>...  <br>} |\n| **Special conditions**  <br>  <br>Special conditions regarding the eSim plan product.  <br><u><i><br>\\*This field is suppressed, but will<br>be available in the future.</i></u> | Conditions | string | Optional | {  <br>...  <br>\"Conditions\": \"This eSim plan is only available to new customers.\",  <br>...  <br>} |\n| **eSIM plan URL**  <br>  <br>The URL of the eSIM plan product on the provider’s website. | URL | string | Mandatory | {  <br>...  <br>\"URL\": \"esimpro.au/esimplan1\",  <br>...  <br>} |\n| **Promotional code**  <br>  <br>The promotional code to redeem a special offer or discount. | Procode | string | Optional | {  <br>...  <br>\"Procode\": \"THANKU4B3INGU\",  <br>...  <br>} |\n| **Affiliate ID**  <br>  <br>The provider’s unique identifier for tracking the traffic source.  <br>  <br>This will be added to each eSIM plan product URL. | affiliate ID | string | Optional | {  <br>...  <br>\"affiliate ID\": \"esimpop\",  <br>...  <br>} |\n\n**Bugs & Issues**  \nIf you experience any issues setting up your integration with our API, please reach out to us. Our bespoke API is currently in its initial phase, and will be changing in future with enhanced request responses and improved documentation. You will be notified when these changes and enhancements are launched.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"7988491","collectionId":"92ddba61-00f2-4c12-b2c5-07fa103b5dfc","publishedId":"2s9Ye8fEYU","public":true,"publicUrl":"https://docs.esimpop.com","privateUrl":"https://go.postman.co/documentation/7988491-92ddba61-00f2-4c12-b2c5-07fa103b5dfc","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/ce421f3f-1203-482e-b998-98e4e6dbe9f8/ZXNpbXBvcC1sb2dvLXdoaXRlLTMwMHg1NS5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/6591ccd3-6d42-4704-b179-2433dc68c84c/ZXNpbXBvcC1sb2dvLTUucG5n","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.0","publishDate":"2023-12-13T04:59:07.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/6591ccd3-6d42-4704-b179-2433dc68c84c/ZXNpbXBvcC1sb2dvLTUucG5n","logoDark":"https://content.pstmn.io/ce421f3f-1203-482e-b998-98e4e6dbe9f8/ZXNpbXBvcC1sb2dvLXdoaXRlLTMwMHg1NS5wbmc="}},"statusCode":200},"environments":[{"name":"Staging","id":"4f507564-0f51-45c6-b7cc-95f2fb81d730","owner":"7988491","values":[{"key":"baseURL","value":"https://staging.esimpop.com/api","enabled":true,"type":"default"},{"key":"token","value":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczovL3N0YWdpbmcuZXNpbXBvcC5jb20iLCJpYXQiOjE3MDI0NjA5MDIsIm5iZiI6MTcwMjQ2MDkwMiwiZXhwIjoxNzAzMDY1NzAyLCJkYXRhIjp7InVzZXIiOnsiaWQiOjYsImRldmljZSI6IiIsInBhc3MiOiI4NTAwZmU1MWNkNjllY2Q0ZTM5ZDE2ZWQ5YTYxMjc1YyJ9fX0.xSIQ7hl0tViuLsxkXJpeePM0bykjSqJlFIQ46NsRO3U","enabled":true,"type":"secret"},{"key":"auth_password","value":"lLjSh40fV9AUOjKeFP0p6ul9","enabled":true,"type":"secret"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/6aa6f28a085a844f74f8855e0593d7416b8419fb79dd0f0c6cabb452ab4d7c7f","favicon":"https://esimpop.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Staging","value":"7988491-4f507564-0f51-45c6-b7cc-95f2fb81d730"}],"canonicalUrl":"https://docs.esimpop.com/view/metadata/2s9Ye8fEYU"}