{
"code": "outOfInventory",
"message": "New subscription could not be created because the account is out of inventory",
"docsUrl": "https://bondio.stoplight.io/docs/bondio-api"
}
Subscription
Expire a subscription
Expires a subscription thereby stopping all the services on the attached eSIM. An expired subscription has a non-null expiredAt field. This is an irreversible step meaning the same subscription cannot be activated again. Also, the corresponding eSIM cannot be used again.
{
"code": "outOfInventory",
"message": "New subscription could not be created because the account is out of inventory",
"docsUrl": "https://bondio.stoplight.io/docs/bondio-api"
}
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Bondio Help Center","colors":{"primary":"#EF8748","light":"#619CF8","dark":"#C146F0"},"logo":{"light":"https://mintcdn.com/bondio-ebb26b62/_3NDDs6CrhAJ6NMn/images/logo-light_1.png?fit=max\u0026auto=format\u0026n=_3NDDs6CrhAJ6NMn\u0026q=85\u0026s=8d4bac5d25ddd0bf83ef2c2ad9dd0114","dark":"https://mintcdn.com/bondio-ebb26b62/_3NDDs6CrhAJ6NMn/images/logo-dark.png?fit=max\u0026auto=format\u0026n=_3NDDs6CrhAJ6NMn\u0026q=85\u0026s=c0f264a0bf833d2bbb7ff05375373fea","href":"https://docs.bondio.co/"},"favicon":"https://mintcdn.com/bondio-ebb26b62/mngPjKWoP0LFDU8J/images/Group_16.png?fit=max\u0026auto=format\u0026n=mngPjKWoP0LFDU8J\u0026q=85\u0026s=a939ff1e852c84dd114fba6e17faf8cb","api":{"playground":{"display":"interactive"},"examples":{"languages":["curl","python","javascript"]}},"background":{"color":{"dark":"#080D18"}},"navbar":{"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.bondio.co"}},"fonts":{"family":"Manrope"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"bondio-ebb26b62","hasAudioNarration":false,"actualSubdomain":"bondio-ebb26b62","customDomains":["docs.bondio.co"],"gitSource":{"type":"github","owner":"bondio-vcs","repo":"bondio-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"collectionId":"45459295-4164-4717-b4f5-9029ca6b7cc1","liveDeploymentHistoryId":"6ac799cedf14e6603e2ebef0","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ac799cedf14e6603e2ebef0"},"entitlements":{},"buildId":"6ac799cedf14e6603e2ebef0","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"API Reference","count":43},{"language":"default","tag":"Endpoints","count":38},{"language":"default","tag":"Documentation","count":16},{"language":"default","tag":"SubscriptionV2","count":12},{"language":"default","tag":"Getting Started","count":7},{"language":"default","tag":"Plan","count":7},{"language":"default","tag":"Subscription","count":6},{"language":"default","tag":"Platform","count":5},{"language":"default","tag":"Esim","count":5},{"language":"default","tag":"Launch Announcements","count":4}]},"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":"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":"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":"llms-txt-v2","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":"per-site-search-delta","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":"editor-private-page-search","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"api-reference/subscription/expire-a-subscription","slug":"/api-reference/subscription/expire-a-subscription","pageMetadata":{"title":"Expire a subscription","description":"Expires a subscription thereby stopping all the services on the attached eSIM. An expired subscription has a non-null `expiredAt` field. This is an irreversible step meaning the same subscription cannot be activated again. Also, the corresponding eSIM cannot be used again.","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/subscriptions/{id}/expire","href":"/api-reference/subscription/expire-a-subscription","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Expires a subscription thereby stopping all the services on the attached eSIM. An expired subscription has a non-null \", _jsx(_components.code, {\n children: \"expiredAt\"\n }), \" field. This is an irreversible step meaning the same subscription cannot be activated again. Also, the corresponding eSIM cannot be used again.\"]\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{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Expire a subscription","description":"Expires a subscription thereby stopping all the services on the attached eSIM. An expired subscription has a non-null `expiredAt` field. This is an irreversible step meaning the same subscription cannot be activated again. Also, the corresponding eSIM cannot be used again.","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/subscriptions/{id}/expire","href":"/api-reference/subscription/expire-a-subscription","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Expire a subscription","tags":["Subscription"],"responses":{"200":"9e69159f-960e-49be-b200-84f2cb68d235","404":"6c944191-639b-4599-89b4-4b65e1d69c01","409":"031ddf52-9435-4d38-9f4f-3e4938c0ed56"},"operationId":"post-v1-subscriptions-id-expire","x-stoplight":{"id":"podfdyfy55hpv"},"description":"Expires a subscription thereby stopping all the services on the attached eSIM. An expired subscription has a non-null `expiredAt` field. This is an irreversible step meaning the same subscription cannot be activated again. Also, the corresponding eSIM cannot be used again.","x-internal":false,"method":"post","type":"path","servers":["b8c43b79-c14a-4af7-a7f4-f4836a037192"],"security":["4f8557c7-5505-42f4-9739-22db37313476"],"path":"/v1/subscriptions/{id}/expire","baseUrlOptions":["https://api.bondio.co"],"title":"Expire a subscription","codeSamples":[],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"c2d3d357-334f-4a9e-92f0-d73651c4f8f5":{"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"},"name":"id","in":"path","required":true},"ace05006-7d2d-49f5-b99d-6208df13124e":{"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"},"name":"id","in":"path","required":true}},"responses":{"9e69159f-960e-49be-b200-84f2cb68d235":{"description":"Returns the up to date subscription that has the expireAt field set.","content":{"application/json":{"schema":{"title":"Subscription","x-stoplight":{"id":"ytddekchv3vcj"},"type":"object","x-extension-1":null,"examples":[{"id":"sub.id1","esimIccid":"891004234814455936F","planId":"plan_id1","createdAt":1707752560,"activatedAt":1707778560,"expireAt":1707799560,"purchasedAllowance":{"dataBytes":102400001024,"voiceSeconds":3660,"smsMessages":100},"remainingAllownace":{"dataBytes":1024,"voiceSeconds":1800,"smsMessages":50},"state":"active","metadata":{"devDefinedKey":"someValue"},"plan":{"name":"Australia 1GB 7d recurring throttled","dataMegaBytes":1024,"periodDays":1,"periodIterations":7,"throttledSpeedKbps":128,"label":"sigma","coverageProfileId":"cvpr_dhl3zq9r"}}],"required":["id","esimIccid","planId","plan","createdAt","activatedAt","expireAt","purchasedAllowance","remainingAllownace","state","metadata"],"properties":{"id":{"type":"string","x-stoplight":{"id":"o1nsg5f7izt82"},"isRequired":true,"uniqueKey":"id","typeLabel":"string"},"esimIccid":{"type":"string","x-stoplight":{"id":"3my975v0nfnkq"},"isRequired":true,"uniqueKey":"esimIccid","typeLabel":"string"},"planId":{"type":"string","x-stoplight":{"id":"93arprmverd34"},"deprecated":true,"isRequired":true,"uniqueKey":"planId","typeLabel":"string"},"plan":{"title":"PlanForAttachment","x-stoplight":{"id":"k0x1vkzw1pkj1"},"type":"object","examples":[{"name":"Australia 1GB 7d","dataMegaBytes":1024,"periodDays":1,"periodIterations":7,"throttledSpeedKbps":128,"label":"alpha","coverageProfileId":"cvpr_ybrs38es"}],"x-internal":false,"properties":{"name":{"type":"string","deprecated":true,"uniqueKey":"plan.name","typeLabel":"string"},"dataMegaBytes":{"type":"integer","uniqueKey":"plan.dataMegaBytes","typeLabel":"integer"},"periodDays":{"type":"integer","description":"Plan validity in days","uniqueKey":"plan.periodDays","typeLabel":"integer"},"periodIterations":{"type":"integer","description":"Number of times the periodDays should be repeated.\n","default":1,"uniqueKey":"plan.periodIterations","typeLabel":"integer"},"throttledSpeedKbps":{"type":"integer","description":"Speed after allocated data is used up. The default zero means no usage allowed afterwards.","default":0,"uniqueKey":"plan.throttledSpeedKbps","typeLabel":"integer"},"label":{"type":"string","description":"The plan-esim compatibility label","uniqueKey":"plan.label","typeLabel":"string"},"coverageProfileId":{"type":"string","x-stoplight":{"id":"08gh0d0gwjx1r"},"uniqueKey":"plan.coverageProfileId","typeLabel":"string"}},"isRequired":true,"uniqueKey":"plan","typeLabel":"PlanForAttachment · object"},"createdAt":{"type":"integer","x-stoplight":{"id":"v8guw2wy9im1t"},"isRequired":true,"uniqueKey":"createdAt","typeLabel":"integer"},"activatedAt":{"oneOf":[{"type":"integer","x-stoplight":{"id":"g2rqdnefb38r2"},"isRequired":true,"uniqueKey":"activatedAt.oneOf.0","typeLabel":"integer"},{"type":"null","x-stoplight":{"id":"g2rqdnefb38r2"},"isRequired":true,"uniqueKey":"activatedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"activatedAt","typeLabel":"integer | null"},"expireAt":{"oneOf":[{"type":"integer","x-stoplight":{"id":"v6g6f0wqm62ap"},"isRequired":true,"uniqueKey":"expireAt.oneOf.0","typeLabel":"integer"},{"type":"null","x-stoplight":{"id":"v6g6f0wqm62ap"},"isRequired":true,"uniqueKey":"expireAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"expireAt","typeLabel":"integer | null"},"purchasedAllowance":{"title":"Allowance","x-stoplight":{"id":"bxnnhkoqzanhs"},"type":"object","examples":[{"dataBytes":1024,"voiceSeconds":60,"smsMessages":100}],"properties":{"dataBytes":{"oneOf":[{"type":"integer","x-stoplight":{"id":"cjcvtodo08pjs"},"format":"int64","minimum":0,"uniqueKey":"purchasedAllowance.dataBytes.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","x-stoplight":{"id":"cjcvtodo08pjs"},"format":"int64","minimum":0,"uniqueKey":"purchasedAllowance.dataBytes.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchasedAllowance.dataBytes","typeLabel":"integer\u003cint64> | null"},"voiceSeconds":{"oneOf":[{"type":"integer","x-stoplight":{"id":"5lrv0ke2wi39u"},"uniqueKey":"purchasedAllowance.voiceSeconds.oneOf.0","typeLabel":"integer"},{"type":"null","x-stoplight":{"id":"5lrv0ke2wi39u"},"uniqueKey":"purchasedAllowance.voiceSeconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchasedAllowance.voiceSeconds","typeLabel":"integer | null"},"smsMessages":{"oneOf":[{"type":"integer","x-stoplight":{"id":"17ms5p0dzfm0m"},"uniqueKey":"purchasedAllowance.smsMessages.oneOf.0","typeLabel":"integer"},{"type":"null","x-stoplight":{"id":"17ms5p0dzfm0m"},"uniqueKey":"purchasedAllowance.smsMessages.oneOf.1","typeLabel":"null"}],"uniqueKey":"purchasedAllowance.smsMessages","typeLabel":"integer | null"}},"isRequired":true,"uniqueKey":"purchasedAllowance","typeLabel":"Allowance · object"},"remainingAllownace":{"title":"Allowance","x-stoplight":{"id":"kd24rhmpg022a"},"type":"object","examples":[{"dataBytes":1024,"voiceSeconds":60,"smsMessages":100}],"properties":{"dataBytes":{"oneOf":[{"type":"integer","x-stoplight":{"id":"cjcvtodo08pjs"},"format":"int64","minimum":0,"uniqueKey":"remainingAllownace.dataBytes.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","x-stoplight":{"id":"cjcvtodo08pjs"},"format":"int64","minimum":0,"uniqueKey":"remainingAllownace.dataBytes.oneOf.1","typeLabel":"null"}],"uniqueKey":"remainingAllownace.dataBytes","typeLabel":"integer\u003cint64> | null"},"voiceSeconds":{"oneOf":[{"type":"integer","x-stoplight":{"id":"5lrv0ke2wi39u"},"uniqueKey":"remainingAllownace.voiceSeconds.oneOf.0","typeLabel":"integer"},{"type":"null","x-stoplight":{"id":"5lrv0ke2wi39u"},"uniqueKey":"remainingAllownace.voiceSeconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"remainingAllownace.voiceSeconds","typeLabel":"integer | null"},"smsMessages":{"oneOf":[{"type":"integer","x-stoplight":{"id":"17ms5p0dzfm0m"},"uniqueKey":"remainingAllownace.smsMessages.oneOf.0","typeLabel":"integer"},{"type":"null","x-stoplight":{"id":"17ms5p0dzfm0m"},"uniqueKey":"remainingAllownace.smsMessages.oneOf.1","typeLabel":"null"}],"uniqueKey":"remainingAllownace.smsMessages","typeLabel":"integer | null"}},"isRequired":true,"uniqueKey":"remainingAllownace","typeLabel":"Allowance · object"},"state":{"x-stoplight":{"id":"3i29zhfc0fowz"},"enum":["active","expired","ready"],"type":"string","isRequired":true,"uniqueKey":"state","typeLabel":"enum\u003cstring>"},"metadata":{"type":"object","x-stoplight":{"id":"zcgtfk8ulf58c"},"additionalProperties":{"x-stoplight":{"id":"b1yvb77uyd8o8"},"type":"string","uniqueKey":"metadata.additionalProperties","typeLabel":"string"},"isRequired":true,"uniqueKey":"metadata","typeLabel":"object"}},"uniqueKey":"","typeLabel":"Subscription · object"},"examples":{"Example":{"title":"Example","value":{"id":"sub.id1","esimIccid":"891004234814455936F","planId":"plan_id1","createdAt":1707752560,"activatedAt":1707778560,"expireAt":1707799560,"purchasedAllowance":{"dataBytes":102400001024,"voiceSeconds":3660,"smsMessages":100},"remainingAllownace":{"dataBytes":1024,"voiceSeconds":1800,"smsMessages":50},"state":"active","metadata":{"devDefinedKey":"someValue"},"plan":{"name":"Australia 1GB 7d recurring throttled","dataMegaBytes":1024,"periodDays":1,"periodIterations":7,"throttledSpeedKbps":128,"label":"sigma","coverageProfileId":"cvpr_dhl3zq9r"}}}},"exampleType":"generated"}},"exampleType":"generated"},"6c944191-639b-4599-89b4-4b65e1d69c01":{"description":"The resource not found.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"031ddf52-9435-4d38-9f4f-3e4938c0ed56":{"description":"The request could not be processed because the subscription is not in 'active' state.","content":{"application/json":{"schema":{"type":"object","x-examples":{"Example 1":{"object":"error","code":"invalidICCID","details":[{"object":"propertyErrorDetail","code":"propertyRequired","message":"Invalid value for property.","property":"property1","suggestion":"alternative_value"}],"documentation":["https://developers.gigs.com/docs/api/ZG9jOjExMTYzMDU0-error-handling"],"hint":"Parameter iccid must match /^([0-9]{19}F?|[0-9]{20})$/i","message":"Invalid ICCID format.","type":"invalid"}},"examples":[{"code":"outOfInventory","message":"New subscription could not be created because the account is out of inventory","docsUrl":"https://bondio.stoplight.io/docs/bondio-api"}],"required":["code","message","docsUrl"],"properties":{"code":{"type":"string","description":"A machine-readable description of the error.\n\nExample: `outOfInventory`","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"A human readable description of the error","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"docsUrl":{"oneOf":[{"type":"string","description":"A URL to the docs page providing further information to resolve the error.","isRequired":true,"uniqueKey":"docsUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"A URL to the docs page providing further information to resolve the error.","isRequired":true,"uniqueKey":"docsUrl.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"docsUrl","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"outOfInventory","message":"New subscription could not be created because the account is out of inventory","docsUrl":"https://bondio.stoplight.io/docs/bondio-api"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"4f8557c7-5505-42f4-9739-22db37313476":{"BearerAuth":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"b8c43b79-c14a-4af7-a7f4-f4836a037192":{"url":"https://api.bondio.co","description":"prod"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"bondio-ebb26b62","siteName":"Bondio Help Center","title":"Expire a subscription - Bondio Help Center","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-08T13:25:50.256Z","originalFileLocation":"api-reference/subscription/expire-a-subscription.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=\"Expires a subscription thereby stopping all the services on the attached eSIM. An expired subscription has a non-null expiredAt field. This is an irreversible step meaning the same subscription cannot be activated again. Also, the corresponding eSIM cannot be used again.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Bondio Help Center\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/bondio-ebb26b62/3Xms0v_zwv1vnMll/_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/bondio-ebb26b62/3Xms0v_zwv1vnMll/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/bondio-ebb26b62/3Xms0v_zwv1vnMll/_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/bondio-ebb26b62/3Xms0v_zwv1vnMll/_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/bondio-ebb26b62/3Xms0v_zwv1vnMll/_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/bondio-ebb26b62/3Xms0v_zwv1vnMll/_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/bondio-ebb26b62/3Xms0v_zwv1vnMll/_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/bondio-ebb26b62/3Xms0v_zwv1vnMll/_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/bondio-ebb26b62/3Xms0v_zwv1vnMll/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Expire a subscription - Bondio Help Center\">\u003cmeta data-mint-head property=\"og:description\" content=\"Expires a subscription thereby stopping all the services on the attached eSIM. An expired subscription has a non-null expiredAt field. This is an irreversible step meaning the same subscription cannot be activated again. Also, the corresponding eSIM cannot be used again.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Bondio Help Center\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.bondio.co/api-reference/subscription/expire-a-subscription\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://bondio-ebb26b62.mintlify.app/_mintlify/api/og/v2?division=Subscription\u0026amp;title=Expire+a+subscription\u0026amp;description=Expires+a+subscription+thereby+stopping+all+the+services+on+the+attached+eSIM.+An+expired+subscription+has+a+non-null+%60expiredAt%60+field.+This+is+an+irreversible\u0026amp;theme=81aab13e76850760ffaafe77\u0026amp;signature=e323e183c4666b502cfa278a2aa43f46fbe1747580d1ad373ba7fd7742670bbf\">\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=\"Expire a subscription - Bondio Help Center\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Expires a subscription thereby stopping all the services on the attached eSIM. An expired subscription has a non-null expiredAt field. This is an irreversible step meaning the same subscription cannot be activated again. Also, the corresponding eSIM cannot be used again.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://bondio-ebb26b62.mintlify.app/_mintlify/api/og/v2?division=Subscription\u0026amp;title=Expire+a+subscription\u0026amp;description=Expires+a+subscription+thereby+stopping+all+the+services+on+the+attached+eSIM.+An+expired+subscription+has+a+non-null+%60expiredAt%60+field.+This+is+an+irreversible\u0026amp;theme=81aab13e76850760ffaafe77\u0026amp;signature=e323e183c4666b502cfa278a2aa43f46fbe1747580d1ad373ba7fd7742670bbf\">\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/bondio-ebb26b62/3Xms0v_zwv1vnMll/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Bondio Help Center\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#EF8748\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.bondio.co/api-reference/subscription/expire-a-subscription\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/subscription/expire-a-subscription.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.bondio.co/#organization\",\"name\":\"Bondio Help Center\",\"url\":\"https://docs.bondio.co\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/bondio-ebb26b62/_3NDDs6CrhAJ6NMn/images/logo-light_1.png?fit=max\u0026auto=format\u0026n=_3NDDs6CrhAJ6NMn\u0026q=85\u0026s=8d4bac5d25ddd0bf83ef2c2ad9dd0114\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.bondio.co#website\",\"name\":\"Bondio Help Center\",\"url\":\"https://docs.bondio.co\",\"publisher\":{\"@id\":\"https://docs.bondio.co/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.bondio.co/api-reference/subscription/expire-a-subscription#webpage\",\"url\":\"https://docs.bondio.co/api-reference/subscription/expire-a-subscription\",\"name\":\"Expire a subscription\",\"description\":\"Expires a subscription thereby stopping all the services on the attached eSIM. An expired subscription has a non-null expiredAt field. This is an irreversible step meaning the same subscription cannot be activated again. Also, the corresponding eSIM cannot be used again.\",\"dateModified\":\"2026-10-08T13:25:50.256Z\",\"isPartOf\":{\"@id\":\"https://docs.bondio.co#website\"},\"breadcrumb\":{\"@id\":\"https://docs.bondio.co/api-reference/subscription/expire-a-subscription#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.bondio.co/api-reference/subscription/expire-a-subscription#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.bondio.co/api-reference/coverage-profile/list-coverage-profiles\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Subscription\",\"item\":\"https://docs.bondio.co/api-reference/subscription/get-a-subscription\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Expire a subscription\",\"item\":\"https://docs.bondio.co/api-reference/subscription/expire-a-subscription\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.bondio.co/api-reference/subscription/expire-a-subscription#apireference\",\"headline\":\"Expire a subscription\",\"name\":\"Expire a subscription\",\"description\":\"Expires a subscription thereby stopping all the services on the attached eSIM. An expired subscription has a non-null expiredAt field. This is an irreversible step meaning the same subscription cannot be activated again. Also, the corresponding eSIM cannot be used again.\",\"url\":\"https://docs.bondio.co/api-reference/subscription/expire-a-subscription\",\"mainEntityOfPage\":{\"@id\":\"https://docs.bondio.co/api-reference/subscription/expire-a-subscription#webpage\"},\"dateModified\":\"2026-10-08T13:25:50.256Z\",\"publisher\":{\"@id\":\"https://docs.bondio.co/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.bondio.co#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Bondio Help Center\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Bondio Help Center","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API Reference","groups":[{"group":"Getting Started","pages":[{"title":"Quickstart","icon":"bolt","href":"/introduction"},{"title":"Authentication","icon":"key","href":"/authentication"},{"title":"Pagination","icon":"list","href":"/pagination"},{"title":"Errors","icon":"triangle-exclamation","href":"/errors"},{"title":"Webhook Events","icon":"webhook","href":"/webhooks"}]},{"group":"Endpoints","pages":[{"group":"Coverage Profile","pages":[{"title":"List coverage profiles","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/coverage-profiles","href":"/api-reference/coverage-profile/list-coverage-profiles"},{"title":"Get the coverage profile","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/coverage-profiles/{id}","href":"/api-reference/coverage-profile/get-the-coverage-profile"}]},{"group":"Plan","pages":[{"title":"Get a plan","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/plans/{id}","href":"/api-reference/plan/get-a-plan"},{"title":"Delete plan","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /v1/plans/{id}","href":"/api-reference/plan/delete-plan"},{"title":"Update plan","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /v1/plans/{id}","href":"/api-reference/plan/update-plan"},{"title":"List plans","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/plans","href":"/api-reference/plan/list-plans"},{"title":"Create a plan","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/plans","href":"/api-reference/plan/create-a-plan"},{"title":"Archive a plan","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/plans/{id}/archive","href":"/api-reference/plan/archive-a-plan"},{"title":"Un-archive a plan","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/plans/{id}/un-archive","href":"/api-reference/plan/un-archive-a-plan"}]},{"group":"Esim","pages":[{"title":"Get an eSIM","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/esims/{iccid}","href":"/api-reference/esim/get-an-esim"},{"title":"List eSIMs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/esims","href":"/api-reference/esim/list-esims"},{"title":"Get SMDP state info of eSIM","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/esims/{iccid}/smdp-info","href":"/api-reference/esim/get-smdp-state-info-of-esim"},{"title":"Get QR code image","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/esims/{iccid}/qrcode","href":"/api-reference/esim/get-qr-code-image"},{"title":"Set grace period finish action","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /v1/esims/{iccid}/availability","href":"/api-reference/esim/set-grace-period-finish-action"}]},{"group":"SubscriptionV2","pages":[{"title":"Get a subscription","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v2/subscriptions/{xid}","href":"/api-reference/subscriptionv2/get-a-subscription"},{"title":"Delete a subscription","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /v2/subscriptions/{xid}","href":"/api-reference/subscriptionv2/delete-a-subscription"},{"title":"List subscriptions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v2/subscriptions","href":"/api-reference/subscriptionv2/list-subscriptions"},{"title":"Create a new subscription","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v2/subscriptions","href":"/api-reference/subscriptionv2/create-a-new-subscription"},{"title":"Suspend a subscription","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v2/subscriptions/{xid}/suspend","href":"/api-reference/subscriptionv2/suspend-a-subscription"},{"title":"Get subscription state info","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v2/subscriptions/{xid}/state-info","href":"/api-reference/subscriptionv2/get-subscription-state-info"},{"title":"Get a plan attachment","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v2/subscriptions/{xid}/plan-attachments/{id}","href":"/api-reference/subscriptionv2/get-a-plan-attachment"},{"title":"List plan attachments","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v2/subscriptions/{xid}/plan-attachments","href":"/api-reference/subscriptionv2/list-plan-attachments"},{"title":"(Topup) Create a plan attachment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v2/subscriptions/{xid}/plan-attachments","href":"/api-reference/subscriptionv2/topup-create-a-plan-attachment"},{"title":"Suspend a plan attachment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v2/subscriptions/{xid}/plan-attachments/{id}/suspend","href":"/api-reference/subscriptionv2/suspend-a-plan-attachment"},{"title":"Send sms","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v2/subscriptions/{xid}/send-sms","href":"/api-reference/subscriptionv2/send-sms"},{"title":"Get the location of subscription esim","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v2/subscriptions/{xid}/esim-location","href":"/api-reference/subscriptionv2/get-the-location-of-subscription-esim"}]},{"group":"Subscription","pages":[{"title":"Get a subscription","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/subscriptions/{xid}","href":"/api-reference/subscription/get-a-subscription"},{"title":"List all subscriptions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/subscriptions","href":"/api-reference/subscription/list-all-subscriptions"},{"title":"Create a subscription","description":"Creates a mobile plan subscription with the given plan.","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/subscriptions","href":"/api-reference/subscription/create-a-subscription"},{"title":"Expire a subscription","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/subscriptions/{id}/expire","href":"/api-reference/subscription/expire-a-subscription"},{"title":"List addon attachments","description":"Lists all the addon attachments of a subscription","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/subscriptions/{id}/addons","href":"/api-reference/subscription/list-addon-attachments"},{"title":"(Topup) Attach an addon to a subscription","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/subscriptions/{id}/addons","href":"/api-reference/subscription/topup-attach-an-addon-to-a-subscription"}]},{"group":"Pricing","pages":[{"title":"List data prices V2","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v2/data-prices","href":"/api-reference/pricing/list-data-prices-v2"},{"title":"(deprecated) List data prices","deprecated":true,"version":null,"openapi":"/openapi.yaml get /v1/data-prices","href":"/api-reference/pricing/deprecated-list-data-prices"},{"title":"(deprecated) Get data prices for a coverage profile","deprecated":true,"version":null,"openapi":"/openapi.yaml get /v1/coverage-profiles/{coverageId}/data-prices","href":"/api-reference/pricing/deprecated-get-data-prices-for-a-coverage-profile"}]},{"group":"Account Balance","pages":[{"title":"List transactions on your account","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/prepaid-balance/transactions","href":"/api-reference/account-balance/list-transactions-on-your-account"},{"title":"Get prepaid balance of your account","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/prepaid-balance","href":"/api-reference/account-balance/get-prepaid-balance-of-your-account"}]},{"group":"CDR Reports","pages":[{"title":"Get CDR reports","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/cdr-reports","href":"/api-reference/cdr-reports/get-cdr-reports"}]}]}]}]},"title":"Expire a subscription - Bondio Help Center","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-26-lDe7V.js","utils-CWQmgYtH.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-4-Aw3rSD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C2zjXYA5.js","snippetPresets-DFmpFA7C.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-FJpQavWq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D_GvPF7k.js","shallow-Bs2ZB0NO.js","getApiPlaygroundDisplay-DCcqJJk-.js","CodeSnippet-DzDxawVe.js","CodeSnippets-aUr7fU-7.js","Page-CT9uE8Ip.js","getPastedJson-Y1fKsj_I.js","icon-DI4zTsDr.js","MethodPill-C0nDlmSQ.js","DuplicateIcon-NUXbx2nQ.js","createIcon-BdTHrPAi.js","DynamicMarkdown-CtpgKJwj.js","SectionHeading-B3x35tOt.js","axios-vUo_bRtp.js","Markdown-3OmurJMP.js","clsx-DMKzROTp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-1ms6tsT-.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ke9xIMFx.js"]}