Changes to the eSIMmu API that affect what you send or receive
First published version
The API as documented here: the product list at your own price, signed
requests with a body hash, orders by
external_order_id and option_id, eSIM status and usage, refund requests,
and the esim.issued, esim.refunded and esim.refund_declined webhooks.
Last modified on November 17, 2026
⌘I
{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"eSIMmu API Documentation","colors":{"primary":"#005fff","light":"#66a0ff","dark":"#005fff"},"logo":{"light":"https://mintcdn.com/esimmu/wlf_PaqnnHNizHv_/images/logos/full-colour.svg?fit=max\u0026auto=format\u0026n=wlf_PaqnnHNizHv_\u0026q=85\u0026s=d0be06f17c1d7cc24a615b3755205eb6","dark":"https://mintcdn.com/esimmu/wlf_PaqnnHNizHv_/images/logos/white.svg?fit=max\u0026auto=format\u0026n=wlf_PaqnnHNizHv_\u0026q=85\u0026s=c02632f5152c0fecdc5d91887a1b7c9c","href":"/"},"favicon":"https://mintcdn.com/esimmu/wlf_PaqnnHNizHv_/images/favicons/brand.svg?fit=max\u0026auto=format\u0026n=wlf_PaqnnHNizHv_\u0026q=85\u0026s=b6ad6682b6eb4acffbba766ce858f9e3","api":{"openapi":"api-reference/openapi.json","playground":{"display":"simple"},"mdx":{"server":["https://api.esimmu.com/api"]}},"footer":{"socials":{"website":"https://www.esimmu.com"}},"fonts":{"family":"Inter"},"contextual":{"options":["copy","view","claude","chatgpt","perplexity","mcp","cursor","vscode"],"display":"header"},"thumbnails":{"appearance":"light","background":"https://mintcdn.com/esimmu/wlf_PaqnnHNizHv_/images/og-image.png?fit=max\u0026auto=format\u0026n=wlf_PaqnnHNizHv_\u0026q=85\u0026s=5da487513aeae6826784d5f6967544d7","fonts":{"family":"Inter"}},"metadata":{"timestamp":true},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"esimmu","hasAudioNarration":false,"actualSubdomain":"esimmu","customDomains":["docs.esimmu.com"],"gitSource":{"type":"github","owner":"jaedung","repo":"esimmu-api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":"","_id":"6afbcfe366aa1359768cac4a"},"entitlements":{},"buildId":"6afbd4096e57d3b7b564da66","clientVersion":"0.0.4167","searchFilterCounts":[{"language":"default","tag":"Get Started","count":4},{"language":"default","tag":"Orders","count":3},{"language":"default","tag":"Products","count":1},{"language":"default","tag":"Refunds","count":1},{"language":"default","tag":"Webhooks","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".nav-logo{height:30px!important;width:auto!important}"}],"page":{"pagePath":"changelog","slug":"/changelog","pageMetadata":{"title":"Changelog","description":"Changes to the eSIMmu API that affect what you send or receive","rss":true,"href":"/changelog"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Changes to the eSIMmu API that affect what you send or receive\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,..._provideComponents(),...props.components},{Update}=_components;if(!Update)_missingMdxReference(`Update`,true);return _jsx(Update,{label:`2026-11-17`,description:`First published version`,id:`2026-11-17`,children:_jsxs(_components.p,{children:[`The API as documented here: the product list at your own price, signed\nrequests with a body hash, orders by\n`,_jsx(_components.code,{children:`external_order_id`}),` and `,_jsx(_components.code,{children:`option_id`}),`, eSIM status and usage, refund requests,\nand the `,_jsx(_components.code,{children:`esim.issued`}),`, `,_jsx(_components.code,{children:`esim.refunded`}),` and `,_jsx(_components.code,{children:`esim.refund_declined`}),` webhooks.`]})})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Changelog","description":"Changes to the eSIMmu API that affect what you send or receive","rss":true,"href":"/changelog"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"2026-11-17","slug":"2026-11-17","depth":1,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"esimmu","siteName":"eSIMmu API Documentation","title":"Changelog - eSIMmu API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-17T03:58:20.313Z","gitLastModified":"2026-11-17T03:51:30.000Z","originalFileLocation":"changelog.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Changes to the eSIMmu API that affect what you send or receive\">\u003cmeta data-mint-head name=\"application-name\" content=\"eSIMmu API Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/esimmu/dRFTRfVUAPD4Kdfs/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/esimmu/dRFTRfVUAPD4Kdfs/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/esimmu/dRFTRfVUAPD4Kdfs/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/esimmu/dRFTRfVUAPD4Kdfs/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/esimmu/dRFTRfVUAPD4Kdfs/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/esimmu/dRFTRfVUAPD4Kdfs/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/esimmu/dRFTRfVUAPD4Kdfs/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/esimmu/dRFTRfVUAPD4Kdfs/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/esimmu/dRFTRfVUAPD4Kdfs/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Changelog - eSIMmu API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Changes to the eSIMmu API that affect what you send or receive\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"eSIMmu API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.esimmu.com/changelog\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://esimmu.mintlify.site/_mintlify/api/og/v2?division=Get+Started\u0026amp;title=Changelog\u0026amp;description=Changes+to+the+eSIMmu+API+that+affect+what+you+send+or+receive\u0026amp;theme=b9c868b5c6facc7084253b28\u0026amp;signature=17b0715b857999f6cb31c0f8153f09e698fa2e8139b9de2ae199a050150c1527\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Changelog - eSIMmu API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Changes to the eSIMmu API that affect what you send or receive\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://esimmu.mintlify.site/_mintlify/api/og/v2?division=Get+Started\u0026amp;title=Changelog\u0026amp;description=Changes+to+the+eSIMmu+API+that+affect+what+you+send+or+receive\u0026amp;theme=b9c868b5c6facc7084253b28\u0026amp;signature=17b0715b857999f6cb31c0f8153f09e698fa2e8139b9de2ae199a050150c1527\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/esimmu/dRFTRfVUAPD4Kdfs/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"eSIMmu API Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#005fff\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.esimmu.com/changelog\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/changelog.md\">\u003clink data-mint-head rel=\"alternate\" type=\"application/rss+xml\" href=\"https://docs.esimmu.com/changelog/rss.xml\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.esimmu.com/#organization\",\"name\":\"eSIMmu API Documentation\",\"url\":\"https://docs.esimmu.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/esimmu/wlf_PaqnnHNizHv_/images/logos/full-colour.svg?fit=max\u0026auto=format\u0026n=wlf_PaqnnHNizHv_\u0026q=85\u0026s=d0be06f17c1d7cc24a615b3755205eb6\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.esimmu.com#website\",\"name\":\"eSIMmu API Documentation\",\"url\":\"https://docs.esimmu.com\",\"publisher\":{\"@id\":\"https://docs.esimmu.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.esimmu.com/changelog#webpage\",\"url\":\"https://docs.esimmu.com/changelog\",\"name\":\"Changelog\",\"description\":\"Changes to the eSIMmu API that affect what you send or receive\",\"dateModified\":\"2026-11-17T03:51:30.000Z\",\"isPartOf\":{\"@id\":\"https://docs.esimmu.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.esimmu.com/changelog#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.esimmu.com/changelog#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Get Started\",\"item\":\"https://docs.esimmu.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Changelog\",\"item\":\"https://docs.esimmu.com/changelog\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.esimmu.com/changelog#article\",\"headline\":\"Changelog\",\"name\":\"Changelog\",\"description\":\"Changes to the eSIMmu API that affect what you send or receive\",\"url\":\"https://docs.esimmu.com/changelog\",\"mainEntityOfPage\":{\"@id\":\"https://docs.esimmu.com/changelog#webpage\"},\"dateModified\":\"2026-11-17T03:51:30.000Z\",\"publisher\":{\"@id\":\"https://docs.esimmu.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.esimmu.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"eSIMmu API Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"eSIMmu API Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/changelog.md","siteName":"eSIMmu API Documentation","nav":{"global":null,"groups":[{"group":"Get Started","pages":[{"title":"Introduction","href":"/index"},{"title":"Authentication","href":"/authentication/overview"},{"title":"Conventions","description":"Request format, identifiers and errors shared by every endpoint","href":"/conventions"},{"title":"Changelog","href":"/changelog"}]},{"group":"Products","pages":[{"title":"List products","openapi":"GET /v1/api_partner/products","description":"Every product you can order, with what it covers and your wholesale price: the price you are invoiced for it. Fetch it once a day and cache it, rather than per order. Limited to 10 requests per minute per access key.\n\nThe filters narrow the list; an unknown value returns an empty list, not the whole catalogue.","href":"/endpoints/list-products"}]},{"group":"Orders","pages":[{"title":"Create an order","openapi":"POST /v1/api_partner/orders","href":"/endpoints/create-order"},{"title":"Get eSIM status","openapi":"GET /v1/api_partner/partner_order_items/{topup_id}","href":"/endpoints/esim-status"},{"title":"Get eSIM usage","openapi":"GET /v1/api_partner/partner_order_items/{topup_id}/usage","href":"/endpoints/esim-usage"}]},{"group":"Refunds","pages":[{"title":"Request a refund","openapi":"POST /v1/api_partner/partner_order_items/{topup_id}/refund_request","href":"/endpoints/request-refund"}]},{"group":"Webhooks","pages":[{"title":"Webhooks","href":"/endpoints/webhooks"}]}]},"basePath":"","title":"Changelog - eSIMmu API Documentation","buildId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","deploymentId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","dynamics":[],"chunks":[]}