{"items":[{"type":"link","label":"TelliSIM API v3","link":"/openapi","routeSlug":"/openapi","content":{"contentType":"overview","meta":{"name":"TelliSIM API v3"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"TelliSIM API v3 (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[]}],"sectionId":"/openapi"}],"sectionId":"/openapi"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/api-explanation"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API explanation"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"image","inline":true,"attributes":{"alt":"API explanation diagram","src":"https://cdn.tellisim.com/tellisim-website-images/tellisim-api-docs-diagram.png"},"children":[]}]}]}]}],"sectionId":"/openapi/section/api-explanation"}]}]}},{"type":"link","label":"API explanation","link":"/openapi/section/api-explanation","routeSlug":"/openapi/section/api-explanation","content":null},{"type":"group","label":"Subscriptions","link":"/openapi/subscriptions","routeSlug":"/openapi/subscriptions","items":[{"label":"List Subscriptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/subscriptions/kuy01agj9wxkq-list-subscriptions","routeSlug":"/openapi/subscriptions/kuy01agj9wxkq-list-subscriptions","metadata":{"seo":{"title":"List Subscriptions","description":"This endpoint allows users to retrieve subscription details associated with the SIM service. It provides information about the subscription, including its ID, creation date, associated metadata, and SIM details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"kuy01agj9wxkq-list-subscriptions","name":"List Subscriptions","isWebhook":false,"pointer":"/paths/~1v3~1subscription/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Subscriptions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows users to retrieve subscription details associated with the SIM service. It provides information about the subscription, including its ID, creation date, associated metadata, and SIM details.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"key","description":"Your API key for authentication"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/subscription","servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"key","in":"query"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/v3/subscription","href":"subscriptions/kuy01agj9wxkq-list-subscriptions","openApiOperationId":"kuy01agj9wxkq-list-subscriptions","summary":"List Subscriptions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response containing subscription details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionListResponse"}},"schemaId":"components/schemas/SubscriptionListResponse"},{"code":"401","description":"Unauthorized - API key is missing or invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v3~1subscription/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubscriptionListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionListResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/kuy01agj9wxkq-list-subscriptions"}],"panels":[]}]},"httpPath":"/v3/subscription"},{"label":"Create Subscriptions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/subscriptions/y0553xy7w914c-create-subscriptions","routeSlug":"/openapi/subscriptions/y0553xy7w914c-create-subscriptions","metadata":{"seo":{"title":"Create Subscriptions","description":"This endpoint allows users to create a new subscription for a SIM. By sending a POST request to the specified URL, users can initiate the subscription process with the necessary parameters.The optional active_period field controls when the subscription becomes active and (optionally) when it expires."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"y0553xy7w914c-create-subscriptions","name":"Create Subscriptions","isWebhook":false,"pointer":"/paths/~1v3~1subscription/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Subscriptions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows users to create a new subscription for a SIM. By sending a POST request to the specified URL, users can initiate the subscription process with the necessary parameters."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active_period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field controls when the subscription becomes active and (optionally) when it expires."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"key","description":"Your API key for authentication"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_21","exampleIds":["paths/~1v3~1subscription/post/requestBody/content/application~1json/examples/noActivePeriodProvided","paths/~1v3~1subscription/post/requestBody/content/application~1json/examples/nonRecurringWithActivePeriodStartAndEnd","paths/~1v3~1subscription/post/requestBody/content/application~1json/examples/recurringWithActivePeriodStartOnly"]}},"schemaId":"schema_21","exampleIds":["paths/~1v3~1subscription/post/requestBody/content/application~1json/examples/noActivePeriodProvided","paths/~1v3~1subscription/post/requestBody/content/application~1json/examples/nonRecurringWithActivePeriodStartAndEnd","paths/~1v3~1subscription/post/requestBody/content/application~1json/examples/recurringWithActivePeriodStartOnly"],"pointer":"/paths/~1v3~1subscription/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/subscription","servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"key","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_21","exampleIds":["paths/~1v3~1subscription/post/requestBody/content/application~1json/examples/noActivePeriodProvided","paths/~1v3~1subscription/post/requestBody/content/application~1json/examples/nonRecurringWithActivePeriodStartAndEnd","paths/~1v3~1subscription/post/requestBody/content/application~1json/examples/recurringWithActivePeriodStartOnly"]}},"responseCodes":["201","401","404"],"pointer":"/v3/subscription","href":"subscriptions/y0553xy7w914c-create-subscriptions","openApiOperationId":"y0553xy7w914c-create-subscriptions","summary":"Create Subscriptions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"schemaId":"schema_21","exampleIds":["paths/~1v3~1subscription/post/requestBody/content/application~1json/examples/noActivePeriodProvided","paths/~1v3~1subscription/post/requestBody/content/application~1json/examples/nonRecurringWithActivePeriodStartAndEnd","paths/~1v3~1subscription/post/requestBody/content/application~1json/examples/recurringWithActivePeriodStartOnly"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_21","exampleIds":["paths/~1v3~1subscription/post/requestBody/content/application~1json/examples/noActivePeriodProvided","paths/~1v3~1subscription/post/requestBody/content/application~1json/examples/nonRecurringWithActivePeriodStartAndEnd","paths/~1v3~1subscription/post/requestBody/content/application~1json/examples/recurringWithActivePeriodStartOnly"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Subscription created successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionCreateResponse"}},"schemaId":"components/schemas/SubscriptionCreateResponse"},{"code":"401","description":"Unauthorized - API key is missing or invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"404","description":"No available eSIM found for the specified plan label","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NoAvailableESIMResponse"}},"schemaId":"components/schemas/NoAvailableESIMResponse"}],"pointer":"/paths/~1v3~1subscription/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/SubscriptionCreateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionCreateResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"404","schemaId":"components/schemas/NoAvailableESIMResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NoAvailableESIMResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/y0553xy7w914c-create-subscriptions"}],"panels":[]}]},"httpPath":"/v3/subscription"},{"label":"Get a subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/subscriptions/9r03ycqqjdxez-get-a-subscription","routeSlug":"/openapi/subscriptions/9r03ycqqjdxez-get-a-subscription","metadata":{"seo":{"title":"Get a subscription","description":"This endpoint retrieves the details of a specific subscription associated with an eSIM, identified by its ICCID. It provides information such as the subscription ID, creation date, metadata, and SIM or Physical SIM details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"9r03ycqqjdxez-get-a-subscription","name":"Get a subscription","isWebhook":false,"pointer":"/paths/~1v3~1subscriptions~1{iccid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint retrieves the details of a specific subscription associated with an eSIM, identified by its ICCID. It provides information such as the subscription ID, creation date, metadata, and SIM or Physical SIM details."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"key","description":"Your API key for authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"iccid","in":"path","schemaId":"schema_22","required":true}],"pointer":"/paths/~1v3~1subscriptions~1{iccid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/subscriptions/{iccid}","servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"parameters":{"path":[{"name":"iccid","in":"path","required":true,"schemaId":"schema_22"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"key","in":"query"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/v3/subscriptions/{iccid}","href":"subscriptions/9r03ycqqjdxez-get-a-subscription","openApiOperationId":"9r03ycqqjdxez-get-a-subscription","summary":"Get a subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response containing subscription details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionDetailResponse"}},"schemaId":"components/schemas/SubscriptionDetailResponse"},{"code":"401","description":"Unauthorized - API key is missing or invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v3~1subscriptions~1{iccid}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubscriptionDetailResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionDetailResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/9r03ycqqjdxez-get-a-subscription"}],"panels":[]}]},"httpPath":"/v3/subscriptions/{iccid}"},{"label":"Delete a Subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/subscriptions/r5cdqtky0qde0-delete-a-subscription","routeSlug":"/openapi/subscriptions/r5cdqtky0qde0-delete-a-subscription","metadata":{"seo":{"title":"Delete a Subscription","description":"Deletes the subscription and recycles the ICCID associated with it. The associated ICCID goes back into the customer inventory and will be picked up again automatically in the creation of a new subscription at some point in time in future."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"r5cdqtky0qde0-delete-a-subscription","name":"Delete a Subscription","isWebhook":false,"pointer":"/paths/~1v3~1subscriptions~1{iccid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a Subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes the subscription and recycles the ICCID associated with it. The associated ICCID goes back into the customer inventory and will be picked up again automatically in the creation of a new subscription at some point in time in future."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" this operation will fail if the esim profile associated with the ICCID was ever downloaded by an end-user."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"key","description":"Your API key for authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"iccid","in":"path","schemaId":"schema_22","required":true}],"pointer":"/paths/~1v3~1subscriptions~1{iccid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/subscriptions/{iccid}","servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"parameters":{"path":[{"name":"iccid","in":"path","required":true,"schemaId":"schema_22"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"key","in":"query"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/v3/subscriptions/{iccid}","href":"subscriptions/r5cdqtky0qde0-delete-a-subscription","openApiOperationId":"r5cdqtky0qde0-delete-a-subscription","summary":"Delete a Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Subscription deleted successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteResponse"}},"schemaId":"components/schemas/DeleteResponse"},{"code":"401","description":"Unauthorized - API key is missing or invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"403","description":"The subscription cannot be deleted because the esim profile associated with the ICCID was already downloaded by an end-user.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedDeleteResponse"}},"schemaId":"components/schemas/UnauthorizedDeleteResponse"}],"pointer":"/paths/~1v3~1subscriptions~1{iccid}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DeleteResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DeleteResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"403","schemaId":"components/schemas/UnauthorizedDeleteResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedDeleteResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/r5cdqtky0qde0-delete-a-subscription"}],"panels":[]}]},"httpPath":"/v3/subscriptions/{iccid}"},{"label":"List plan attachments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/subscriptions/urh0yrd5tx486-list-plan-attachments","routeSlug":"/openapi/subscriptions/urh0yrd5tx486-list-plan-attachments","metadata":{"seo":{"title":"List plan attachments","description":"This endpoint retrieves the plan attachments associated with a specific subscription identified by its ICCID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"urh0yrd5tx486-list-plan-attachments","name":"List plan attachments","isWebhook":false,"pointer":"/paths/~1v3~1subscriptions~1{iccid}~1plan-attachments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List plan attachments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves the plan attachments associated with a specific subscription identified by its ICCID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response structure varies based on whether the plan attachments are recurring or non-recurring:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For non-recurring plans: Returns basic plan attachment details with activation_at, expiration_at, used_allowance, and state"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For recurring plans: Returns plan attachment with recurrence metadata and an array of instances, where activation_at, expiration_at, used_allowance, and state may be null at the attachment level"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response may contain a mix of both recurring and non-recurring plan attachments in the same array."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"key","description":"Your API key for authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"iccid","in":"path","schemaId":"schema_22","required":true}],"pointer":"/paths/~1v3~1subscriptions~1{iccid}~1plan-attachments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/subscriptions/{iccid}/plan-attachments","servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"parameters":{"path":[{"name":"iccid","in":"path","required":true,"schemaId":"schema_22"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"key","in":"query"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/v3/subscriptions/{iccid}/plan-attachments","href":"subscriptions/urh0yrd5tx486-list-plan-attachments","openApiOperationId":"urh0yrd5tx486-list-plan-attachments","summary":"List plan attachments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response containing plan attachments (may include both recurring and non-recurring plans)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_23","exampleIds":["paths/~1v3~1subscriptions~1{iccid}~1plan-attachments/get/responses/200/content/application~1json/examples/non-recurring","paths/~1v3~1subscriptions~1{iccid}~1plan-attachments/get/responses/200/content/application~1json/examples/recurring","paths/~1v3~1subscriptions~1{iccid}~1plan-attachments/get/responses/200/content/application~1json/examples/mixed"]}},"schemaId":"schema_23","exampleIds":["paths/~1v3~1subscriptions~1{iccid}~1plan-attachments/get/responses/200/content/application~1json/examples/non-recurring","paths/~1v3~1subscriptions~1{iccid}~1plan-attachments/get/responses/200/content/application~1json/examples/recurring","paths/~1v3~1subscriptions~1{iccid}~1plan-attachments/get/responses/200/content/application~1json/examples/mixed"]},{"code":"401","description":"Unauthorized - API key is missing or invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v3~1subscriptions~1{iccid}~1plan-attachments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_23","exampleIds":["paths/~1v3~1subscriptions~1{iccid}~1plan-attachments/get/responses/200/content/application~1json/examples/non-recurring","paths/~1v3~1subscriptions~1{iccid}~1plan-attachments/get/responses/200/content/application~1json/examples/recurring","paths/~1v3~1subscriptions~1{iccid}~1plan-attachments/get/responses/200/content/application~1json/examples/mixed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_23","exampleIds":["paths/~1v3~1subscriptions~1{iccid}~1plan-attachments/get/responses/200/content/application~1json/examples/non-recurring","paths/~1v3~1subscriptions~1{iccid}~1plan-attachments/get/responses/200/content/application~1json/examples/recurring","paths/~1v3~1subscriptions~1{iccid}~1plan-attachments/get/responses/200/content/application~1json/examples/mixed"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/urh0yrd5tx486-list-plan-attachments"}],"panels":[]}]},"httpPath":"/v3/subscriptions/{iccid}/plan-attachments"},{"label":"Get a plan attachment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/subscriptions/get-plan-attachment-by-id","routeSlug":"/openapi/subscriptions/get-plan-attachment-by-id","metadata":{"seo":{"title":"Get a plan attachment","description":"This endpoint retrieves the details of a specific plan attachment for a subscription."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get-plan-attachment-by-id","name":"Get a plan attachment","isWebhook":false,"pointer":"/paths/~1v3~1subscriptions~1{iccid}~1plan-attachments~1{plan_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a plan attachment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves the details of a specific plan attachment for a subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response structure varies based on whether the plan attachment is recurring or non-recurring:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For non-recurring plans: Returns basic plan attachment details with activation_at, expiration_at, used_allowance, and state"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For recurring plans: Returns plan attachment with recurrence metadata and an array of instances, where activation_at, expiration_at, used_allowance, and state may be null at the attachment level"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"key","description":"Your API key for authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"iccid","in":"path","schemaId":"schema_22","required":true},{"name":"plan_id","in":"path","schemaId":"schema_22","required":true}],"pointer":"/paths/~1v3~1subscriptions~1{iccid}~1plan-attachments~1{plan_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/subscriptions/{iccid}/plan-attachments/{plan_id}","servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"parameters":{"path":[{"name":"iccid","in":"path","required":true,"schemaId":"schema_22"},{"name":"plan_id","in":"path","required":true,"schemaId":"schema_22"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"key","in":"query"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/v3/subscriptions/{iccid}/plan-attachments/{plan_id}","href":"subscriptions/get-plan-attachment-by-id","openApiOperationId":"get-plan-attachment-by-id","summary":"Get a plan attachment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response containing the plan attachment details (may be either recurring or non-recurring)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_24","exampleIds":["paths/~1v3~1subscriptions~1{iccid}~1plan-attachments~1{plan_id}/get/responses/200/content/application~1json/examples/non-recurring","paths/~1v3~1subscriptions~1{iccid}~1plan-attachments~1{plan_id}/get/responses/200/content/application~1json/examples/recurring"]}},"schemaId":"schema_24","exampleIds":["paths/~1v3~1subscriptions~1{iccid}~1plan-attachments~1{plan_id}/get/responses/200/content/application~1json/examples/non-recurring","paths/~1v3~1subscriptions~1{iccid}~1plan-attachments~1{plan_id}/get/responses/200/content/application~1json/examples/recurring"]},{"code":"401","description":"Unauthorized - API key is missing or invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v3~1subscriptions~1{iccid}~1plan-attachments~1{plan_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_24","exampleIds":["paths/~1v3~1subscriptions~1{iccid}~1plan-attachments~1{plan_id}/get/responses/200/content/application~1json/examples/non-recurring","paths/~1v3~1subscriptions~1{iccid}~1plan-attachments~1{plan_id}/get/responses/200/content/application~1json/examples/recurring"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_24","exampleIds":["paths/~1v3~1subscriptions~1{iccid}~1plan-attachments~1{plan_id}/get/responses/200/content/application~1json/examples/non-recurring","paths/~1v3~1subscriptions~1{iccid}~1plan-attachments~1{plan_id}/get/responses/200/content/application~1json/examples/recurring"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/get-plan-attachment-by-id"}],"panels":[]}]},"httpPath":"/v3/subscriptions/{iccid}/plan-attachments/{plan_id}"},{"label":"Suspend a plan attachment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/subscriptions/7vircgwk1k8dm-suspend-a-plan-attachment","routeSlug":"/openapi/subscriptions/7vircgwk1k8dm-suspend-a-plan-attachment","metadata":{"seo":{"title":"Suspend a plan attachment","description":"This operation stops all telco services on this attachment and puts it in a suspended state. This is a non-reversible operation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"7vircgwk1k8dm-suspend-a-plan-attachment","name":"Suspend a plan attachment","isWebhook":false,"pointer":"/paths/~1v3~1subscriptions~1{iccid}~1plan-attachments~1{id}~1suspend/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Suspend a plan attachment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This operation stops all telco services on this attachment and puts it in a suspended state. This is a non-reversible operation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"key","description":"Your API key for authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"iccid","in":"path","schemaId":"schema_22","required":true},{"name":"id","in":"path","schemaId":"schema_22","required":true}],"pointer":"/paths/~1v3~1subscriptions~1{iccid}~1plan-attachments~1{id}~1suspend/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/subscriptions/{iccid}/plan-attachments/{id}/suspend","servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"parameters":{"path":[{"name":"iccid","in":"path","required":true,"schemaId":"schema_22"},{"name":"id","in":"path","required":true,"schemaId":"schema_22"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"key","in":"query"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/v3/subscriptions/{iccid}/plan-attachments/{id}/suspend","href":"subscriptions/7vircgwk1k8dm-suspend-a-plan-attachment","openApiOperationId":"7vircgwk1k8dm-suspend-a-plan-attachment","summary":"Suspend a plan attachment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Plan attachment suspended successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SuspendResponse"}},"schemaId":"components/schemas/SuspendResponse"},{"code":"401","description":"Unauthorized - API key is missing or invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v3~1subscriptions~1{iccid}~1plan-attachments~1{id}~1suspend/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SuspendResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SuspendResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/7vircgwk1k8dm-suspend-a-plan-attachment"}],"panels":[]}]},"httpPath":"/v3/subscriptions/{iccid}/plan-attachments/{id}/suspend"},{"label":"Send sms","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/subscriptions/8znze4vr6c4v9-send-sms","routeSlug":"/openapi/subscriptions/8znze4vr6c4v9-send-sms","metadata":{"seo":{"title":"Send sms","description":"This endpoint allows you to send an SMS message to a specified eSIM subscription identified by its ICCID. The request requires an API key for authentication and includes parameters for the sender's name and the message content."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"8znze4vr6c4v9-send-sms","name":"Send sms","isWebhook":false,"pointer":"/paths/~1v3~1subscriptions~1{iccid}~1send-sms/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send sms","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows you to send an SMS message to a specified eSIM subscription identified by its ICCID. The request requires an API key for authentication and includes parameters for the sender's name and the message content."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"key","description":"Your API key for authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"iccid","in":"path","schemaId":"schema_22","required":true}],"pointer":"/paths/~1v3~1subscriptions~1{iccid}~1send-sms/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_25"}},"schemaId":"schema_25","pointer":"/paths/~1v3~1subscriptions~1{iccid}~1send-sms/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/subscriptions/{iccid}/send-sms","servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"parameters":{"path":[{"name":"iccid","in":"path","required":true,"schemaId":"schema_22"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"key","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_25"}},"responseCodes":["200","401","502"],"pointer":"/v3/subscriptions/{iccid}/send-sms","href":"subscriptions/8znze4vr6c4v9-send-sms","openApiOperationId":"8znze4vr6c4v9-send-sms","summary":"Send sms"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"schemaId":"schema_25","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_25"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"SMS sent successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SMSResponse"}},"schemaId":"components/schemas/SMSResponse"},{"code":"401","description":"Unauthorized - API key is missing or invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"502","description":"Bad Gateway - Error sending SMS","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SendSMSBadGatewayResponse"}},"schemaId":"components/schemas/SendSMSBadGatewayResponse"}],"pointer":"/paths/~1v3~1subscriptions~1{iccid}~1send-sms/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SMSResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SMSResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"502","schemaId":"components/schemas/SendSMSBadGatewayResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SendSMSBadGatewayResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/8znze4vr6c4v9-send-sms"}],"panels":[]}]},"httpPath":"/v3/subscriptions/{iccid}/send-sms"},{"label":"Get subscription location","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/subscriptions/03nzews3r6c4v9-get-subscription-location","routeSlug":"/openapi/subscriptions/03nzews3r6c4v9-get-subscription-location","metadata":{"seo":{"title":"Get subscription location","description":"This endpoint retrieves the location information of a specific subscription associated with an eSIM, identified by its ICCID.It provides information about the last operator the SIM was connected to, including country, operator name, and technical details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"03nzews3r6c4v9-get-subscription-location","name":"Get subscription location","isWebhook":false,"pointer":"/paths/~1v3~1subscriptions~1{iccid}~1location/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get subscription location","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves the location information of a specific subscription associated with an eSIM, identified by its ICCID."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It provides information about the last operator the SIM was connected to, including country, operator name, and technical details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This endpoint only returns data if the SIM has been active in the last 7 days. If the SIM has not been active during this period, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_operator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field will be null."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"key","description":"Your API key for authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"iccid","in":"path","schemaId":"schema_22","description":"The ICCID of the subscription","required":true,"example":"8937204017179541233"}],"pointer":"/paths/~1v3~1subscriptions~1{iccid}~1location/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/subscriptions/{iccid}/location","servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"parameters":{"path":[{"name":"iccid","in":"path","required":true,"example":"8937204017179541233","schemaId":"schema_22"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"key","in":"query"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/v3/subscriptions/{iccid}/location","href":"subscriptions/03nzews3r6c4v9-get-subscription-location","openApiOperationId":"03nzews3r6c4v9-get-subscription-location","summary":"Get subscription location"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response containing location information","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionLocationResponse","exampleIds":["paths/~1v3~1subscriptions~1{iccid}~1location/get/responses/200/content/application~1json/examples/successful_response","paths/~1v3~1subscriptions~1{iccid}~1location/get/responses/200/content/application~1json/examples/no_recent_activity"]}},"schemaId":"components/schemas/SubscriptionLocationResponse","exampleIds":["paths/~1v3~1subscriptions~1{iccid}~1location/get/responses/200/content/application~1json/examples/successful_response","paths/~1v3~1subscriptions~1{iccid}~1location/get/responses/200/content/application~1json/examples/no_recent_activity"]},{"code":"401","description":"Unauthorized - API key is missing or invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v3~1subscriptions~1{iccid}~1location/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubscriptionLocationResponse","exampleIds":["paths/~1v3~1subscriptions~1{iccid}~1location/get/responses/200/content/application~1json/examples/successful_response","paths/~1v3~1subscriptions~1{iccid}~1location/get/responses/200/content/application~1json/examples/no_recent_activity"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionLocationResponse","exampleIds":["paths/~1v3~1subscriptions~1{iccid}~1location/get/responses/200/content/application~1json/examples/successful_response","paths/~1v3~1subscriptions~1{iccid}~1location/get/responses/200/content/application~1json/examples/no_recent_activity"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/03nzews3r6c4v9-get-subscription-location"}],"panels":[]}]},"httpPath":"/v3/subscriptions/{iccid}/location"},{"label":"Get subscriber Geo-location","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/subscriptions/1jgedfw32323dd-get-subscriber-geo-location","routeSlug":"/openapi/subscriptions/1jgedfw32323dd-get-subscriber-geo-location","metadata":{"seo":{"title":"Get subscriber Geo-location","description":"This endpoint retrieves the geographic location data for a specific subscription identified by its ICCID.It provides the latitude, longitude, accuracy, and timestamp of the subscriber's last known location."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"1jgedfw32323dd-get-subscriber-geo-location","name":"Get subscriber Geo-location","isWebhook":false,"pointer":"/paths/~1v3~1subscriptions~1{iccid}~1geo-location/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get subscriber Geo-location","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves the geographic location data for a specific subscription identified by its ICCID."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It provides the latitude, longitude, accuracy, and timestamp of the subscriber's last known location."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important notes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This feature has limited availability and is not supported for all labels"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Location data may be unavailable if the eSIM has not yet been activated or has no usage history"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Even when usage exists, location information may not be available if it was not captured by the system"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response includes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Latitude and Longitude"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Geographic coordinates of the last known position"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accuracy"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The estimated median error in meters, representing the radius of a circle with 50% confidence level"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and Time"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Timestamp (UTC+0) indicating when the subscriber was last detected by the system"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"key","description":"Your API key for authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"iccid","in":"path","schemaId":"schema_22","description":"The ICCID of the subscription","required":true,"example":"8948010000094659307"}],"pointer":"/paths/~1v3~1subscriptions~1{iccid}~1geo-location/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/subscriptions/{iccid}/geo-location","servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"parameters":{"path":[{"name":"iccid","in":"path","required":true,"example":"8948010000094659307","schemaId":"schema_22"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"key","in":"query"}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/v3/subscriptions/{iccid}/geo-location","href":"subscriptions/1jgedfw32323dd-get-subscriber-geo-location","openApiOperationId":"1jgedfw32323dd-get-subscriber-geo-location","summary":"Get subscriber Geo-location"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionGeoLocationResponse","exampleIds":["paths/~1v3~1subscriptions~1{iccid}~1geo-location/get/responses/200/content/application~1json/examples/location_available","paths/~1v3~1subscriptions~1{iccid}~1geo-location/get/responses/200/content/application~1json/examples/location_unavailable"]}},"schemaId":"components/schemas/SubscriptionGeoLocationResponse","exampleIds":["paths/~1v3~1subscriptions~1{iccid}~1geo-location/get/responses/200/content/application~1json/examples/location_available","paths/~1v3~1subscriptions~1{iccid}~1geo-location/get/responses/200/content/application~1json/examples/location_unavailable"]},{"code":"400","description":"Bad Request - Feature not available for this label","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26"}},"schemaId":"schema_26"},{"code":"401","description":"Unauthorized - API key is missing or invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"404","description":"Not Found - Subscription not found for the provided ICCID","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_27"}},"schemaId":"schema_27"}],"pointer":"/paths/~1v3~1subscriptions~1{iccid}~1geo-location/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubscriptionGeoLocationResponse","exampleIds":["paths/~1v3~1subscriptions~1{iccid}~1geo-location/get/responses/200/content/application~1json/examples/location_available","paths/~1v3~1subscriptions~1{iccid}~1geo-location/get/responses/200/content/application~1json/examples/location_unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionGeoLocationResponse","exampleIds":["paths/~1v3~1subscriptions~1{iccid}~1geo-location/get/responses/200/content/application~1json/examples/location_available","paths/~1v3~1subscriptions~1{iccid}~1geo-location/get/responses/200/content/application~1json/examples/location_unavailable"]}}},{"code":"400","schemaId":"schema_26","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"404","schemaId":"schema_27","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_27"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/1jgedfw32323dd-get-subscriber-geo-location"}],"panels":[]}]},"httpPath":"/v3/subscriptions/{iccid}/geo-location"},{"label":"Get usage over period","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/subscriptions/fwapp44dmnss-get-subscription-usage-over-period","routeSlug":"/openapi/subscriptions/fwapp44dmnss-get-subscription-usage-over-period","metadata":{"seo":{"title":"Get usage over period","description":"This endpoint retrieves detailed usage data for a specific subscription identified by its ICCID over a specified time period."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"fwapp44dmnss-get-subscription-usage-over-period","name":"Get usage over period","isWebhook":false,"pointer":"/paths/~1v3~1subscriptions~1{iccid}~1usage-over-period/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get usage over period","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves detailed usage data for a specific subscription identified by its ICCID over a specified time period."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important constraints:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum period is 7 days, including both the start and end dates"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The start date must come before the end date"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests that violate these constraints will be rejected"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response includes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total usage aggregated across the entire period"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Daily breakdown of usage with country-level details"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country-level aggregation for the entire period"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"key","description":"Your API key for authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"iccid","in":"path","schemaId":"schema_22","description":"The ICCID of the subscription","required":true,"example":"8948010000094659307"}],"pointer":"/paths/~1v3~1subscriptions~1{iccid}~1usage-over-period/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UsageOverPeriodRequest","exampleIds":["paths/~1v3~1subscriptions~1{iccid}~1usage-over-period/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/UsageOverPeriodRequest","exampleIds":["paths/~1v3~1subscriptions~1{iccid}~1usage-over-period/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v3~1subscriptions~1{iccid}~1usage-over-period/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/subscriptions/{iccid}/usage-over-period","servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"parameters":{"path":[{"name":"iccid","in":"path","required":true,"example":"8948010000094659307","schemaId":"schema_22"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"key","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UsageOverPeriodRequest","exampleIds":["paths/~1v3~1subscriptions~1{iccid}~1usage-over-period/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401"],"pointer":"/v3/subscriptions/{iccid}/usage-over-period","href":"subscriptions/fwapp44dmnss-get-subscription-usage-over-period","openApiOperationId":"fwapp44dmnss-get-subscription-usage-over-period","summary":"Get usage over period"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"schemaId":"components/schemas/UsageOverPeriodRequest","exampleIds":["paths/~1v3~1subscriptions~1{iccid}~1usage-over-period/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UsageOverPeriodRequest","exampleIds":["paths/~1v3~1subscriptions~1{iccid}~1usage-over-period/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response containing usage data for the specified period","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UsageOverPeriodResponse","exampleIds":["paths/~1v3~1subscriptions~1{iccid}~1usage-over-period/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/UsageOverPeriodResponse","exampleIds":["paths/~1v3~1subscriptions~1{iccid}~1usage-over-period/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request - Invalid period (exceeds 7 days or start date is after end date)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_28"}},"schemaId":"schema_28"},{"code":"401","description":"Unauthorized - API key is missing or invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v3~1subscriptions~1{iccid}~1usage-over-period/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UsageOverPeriodResponse","exampleIds":["paths/~1v3~1subscriptions~1{iccid}~1usage-over-period/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UsageOverPeriodResponse","exampleIds":["paths/~1v3~1subscriptions~1{iccid}~1usage-over-period/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_28","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_28"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/fwapp44dmnss-get-subscription-usage-over-period"}],"panels":[]}]},"httpPath":"/v3/subscriptions/{iccid}/usage-over-period"},{"label":"Get network events","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/subscriptions/k29fmzq81plq-get-subscription-network-events","routeSlug":"/openapi/subscriptions/k29fmzq81plq-get-subscription-network-events","metadata":{"seo":{"title":"Get network events","description":"This endpoint retrieves network attach and data session events for a specific subscriptionidentified by its ICCID over a specified time period."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"k29fmzq81plq-get-subscription-network-events","name":"Get network events","isWebhook":false,"pointer":"/paths/~1v3~1subscriptions~1{iccid}~1network-events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get network events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves network attach and data session events for a specific subscription"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"identified by its ICCID over a specified time period."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important constraints:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum period is 7 days, including both the start and end dates"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The start date must come before the end date"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests that violate these constraints will be rejected"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response includes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2g_or_3g_attach"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": network attach events for 2G/3G connections"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"4g_or_5g_attach"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": network attach events for 4G/5G connections"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_usage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": data session events (Init/Update/Term)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"subscriptions/k29fmzq81plq-get-subscription-network-events/request/debugging-esim-installationconnectivity-issues","deepLinkHash":"/subscriptions/k29fmzq81plq-get-subscription-network-events#subscriptions/k29fmzq81plq-get-subscription-network-events/request/debugging-esim-installationconnectivity-issues"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Debugging eSIM installation/connectivity issues"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a user is unable to use their eSIM, use this endpoint to narrow down where the failure occurred:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure to attach to network"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - First check the events under "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2g_or_3g_attach"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"4g_or_5g_attach"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", depending on which network the eSIM is connecting to, to see whether it was"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"able to attach:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2g_or_3g_attach"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"result"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"ok\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the attach succeeded."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"4g_or_5g_attach"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"oper_allowed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the attach succeeded."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure to use data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - If the eSIM successfully attached to the network, check the events"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"under "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data_usage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"result"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"success\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the eSIM was able to use data; otherwise the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data session failed."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"key","description":"Your API key for authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"iccid","in":"path","schemaId":"schema_22","description":"The ICCID of the subscription","required":true,"example":"8948010000094659307"}],"pointer":"/paths/~1v3~1subscriptions~1{iccid}~1network-events/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NetworkEventsRequest","exampleIds":["paths/~1v3~1subscriptions~1{iccid}~1network-events/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/NetworkEventsRequest","exampleIds":["paths/~1v3~1subscriptions~1{iccid}~1network-events/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1v3~1subscriptions~1{iccid}~1network-events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/subscriptions/{iccid}/network-events","servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"parameters":{"path":[{"name":"iccid","in":"path","required":true,"example":"8948010000094659307","schemaId":"schema_22"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"key","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/NetworkEventsRequest","exampleIds":["paths/~1v3~1subscriptions~1{iccid}~1network-events/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","404"],"pointer":"/v3/subscriptions/{iccid}/network-events","href":"subscriptions/k29fmzq81plq-get-subscription-network-events","openApiOperationId":"k29fmzq81plq-get-subscription-network-events","summary":"Get network events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"schemaId":"components/schemas/NetworkEventsRequest","exampleIds":["paths/~1v3~1subscriptions~1{iccid}~1network-events/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NetworkEventsRequest","exampleIds":["paths/~1v3~1subscriptions~1{iccid}~1network-events/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response containing network events for the specified period","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NetworkEventsResponse","exampleIds":["paths/~1v3~1subscriptions~1{iccid}~1network-events/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/NetworkEventsResponse","exampleIds":["paths/~1v3~1subscriptions~1{iccid}~1network-events/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Bad Request - Invalid period (exceeds 7 days) or missing required fields","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_29","exampleIds":["paths/~1v3~1subscriptions~1{iccid}~1network-events/post/responses/400/content/application~1json/examples/period_exceeds_7_days","paths/~1v3~1subscriptions~1{iccid}~1network-events/post/responses/400/content/application~1json/examples/missing_required_field"]}},"schemaId":"schema_29","exampleIds":["paths/~1v3~1subscriptions~1{iccid}~1network-events/post/responses/400/content/application~1json/examples/period_exceeds_7_days","paths/~1v3~1subscriptions~1{iccid}~1network-events/post/responses/400/content/application~1json/examples/missing_required_field"]},{"code":"401","description":"Unauthorized - API key is missing or invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"404","description":"Not Found - Subscription not found for the provided ICCID","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_27"}},"schemaId":"schema_27"}],"pointer":"/paths/~1v3~1subscriptions~1{iccid}~1network-events/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/NetworkEventsResponse","exampleIds":["paths/~1v3~1subscriptions~1{iccid}~1network-events/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NetworkEventsResponse","exampleIds":["paths/~1v3~1subscriptions~1{iccid}~1network-events/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_29","exampleIds":["paths/~1v3~1subscriptions~1{iccid}~1network-events/post/responses/400/content/application~1json/examples/period_exceeds_7_days","paths/~1v3~1subscriptions~1{iccid}~1network-events/post/responses/400/content/application~1json/examples/missing_required_field"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_29","exampleIds":["paths/~1v3~1subscriptions~1{iccid}~1network-events/post/responses/400/content/application~1json/examples/period_exceeds_7_days","paths/~1v3~1subscriptions~1{iccid}~1network-events/post/responses/400/content/application~1json/examples/missing_required_field"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"404","schemaId":"schema_27","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_27"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/k29fmzq81plq-get-subscription-network-events"}],"panels":[]}]},"httpPath":"/v3/subscriptions/{iccid}/network-events"}],"content":{"contentType":"group","meta":{"name":"Subscriptions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscriptions","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to subscriptions."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/subscription","summary":"List Subscriptions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions/kuy01agj9wxkq-list-subscriptions","deprecated":false},{"title":"/v3/subscription","summary":"Create Subscriptions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subscriptions/y0553xy7w914c-create-subscriptions","deprecated":false},{"title":"/v3/subscriptions/{iccid}","summary":"Get a subscription","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions/9r03ycqqjdxez-get-a-subscription","deprecated":false},{"title":"/v3/subscriptions/{iccid}","summary":"Delete a Subscription","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/subscriptions/r5cdqtky0qde0-delete-a-subscription","deprecated":false},{"title":"/v3/subscriptions/{iccid}/plan-attachments","summary":"List plan attachments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions/urh0yrd5tx486-list-plan-attachments","deprecated":false},{"title":"/v3/subscriptions/{iccid}/plan-attachments/{plan_id}","summary":"Get a plan attachment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions/get-plan-attachment-by-id","deprecated":false},{"title":"/v3/subscriptions/{iccid}/plan-attachments/{id}/suspend","summary":"Suspend a plan attachment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subscriptions/7vircgwk1k8dm-suspend-a-plan-attachment","deprecated":false},{"title":"/v3/subscriptions/{iccid}/send-sms","summary":"Send sms","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subscriptions/8znze4vr6c4v9-send-sms","deprecated":false},{"title":"/v3/subscriptions/{iccid}/location","summary":"Get subscription location","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions/03nzews3r6c4v9-get-subscription-location","deprecated":false},{"title":"/v3/subscriptions/{iccid}/geo-location","summary":"Get subscriber Geo-location","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions/1jgedfw32323dd-get-subscriber-geo-location","deprecated":false},{"title":"/v3/subscriptions/{iccid}/usage-over-period","summary":"Get usage over period","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subscriptions/fwapp44dmnss-get-subscription-usage-over-period","deprecated":false},{"title":"/v3/subscriptions/{iccid}/network-events","summary":"Get network events","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subscriptions/k29fmzq81plq-get-subscription-network-events","deprecated":false}]}]}]}]}},{"type":"group","label":"Plans","link":"/openapi/plans","routeSlug":"/openapi/plans","items":[{"label":"List plans","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/plans/roe63e3fhdeh5-list-plans","routeSlug":"/openapi/plans/roe63e3fhdeh5-list-plans","metadata":{"seo":{"title":"List plans","description":"This endpoint retrieves a list of available plans. It allows users to specify pagination and filter out archived plans."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"roe63e3fhdeh5-list-plans","name":"List plans","isWebhook":false,"pointer":"/paths/~1v3~1plans/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List plans","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint retrieves a list of available plans. It allows users to specify pagination and filter out archived plans."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"key","description":"Your API key for authentication"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"archived","in":"query","schemaId":"schema_30","description":"When true, only archived plans are returned. When false, only non archived plans are returned. When absent all are returned."},{"name":"page_size","in":"query","schemaId":"schema_31","description":"Number of items to be returned in a single page"},{"name":"page","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call."},"children":[]}]}]}]},{"name":"label","in":"query","schemaId":"schema_32","description":"Filter plans by label. Allowed values are Green, Aqua, Blue, Voilet, Red, Grey, Orange"},{"name":"search_query","in":"query","schemaId":"schema_22","description":"Query to search the plans by name"},{"name":"country_iso_2","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated list of countryIso2 e.g. countryIso2=FR,IN"},"children":[]}]}]}]}],"pointer":"/paths/~1v3~1plans/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/plans","servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"archived","in":"query","schemaId":"schema_30"},{"name":"page_size","in":"query","schemaId":"schema_31"},{"name":"page","in":"query","schemaId":"schema_22"},{"name":"label","in":"query","schemaId":"components/schemas/Label"},{"name":"search_query","in":"query","schemaId":"schema_22"},{"name":"country_iso_2","in":"query","schemaId":"schema_22"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"key","in":"query"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/v3/plans","href":"plans/roe63e3fhdeh5-list-plans","openApiOperationId":"roe63e3fhdeh5-list-plans","summary":"List plans"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response containing a list of plans. The optional fields are returned for labels on which throttling or recurring is enabled.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlanListResponse"}},"schemaId":"components/schemas/PlanListResponse"},{"code":"401","description":"Unauthorized - API key is missing or invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v3~1plans/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PlanListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlanListResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/plans/roe63e3fhdeh5-list-plans"}],"panels":[]}]},"httpPath":"/v3/plans"},{"label":"Create Plans","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/plans/rsq2cu2wtponb-create-plans","routeSlug":"/openapi/plans/rsq2cu2wtponb-create-plans","metadata":{"seo":{"title":"Create Plans","description":"Creates a plan with the given configuration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"rsq2cu2wtponb-create-plans","name":"Create Plans","isWebhook":false,"pointer":"/paths/~1v3~1plans/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Plans","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates a plan with the given configuration."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"key","description":"Your API key for authentication"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_33","exampleIds":["paths/~1v3~1plans/post/requestBody/content/application~1json/examples/default","paths/~1v3~1plans/post/requestBody/content/application~1json/examples/minimal","paths/~1v3~1plans/post/requestBody/content/application~1json/examples/throttling_only","paths/~1v3~1plans/post/requestBody/content/application~1json/examples/recurring_only"]}},"schemaId":"schema_33","exampleIds":["paths/~1v3~1plans/post/requestBody/content/application~1json/examples/default","paths/~1v3~1plans/post/requestBody/content/application~1json/examples/minimal","paths/~1v3~1plans/post/requestBody/content/application~1json/examples/throttling_only","paths/~1v3~1plans/post/requestBody/content/application~1json/examples/recurring_only"],"pointer":"/paths/~1v3~1plans/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/plans","servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"key","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_33","exampleIds":["paths/~1v3~1plans/post/requestBody/content/application~1json/examples/default","paths/~1v3~1plans/post/requestBody/content/application~1json/examples/minimal","paths/~1v3~1plans/post/requestBody/content/application~1json/examples/throttling_only","paths/~1v3~1plans/post/requestBody/content/application~1json/examples/recurring_only"]}},"responseCodes":["201","401"],"pointer":"/v3/plans","href":"plans/rsq2cu2wtponb-create-plans","openApiOperationId":"rsq2cu2wtponb-create-plans","summary":"Create Plans"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"schemaId":"schema_33","exampleIds":["paths/~1v3~1plans/post/requestBody/content/application~1json/examples/default","paths/~1v3~1plans/post/requestBody/content/application~1json/examples/minimal","paths/~1v3~1plans/post/requestBody/content/application~1json/examples/throttling_only","paths/~1v3~1plans/post/requestBody/content/application~1json/examples/recurring_only"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_33","exampleIds":["paths/~1v3~1plans/post/requestBody/content/application~1json/examples/default","paths/~1v3~1plans/post/requestBody/content/application~1json/examples/minimal","paths/~1v3~1plans/post/requestBody/content/application~1json/examples/throttling_only","paths/~1v3~1plans/post/requestBody/content/application~1json/examples/recurring_only"]}},"examples":[{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Plan created successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlanCreateResponse"}},"schemaId":"components/schemas/PlanCreateResponse"},{"code":"401","description":"Unauthorized - API key is missing or invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v3~1plans/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/PlanCreateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlanCreateResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/plans/rsq2cu2wtponb-create-plans"}],"panels":[]}]},"httpPath":"/v3/plans"},{"label":"Get a Plan","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/plans/8p6b2qv85fzoj-get-a-plan","routeSlug":"/openapi/plans/8p6b2qv85fzoj-get-a-plan","metadata":{"seo":{"title":"Get a Plan","description":"Retrieves the details of an existing plan by its ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"8p6b2qv85fzoj-get-a-plan","name":"Get a Plan","isWebhook":false,"pointer":"/paths/~1v3~1plans~1{planId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a Plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the details of an existing plan by its ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"key","description":"Your API key for authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"planId","in":"path","schemaId":"schema_22","required":true}],"pointer":"/paths/~1v3~1plans~1{planId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/plans/{planId}","servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"parameters":{"path":[{"name":"planId","in":"path","required":true,"schemaId":"schema_22"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"key","in":"query"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/v3/plans/{planId}","href":"plans/8p6b2qv85fzoj-get-a-plan","openApiOperationId":"8p6b2qv85fzoj-get-a-plan","summary":"Get a Plan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response containing plan details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlanDetailResponse"}},"schemaId":"components/schemas/PlanDetailResponse"},{"code":"401","description":"Unauthorized - API key is missing or invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v3~1plans~1{planId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PlanDetailResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlanDetailResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/plans/8p6b2qv85fzoj-get-a-plan"}],"panels":[]}]},"httpPath":"/v3/plans/{planId}"},{"label":"Delete a Plan","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/plans/delete-a-plan","routeSlug":"/openapi/plans/delete-a-plan","metadata":{"seo":{"title":"Delete a Plan","description":"Deletes plan with the given id. Deleting a plan won't impact the existing and historic attachments for this plan. They will continue to work as expected."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delete-a-plan","name":"Delete a Plan","isWebhook":false,"pointer":"/paths/~1v3~1plans~1{planId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a Plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes plan with the given id. Deleting a plan won't impact the existing and historic attachments for this plan. They will continue to work as expected."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"key","description":"Your API key for authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"planId","in":"path","schemaId":"schema_34","required":true}],"pointer":"/paths/~1v3~1plans~1{planId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v3/plans/{planId}","servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"parameters":{"path":[{"name":"planId","in":"path","required":true,"schemaId":"schema_34"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"key","in":"query"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/v3/plans/{planId}","href":"plans/delete-a-plan","openApiOperationId":"delete-a-plan","summary":"Delete a Plan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The plan was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlanDeleteSuccessResponse"}},"schemaId":"components/schemas/PlanDeleteSuccessResponse"},{"code":"401","description":"Unauthorized request due to missing or invalid API key.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedDeleteResponse"}},"schemaId":"components/schemas/UnauthorizedDeleteResponse"}],"pointer":"/paths/~1v3~1plans~1{planId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PlanDeleteSuccessResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlanDeleteSuccessResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedDeleteResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedDeleteResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/plans/delete-a-plan"}],"panels":[]}]},"httpPath":"/v3/plans/{planId}"},{"label":"Archive a plan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/plans/2vx77nutyy4a1-archive-a-plan","routeSlug":"/openapi/plans/2vx77nutyy4a1-archive-a-plan","metadata":{"seo":{"title":"Archive a plan","description":"This endpoint allows you to archive a specific plan identified by its planId. Archiving a plan may be necessary for managing your plans effectively, especially when they are no longer active or needed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"2vx77nutyy4a1-archive-a-plan","name":"Archive a plan","isWebhook":false,"pointer":"/paths/~1v3~1plans~1{planId}~1archive/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Archive a plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to archive a specific plan identified by its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"planId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Archiving a plan may be necessary for managing your plans effectively, especially when they are no longer active or needed."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"key","description":"Your API key for authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"planId","in":"path","schemaId":"schema_22","required":true}],"pointer":"/paths/~1v3~1plans~1{planId}~1archive/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/plans/{planId}/archive","servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"parameters":{"path":[{"name":"planId","in":"path","required":true,"schemaId":"schema_22"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"key","in":"query"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/v3/plans/{planId}/archive","href":"plans/2vx77nutyy4a1-archive-a-plan","openApiOperationId":"2vx77nutyy4a1-archive-a-plan","summary":"Archive a plan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Plan archived successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ArchiveResponse"}},"schemaId":"components/schemas/ArchiveResponse"},{"code":"401","description":"Unauthorized - API key is missing or invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v3~1plans~1{planId}~1archive/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ArchiveResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ArchiveResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/plans/2vx77nutyy4a1-archive-a-plan"}],"panels":[]}]},"httpPath":"/v3/plans/{planId}/archive"},{"label":"Unarchive a plan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/plans/3pax3wmtx0ckv-unarchive-a-plan","routeSlug":"/openapi/plans/3pax3wmtx0ckv-unarchive-a-plan","metadata":{"seo":{"title":"Unarchive a plan","description":"This endpoint allows you to unarchive a specific plan identified by its planId. When a plan is unarchived, it is restored to an active state, making it available for use again."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"3pax3wmtx0ckv-unarchive-a-plan","name":"Unarchive a plan","isWebhook":false,"pointer":"/paths/~1v3~1plans~1{planId}~1unarchive/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unarchive a plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to unarchive a specific plan identified by its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"planId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When a plan is unarchived, it is restored to an active state, making it available for use again."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"key","description":"Your API key for authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"planId","in":"path","schemaId":"schema_22","required":true}],"pointer":"/paths/~1v3~1plans~1{planId}~1unarchive/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/plans/{planId}/unarchive","servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"parameters":{"path":[{"name":"planId","in":"path","required":true,"schemaId":"schema_22"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"key","in":"query"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/v3/plans/{planId}/unarchive","href":"plans/3pax3wmtx0ckv-unarchive-a-plan","openApiOperationId":"3pax3wmtx0ckv-unarchive-a-plan","summary":"Unarchive a plan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Plan unarchived successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnArchiveResponse"}},"schemaId":"components/schemas/UnArchiveResponse"},{"code":"401","description":"Unauthorized - API key is missing or invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v3~1plans~1{planId}~1unarchive/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UnArchiveResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnArchiveResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/plans/3pax3wmtx0ckv-unarchive-a-plan"}],"panels":[]}]},"httpPath":"/v3/plans/{planId}/unarchive"}],"content":{"contentType":"group","meta":{"name":"Plans"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Plans","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to plans."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/plans","summary":"List plans","prefix":{"name":"get","color":"get"},"badges":[],"link":"/plans/roe63e3fhdeh5-list-plans","deprecated":false},{"title":"/v3/plans","summary":"Create Plans","prefix":{"name":"post","color":"post"},"badges":[],"link":"/plans/rsq2cu2wtponb-create-plans","deprecated":false},{"title":"/v3/plans/{planId}","summary":"Get a Plan","prefix":{"name":"get","color":"get"},"badges":[],"link":"/plans/8p6b2qv85fzoj-get-a-plan","deprecated":false},{"title":"/v3/plans/{planId}","summary":"Delete a Plan","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/plans/delete-a-plan","deprecated":false},{"title":"/v3/plans/{planId}/archive","summary":"Archive a plan","prefix":{"name":"post","color":"post"},"badges":[],"link":"/plans/2vx77nutyy4a1-archive-a-plan","deprecated":false},{"title":"/v3/plans/{planId}/unarchive","summary":"Unarchive a plan","prefix":{"name":"post","color":"post"},"badges":[],"link":"/plans/3pax3wmtx0ckv-unarchive-a-plan","deprecated":false}]}]}]}]}},{"type":"group","label":"Coverage","link":"/openapi/coverage","routeSlug":"/openapi/coverage","items":[{"label":"List coverage profiles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/coverage/xwappasg4mnsd-list-coverage-profiles","routeSlug":"/openapi/coverage/xwappasg4mnsd-list-coverage-profiles","metadata":{"seo":{"title":"List coverage profiles","description":"Returns the list of coverage profiles available to your account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"xwappasg4mnsd-list-coverage-profiles","name":"List coverage profiles","isWebhook":false,"pointer":"/paths/~1v3~1coverage-profiles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List coverage profiles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the list of coverage profiles available to your account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"key","description":"Your API key for authentication"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"region_code","in":"query","schemaId":"schema_22","example":"US"},{"name":"label","in":"query","schemaId":"schema_22","example":"Green"}],"pointer":"/paths/~1v3~1coverage-profiles/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/coverage-profiles","servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"region_code","in":"query","required":false,"example":"US","schemaId":"schema_22"},{"name":"label","in":"query","required":false,"example":"Green","schemaId":"schema_22"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"key","in":"query"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/v3/coverage-profiles","href":"coverage/xwappasg4mnsd-list-coverage-profiles","openApiOperationId":"xwappasg4mnsd-list-coverage-profiles","summary":"List coverage profiles"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response containing coverage profiles","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCoverageProfile"}},"schemaId":"components/schemas/ListCoverageProfile"},{"code":"401","description":"Unauthorized - API key is missing or invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v3~1coverage-profiles/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCoverageProfile","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCoverageProfile"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coverage/xwappasg4mnsd-list-coverage-profiles"}],"panels":[]}]},"httpPath":"/v3/coverage-profiles"},{"label":"Get the coverage profile","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/coverage/fltojr54olllm-get-the-coverage-profile","routeSlug":"/openapi/coverage/fltojr54olllm-get-the-coverage-profile","metadata":{"seo":{"title":"Get the coverage profile","description":"Retrieves the coverage profile"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"fltojr54olllm-get-the-coverage-profile","name":"Get the coverage profile","isWebhook":false,"pointer":"/paths/~1v3~1coverage-profiles~1{coverageId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the coverage profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the coverage profile"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"key","description":"Your API key for authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"coverageId","in":"path","schemaId":"schema_22","required":true}],"pointer":"/paths/~1v3~1coverage-profiles~1{coverageId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/coverage-profiles/{coverageId}","servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"parameters":{"path":[{"name":"coverageId","in":"path","required":true,"schemaId":"schema_22"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"key","in":"query"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/v3/coverage-profiles/{coverageId}","href":"coverage/fltojr54olllm-get-the-coverage-profile","openApiOperationId":"fltojr54olllm-get-the-coverage-profile","summary":"Get the coverage profile"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response containing coverage profile details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CoverageProfileDetailResponse"}},"schemaId":"components/schemas/CoverageProfileDetailResponse"},{"code":"401","description":"Unauthorized - API key is missing or invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v3~1coverage-profiles~1{coverageId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CoverageProfileDetailResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CoverageProfileDetailResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coverage/fltojr54olllm-get-the-coverage-profile"}],"panels":[]}]},"httpPath":"/v3/coverage-profiles/{coverageId}"},{"label":"Create custom region coverage profile","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/coverage/9dtoar54odjsm-create-custom-region-coverage-profile","routeSlug":"/openapi/coverage/9dtoar54odjsm-create-custom-region-coverage-profile","metadata":{"seo":{"title":"Create custom region coverage profile","description":"Creates a custom region coverage profile using a list of ISO 2-letter country codes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"9dtoar54odjsm-create-custom-region-coverage-profile","name":"Create custom region coverage profile","isWebhook":false,"pointer":"/paths/~1v3~1coverage-profiles~1custom-region/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create custom region coverage profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a custom region coverage profile using a list of ISO 2-letter country codes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation checks:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system performs the following validations before creating the profile:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duplicate name check"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If a region with the same name already exists for this organization, returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400 Bad Request"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duplicate coverage check"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If a coverage profile with the exact same set of countries already exists, returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409 Conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the existing profile details"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Coverage profiles are immutable and cannot be deleted. You can only create new profiles."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"key","description":"Your API key for authentication"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_35","exampleIds":["paths/~1v3~1coverage-profiles~1custom-region/post/requestBody/content/application~1json/examples/default"]}},"schemaId":"schema_35","exampleIds":["paths/~1v3~1coverage-profiles~1custom-region/post/requestBody/content/application~1json/examples/default"],"pointer":"/paths/~1v3~1coverage-profiles~1custom-region/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/coverage-profiles/custom-region","servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"key","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_35","exampleIds":["paths/~1v3~1coverage-profiles~1custom-region/post/requestBody/content/application~1json/examples/default"]}},"responseCodes":["200","400","401","409"],"pointer":"/v3/coverage-profiles/custom-region","href":"coverage/9dtoar54odjsm-create-custom-region-coverage-profile","openApiOperationId":"9dtoar54odjsm-create-custom-region-coverage-profile","summary":"Create custom region coverage profile"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"schemaId":"schema_35","exampleIds":["paths/~1v3~1coverage-profiles~1custom-region/post/requestBody/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_35","exampleIds":["paths/~1v3~1coverage-profiles~1custom-region/post/requestBody/content/application~1json/examples/default"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response containing the created custom region coverage profile.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomRegionCoverageProfileResponse","exampleIds":["paths/~1v3~1coverage-profiles~1custom-region/post/responses/200/content/application~1json/examples/success"]}},"schemaId":"components/schemas/CustomRegionCoverageProfileResponse","exampleIds":["paths/~1v3~1coverage-profiles~1custom-region/post/responses/200/content/application~1json/examples/success"]},{"code":"400","description":"Bad request - either a custom region with this name already exists for this organization, or one or more provided ISO2 country codes have no operators assigned.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_36","exampleIds":["paths/~1v3~1coverage-profiles~1custom-region/post/responses/400/content/application~1json/examples/nameAlreadyExists","paths/~1v3~1coverage-profiles~1custom-region/post/responses/400/content/application~1json/examples/missingOperatorsForIso2"]}},"schemaId":"schema_36","exampleIds":["paths/~1v3~1coverage-profiles~1custom-region/post/responses/400/content/application~1json/examples/nameAlreadyExists","paths/~1v3~1coverage-profiles~1custom-region/post/responses/400/content/application~1json/examples/missingOperatorsForIso2"]},{"code":"401","description":"Unauthorized - API key is missing or invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"409","description":"Conflict - a coverage profile with the exact same set of countries already exists. The existing coverage coverage details are returned.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_37","exampleIds":["paths/~1v3~1coverage-profiles~1custom-region/post/responses/409/content/application~1json/examples/coverageConflict"]}},"schemaId":"schema_37","exampleIds":["paths/~1v3~1coverage-profiles~1custom-region/post/responses/409/content/application~1json/examples/coverageConflict"]}],"pointer":"/paths/~1v3~1coverage-profiles~1custom-region/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomRegionCoverageProfileResponse","exampleIds":["paths/~1v3~1coverage-profiles~1custom-region/post/responses/200/content/application~1json/examples/success"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomRegionCoverageProfileResponse","exampleIds":["paths/~1v3~1coverage-profiles~1custom-region/post/responses/200/content/application~1json/examples/success"]}}},{"code":"400","schemaId":"schema_36","exampleIds":["paths/~1v3~1coverage-profiles~1custom-region/post/responses/400/content/application~1json/examples/nameAlreadyExists","paths/~1v3~1coverage-profiles~1custom-region/post/responses/400/content/application~1json/examples/missingOperatorsForIso2"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_36","exampleIds":["paths/~1v3~1coverage-profiles~1custom-region/post/responses/400/content/application~1json/examples/nameAlreadyExists","paths/~1v3~1coverage-profiles~1custom-region/post/responses/400/content/application~1json/examples/missingOperatorsForIso2"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"409","schemaId":"schema_37","exampleIds":["paths/~1v3~1coverage-profiles~1custom-region/post/responses/409/content/application~1json/examples/coverageConflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_37","exampleIds":["paths/~1v3~1coverage-profiles~1custom-region/post/responses/409/content/application~1json/examples/coverageConflict"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/coverage/9dtoar54odjsm-create-custom-region-coverage-profile"}],"panels":[]}]},"httpPath":"/v3/coverage-profiles/custom-region"}],"content":{"contentType":"group","meta":{"name":"Coverage"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Coverage","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to coverage."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/coverage-profiles","summary":"List coverage profiles","prefix":{"name":"get","color":"get"},"badges":[],"link":"/coverage/xwappasg4mnsd-list-coverage-profiles","deprecated":false},{"title":"/v3/coverage-profiles/{coverageId}","summary":"Get the coverage profile","prefix":{"name":"get","color":"get"},"badges":[],"link":"/coverage/fltojr54olllm-get-the-coverage-profile","deprecated":false},{"title":"/v3/coverage-profiles/custom-region","summary":"Create custom region coverage profile","prefix":{"name":"post","color":"post"},"badges":[],"link":"/coverage/9dtoar54odjsm-create-custom-region-coverage-profile","deprecated":false}]}]}]}]}},{"type":"group","label":"SIM","link":"/openapi/sim","routeSlug":"/openapi/sim","items":[{"label":"List SIMs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/sim/s3rz0wvzvnuuz-list-sims","routeSlug":"/openapi/sim/s3rz0wvzvnuuz-list-sims","metadata":{"seo":{"title":"List SIMs","description":"This endpoint retrieves a list of SIMs(both eSIMs and physical sim cards) associated with organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"s3rz0wvzvnuuz-list-sims","name":"List SIMs","isWebhook":false,"pointer":"/paths/~1v3~1sims/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List SIMs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint retrieves a list of SIMs(both eSIMs and physical sim cards) associated with organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"key","description":"Your API key for authentication"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page_size","in":"query","schemaId":"schema_22"},{"name":"page","in":"query","schemaId":"schema_22"},{"name":"is_esim","in":"query","schemaId":"schema_30"},{"name":"label","in":"query","schemaId":"schema_22","example":"Green"}],"pointer":"/paths/~1v3~1sims/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/sims","servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"page_size","in":"query","schemaId":"schema_22"},{"name":"page","in":"query","schemaId":"schema_22"},{"name":"is_esim","in":"query","schemaId":"schema_30"},{"name":"label","in":"query","required":false,"example":"Green","schemaId":"schema_22"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"key","in":"query"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/v3/sims","href":"sim/s3rz0wvzvnuuz-list-sims","openApiOperationId":"s3rz0wvzvnuuz-list-sims","summary":"List SIMs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response containing a list of SIMs","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ESIMListResponse"}},"schemaId":"components/schemas/ESIMListResponse"},{"code":"401","description":"Unauthorized - API key is missing or invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v3~1sims/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ESIMListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ESIMListResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sim/s3rz0wvzvnuuz-list-sims"}],"panels":[]}]},"httpPath":"/v3/sims"},{"label":"Get SIM details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/sim/xou0n7wvmb58j-get-sim-by-iccid","routeSlug":"/openapi/sim/xou0n7wvmb58j-get-sim-by-iccid","metadata":{"seo":{"title":"Get SIM details","description":"This endpoint retrieves the details of a specific SIM by its ICCID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"xou0n7wvmb58j-get-sim-by-iccid","name":"Get SIM details","isWebhook":false,"pointer":"/paths/~1v3~1sims~1{iccid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get SIM details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint retrieves the details of a specific SIM by its ICCID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"key","description":"Your API key for authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"iccid","in":"path","schemaId":"schema_22","required":true}],"pointer":"/paths/~1v3~1sims~1{iccid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/sims/{iccid}","servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"parameters":{"path":[{"name":"iccid","in":"path","required":true,"schemaId":"schema_22"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"key","in":"query"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/v3/sims/{iccid}","href":"sim/xou0n7wvmb58j-get-sim-by-iccid","openApiOperationId":"xou0n7wvmb58j-get-sim-by-iccid","summary":"Get SIM details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response containing the SIM details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SIMDetailResponse"}},"schemaId":"components/schemas/SIMDetailResponse"},{"code":"401","description":"Unauthorized - API key is missing or invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v3~1sims~1{iccid}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SIMDetailResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SIMDetailResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sim/xou0n7wvmb58j-get-sim-by-iccid"}],"panels":[]}]},"httpPath":"/v3/sims/{iccid}"},{"label":"Get SIM SMDP information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/sim/ftvathnftu1cu-get-sim-smdp-info","routeSlug":"/openapi/sim/ftvathnftu1cu-get-sim-smdp-info","metadata":{"seo":{"title":"Get SIM SMDP information","description":"This endpoint retrieves the SM-DP+ (Subscription Manager Data Preparation) information for a specific SIM by its ICCID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ftvathnftu1cu-get-sim-smdp-info","name":"Get SIM SMDP information","isWebhook":false,"pointer":"/paths/~1v3~1sims~1{iccid}~1smdp-info/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get SIM SMDP information","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves the SM-DP+ (Subscription Manager Data Preparation) information for a specific SIM by its ICCID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response includes the state history of the eSIM profile with the following possible states:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BPP Installation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The process of downloading and installing the eSIM profile via a Bootstrap Provisioning Platform (BPP)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": eSIM is switched on from device settings, allowing it to connect to the mobile network"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Disable"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": eSIM is turned off via device settings, temporarily preventing it from being used"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": eSIM profile is completely removed from the device"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"key","description":"Your API key for authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"iccid","in":"path","schemaId":"schema_22","description":"The ICCID of the SIM","required":true}],"pointer":"/paths/~1v3~1sims~1{iccid}~1smdp-info/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/sims/{iccid}/smdp-info","servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"parameters":{"path":[{"name":"iccid","in":"path","required":true,"schemaId":"schema_22"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"key","in":"query"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/v3/sims/{iccid}/smdp-info","href":"sim/ftvathnftu1cu-get-sim-smdp-info","openApiOperationId":"ftvathnftu1cu-get-sim-smdp-info","summary":"Get SIM SMDP information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response containing the SMDP information.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SMDPInfoResponse","exampleIds":["paths/~1v3~1sims~1{iccid}~1smdp-info/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/SMDPInfoResponse","exampleIds":["paths/~1v3~1sims~1{iccid}~1smdp-info/get/responses/200/content/application~1json/example"]},{"code":"401","description":"Unauthorized - API key is missing or invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v3~1sims~1{iccid}~1smdp-info/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SMDPInfoResponse","exampleIds":["paths/~1v3~1sims~1{iccid}~1smdp-info/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SMDPInfoResponse","exampleIds":["paths/~1v3~1sims~1{iccid}~1smdp-info/get/responses/200/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sim/ftvathnftu1cu-get-sim-smdp-info"}],"panels":[]}]},"httpPath":"/v3/sims/{iccid}/smdp-info"}],"content":{"contentType":"group","meta":{"name":"SIM"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"SIM","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to SIM management."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/sims","summary":"List SIMs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sim/s3rz0wvzvnuuz-list-sims","deprecated":false},{"title":"/v3/sims/{iccid}","summary":"Get SIM details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sim/xou0n7wvmb58j-get-sim-by-iccid","deprecated":false},{"title":"/v3/sims/{iccid}/smdp-info","summary":"Get SIM SMDP information","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sim/ftvathnftu1cu-get-sim-smdp-info","deprecated":false}]}]}]}]}},{"type":"group","label":"Operators","link":"/openapi/operators","routeSlug":"/openapi/operators","items":[{"label":"List operators","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/operators/u8ed9w0ej2nj4-list-operators","routeSlug":"/openapi/operators/u8ed9w0ej2nj4-list-operators","metadata":{"seo":{"title":"List operators","description":"Returns the list of operators filtered by optional label and country filters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"u8ed9w0ej2nj4-list-operators","name":"List operators","isWebhook":false,"pointer":"/paths/~1v3~1operators/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List operators","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the list of operators filtered by optional label and country filters."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"key","description":"Your API key for authentication"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"label","in":"query","schemaId":"schema_32","description":"Filter operators by label. Allowed values are Green, Aqua, Blue, Voilet, Red, Grey, Orange."},{"name":"iso2_codes","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma separated list of ISO 2-letter country codes. For example: iso2_codes=MX,US"},"children":[]}]}]}]}],"pointer":"/paths/~1v3~1operators/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/operators","servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"label","in":"query","required":false,"schemaId":"components/schemas/Label"},{"name":"iso2_codes","in":"query","required":false,"schemaId":"schema_22"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"key","in":"query"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/v3/operators","href":"operators/u8ed9w0ej2nj4-list-operators","openApiOperationId":"u8ed9w0ej2nj4-list-operators","summary":"List operators"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response containing a list of operators.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OperatorListResponse"}},"schemaId":"components/schemas/OperatorListResponse"},{"code":"401","description":"Unauthorized - API key is missing or invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v3~1operators/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OperatorListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OperatorListResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/operators/u8ed9w0ej2nj4-list-operators"}],"panels":[]}]},"httpPath":"/v3/operators"},{"label":"Get operator","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/operators/9ej4esdkfjfe9-get-operator","routeSlug":"/openapi/operators/9ej4esdkfjfe9-get-operator","metadata":{"seo":{"title":"Get operator","description":"Retrieves the details of a specific operator."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"9ej4esdkfjfe9-get-operator","name":"Get operator","isWebhook":false,"pointer":"/paths/~1v3~1operators~1{operatorId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get operator","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the details of a specific operator."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"key","description":"Your API key for authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"operatorId","in":"path","schemaId":"schema_22","required":true}],"pointer":"/paths/~1v3~1operators~1{operatorId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/operators/{operatorId}","servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"parameters":{"path":[{"name":"operatorId","in":"path","required":true,"schemaId":"schema_22"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"key","in":"query"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/v3/operators/{operatorId}","href":"operators/9ej4esdkfjfe9-get-operator","openApiOperationId":"9ej4esdkfjfe9-get-operator","summary":"Get operator"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response containing operator details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OperatorDetailResponse"}},"schemaId":"components/schemas/OperatorDetailResponse"},{"code":"401","description":"Unauthorized - API key is missing or invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v3~1operators~1{operatorId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OperatorDetailResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OperatorDetailResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/operators/9ej4esdkfjfe9-get-operator"}],"panels":[]}]},"httpPath":"/v3/operators/{operatorId}"}],"content":{"contentType":"group","meta":{"name":"Operators"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Operators","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to operators."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/operators","summary":"List operators","prefix":{"name":"get","color":"get"},"badges":[],"link":"/operators/u8ed9w0ej2nj4-list-operators","deprecated":false},{"title":"/v3/operators/{operatorId}","summary":"Get operator","prefix":{"name":"get","color":"get"},"badges":[],"link":"/operators/9ej4esdkfjfe9-get-operator","deprecated":false}]}]}]}]}},{"type":"group","label":"Wallet","link":"/openapi/wallet","routeSlug":"/openapi/wallet","items":[{"label":"Get eSIM wallet balance","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/wallet/t5hx1zvk7upce-get-wallet-balance","routeSlug":"/openapi/wallet/t5hx1zvk7upce-get-wallet-balance","metadata":{"seo":{"title":"Get eSIM wallet balance","description":"Returns live balance, wallet plan status, and full transaction history for an eSIM."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"t5hx1zvk7upce-get-wallet-balance","name":"Get eSIM wallet balance","isWebhook":false,"pointer":"/paths/~1v3~1wallet~1{iccid}~1balance/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get eSIM wallet balance","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns live balance, wallet plan status, and full transaction history for an eSIM."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"key","description":"Your API key for authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"iccid","in":"path","schemaId":"schema_22","description":"eSIM ICCID","required":true}],"pointer":"/paths/~1v3~1wallet~1{iccid}~1balance/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/wallet/{iccid}/balance","servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"parameters":{"path":[{"name":"iccid","in":"path","required":true,"schemaId":"schema_22"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"key","in":"query"}],"scopes":[]}],"responseCodes":["200","400","401","404","500"],"pointer":"/v3/wallet/{iccid}/balance","href":"wallet/t5hx1zvk7upce-get-wallet-balance","openApiOperationId":"t5hx1zvk7upce-get-wallet-balance","summary":"Get eSIM wallet balance"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response containing wallet balance and transaction history","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WalletBalanceGetResponse"}},"schemaId":"components/schemas/WalletBalanceGetResponse"},{"code":"400","description":"Bad Request - eSIM is not Green label","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized - API key is missing or invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"404","description":"Not Found - eSIM not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1wallet~1{iccid}~1balance/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WalletBalanceGetResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WalletBalanceGetResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/wallet/t5hx1zvk7upce-get-wallet-balance"}],"panels":[]}]},"httpPath":"/v3/wallet/{iccid}/balance"},{"label":"Modify eSIM wallet balance","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/wallet/x2rb9kfw5zjuc-modify-wallet-balance","routeSlug":"/openapi/wallet/x2rb9kfw5zjuc-modify-wallet-balance","metadata":{"seo":{"title":"Modify eSIM wallet balance","description":"Modifies the wallet balance of an eSIM. Use positive amounts to credit, negative to debit, or set_balance=true to force a specific balance."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"x2rb9kfw5zjuc-modify-wallet-balance","name":"Modify eSIM wallet balance","isWebhook":false,"pointer":"/paths/~1v3~1wallet~1{iccid}~1balance/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modify eSIM wallet balance","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Modifies the wallet balance of an eSIM. Use positive amounts to credit, negative to debit, or set_balance=true to force a specific balance."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"key","description":"Your API key for authentication"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"iccid","in":"path","schemaId":"schema_22","description":"eSIM ICCID","required":true}],"pointer":"/paths/~1v3~1wallet~1{iccid}~1balance/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WalletBalanceModifyRequest","exampleIds":["paths/~1v3~1wallet~1{iccid}~1balance/post/requestBody/content/application~1json/examples/set_balance","paths/~1v3~1wallet~1{iccid}~1balance/post/requestBody/content/application~1json/examples/add_balance","paths/~1v3~1wallet~1{iccid}~1balance/post/requestBody/content/application~1json/examples/decrease_balance"]}},"schemaId":"components/schemas/WalletBalanceModifyRequest","exampleIds":["paths/~1v3~1wallet~1{iccid}~1balance/post/requestBody/content/application~1json/examples/set_balance","paths/~1v3~1wallet~1{iccid}~1balance/post/requestBody/content/application~1json/examples/add_balance","paths/~1v3~1wallet~1{iccid}~1balance/post/requestBody/content/application~1json/examples/decrease_balance"],"pointer":"/paths/~1v3~1wallet~1{iccid}~1balance/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/wallet/{iccid}/balance","servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"parameters":{"path":[{"name":"iccid","in":"path","required":true,"schemaId":"schema_22"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"key","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WalletBalanceModifyRequest","exampleIds":["paths/~1v3~1wallet~1{iccid}~1balance/post/requestBody/content/application~1json/examples/set_balance","paths/~1v3~1wallet~1{iccid}~1balance/post/requestBody/content/application~1json/examples/add_balance","paths/~1v3~1wallet~1{iccid}~1balance/post/requestBody/content/application~1json/examples/decrease_balance"]}},"responseCodes":["200","400","401","404","500"],"pointer":"/v3/wallet/{iccid}/balance","href":"wallet/x2rb9kfw5zjuc-modify-wallet-balance","openApiOperationId":"x2rb9kfw5zjuc-modify-wallet-balance","summary":"Modify eSIM wallet balance"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"schemaId":"components/schemas/WalletBalanceModifyRequest","exampleIds":["paths/~1v3~1wallet~1{iccid}~1balance/post/requestBody/content/application~1json/examples/set_balance","paths/~1v3~1wallet~1{iccid}~1balance/post/requestBody/content/application~1json/examples/add_balance","paths/~1v3~1wallet~1{iccid}~1balance/post/requestBody/content/application~1json/examples/decrease_balance"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WalletBalanceModifyRequest","exampleIds":["paths/~1v3~1wallet~1{iccid}~1balance/post/requestBody/content/application~1json/examples/set_balance","paths/~1v3~1wallet~1{iccid}~1balance/post/requestBody/content/application~1json/examples/add_balance","paths/~1v3~1wallet~1{iccid}~1balance/post/requestBody/content/application~1json/examples/decrease_balance"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response containing transaction details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WalletBalanceModifyResponse"}},"schemaId":"components/schemas/WalletBalanceModifyResponse"},{"code":"400","description":"Bad Request - Invalid request body or eSIM not Green label","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized - API key is missing or invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"404","description":"Not Found - eSIM not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1wallet~1{iccid}~1balance/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WalletBalanceModifyResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WalletBalanceModifyResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/wallet/x2rb9kfw5zjuc-modify-wallet-balance"}],"panels":[]}]},"httpPath":"/v3/wallet/{iccid}/balance"},{"label":"Apply or remove mobile plan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/wallet/f2lc9jv0zpsku-apply-remove-mobile-plan","routeSlug":"/openapi/wallet/f2lc9jv0zpsku-apply-remove-mobile-plan","metadata":{"seo":{"title":"Apply or remove mobile plan","description":"Applies or removes the organization's mobile plan from an eSIM. When applying, an eSIM can be auto-selected if ICCID is not provided."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"f2lc9jv0zpsku-apply-remove-mobile-plan","name":"Apply or remove mobile plan","isWebhook":false,"pointer":"/paths/~1v3~1wallet~1mobile-plan/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Apply or remove mobile plan","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Applies or removes the organization's mobile plan from an eSIM. When applying, an eSIM can be auto-selected if ICCID is not provided."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"key","description":"Your API key for authentication"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WalletMobilePlanRequest"}},"schemaId":"components/schemas/WalletMobilePlanRequest","pointer":"/paths/~1v3~1wallet~1mobile-plan/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v3/wallet/mobile-plan","servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"key","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WalletMobilePlanRequest"}},"responseCodes":["200","400","401","404","500"],"pointer":"/v3/wallet/mobile-plan","href":"wallet/f2lc9jv0zpsku-apply-remove-mobile-plan","openApiOperationId":"f2lc9jv0zpsku-apply-remove-mobile-plan","summary":"Apply or remove mobile plan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"schemaId":"components/schemas/WalletMobilePlanRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WalletMobilePlanRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response containing mobile plan status","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WalletMobilePlanResponse"}},"schemaId":"components/schemas/WalletMobilePlanResponse"},{"code":"400","description":"Bad Request - Validation errors, label mismatch, ICCID required for remove, or wallet plan not configured","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"401","description":"Unauthorized - API key is missing or invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"404","description":"Not Found - eSIM not found or no free eSIM available","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1wallet~1mobile-plan/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WalletMobilePlanResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WalletMobilePlanResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"404","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/wallet/f2lc9jv0zpsku-apply-remove-mobile-plan"}],"panels":[]}]},"httpPath":"/v3/wallet/mobile-plan"},{"label":"List wallet-enabled eSIMs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/wallet/k8mx2qjv9tpla-list-wallet-sims","routeSlug":"/openapi/wallet/k8mx2qjv9tpla-list-wallet-sims","metadata":{"seo":{"title":"List wallet-enabled eSIMs","description":"Lists all eSIMs for the organization with wallet metadata including mobile plan status, transaction count, and last transaction timestamp."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"k8mx2qjv9tpla-list-wallet-sims","name":"List wallet-enabled eSIMs","isWebhook":false,"pointer":"/paths/~1v3~1wallet~1sims/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List wallet-enabled eSIMs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists all eSIMs for the organization with wallet metadata including mobile plan status, transaction count, and last transaction timestamp."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"key","description":"Your API key for authentication"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_22","description":"Cursor returned by previous page (base64-encoded)"},{"name":"page_size","in":"query","schemaId":"schema_38","description":"Number of items per page"}],"pointer":"/paths/~1v3~1wallet~1sims/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v3/wallet/sims","servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_22"},{"name":"page_size","in":"query","required":false,"schemaId":"schema_38"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"key","in":"query"}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/v3/wallet/sims","href":"wallet/k8mx2qjv9tpla-list-wallet-sims","openApiOperationId":"k8mx2qjv9tpla-list-wallet-sims","summary":"List wallet-enabled eSIMs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful response containing list of wallet-enabled eSIMs","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WalletSimsListResponse"}},"schemaId":"components/schemas/WalletSimsListResponse"},{"code":"401","description":"Unauthorized - API key is missing or invalid","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}},"schemaId":"components/schemas/ErrorResponse"}],"pointer":"/paths/~1v3~1wallet~1sims/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WalletSimsListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WalletSimsListResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/wallet/k8mx2qjv9tpla-list-wallet-sims"}],"panels":[]}]},"httpPath":"/v3/wallet/sims"}],"content":{"contentType":"group","meta":{"name":"Wallet"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Wallet","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to wallet balance and mobile plan management for eSIMs."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v3/wallet/{iccid}/balance","summary":"Get eSIM wallet balance","prefix":{"name":"get","color":"get"},"badges":[],"link":"/wallet/t5hx1zvk7upce-get-wallet-balance","deprecated":false},{"title":"/v3/wallet/{iccid}/balance","summary":"Modify eSIM wallet balance","prefix":{"name":"post","color":"post"},"badges":[],"link":"/wallet/x2rb9kfw5zjuc-modify-wallet-balance","deprecated":false},{"title":"/v3/wallet/mobile-plan","summary":"Apply or remove mobile plan","prefix":{"name":"post","color":"post"},"badges":[],"link":"/wallet/f2lc9jv0zpsku-apply-remove-mobile-plan","deprecated":false},{"title":"/v3/wallet/sims","summary":"List wallet-enabled eSIMs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/wallet/k8mx2qjv9tpla-list-wallet-sims","deprecated":false}]}]}]}]}},{"type":"group","label":"Webhook Events","link":"/openapi/webhook-events","routeSlug":"/openapi/webhook-events","items":[{"type":"link","label":"Validate webhook signature","link":"/openapi/webhook-events/validate-webhook-signature","routeSlug":"/openapi/webhook-events/validate-webhook-signature","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Validate webhook signature"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"webhook-events/validate-webhook-signature"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validate webhook signature"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each webhook call generated from TelliSIM includes a unique signature header to validate call authenticity."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The webhook contains a header "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-tellisim-signature"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" which identifies the call signature for each user."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To validate the signature, you can use the official npm library:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"@tellisim/webhook-signature-validator"},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://www.npmjs.com/package/@tellisim/webhook-signature-validator"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Basic usage:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"import * as tellisimSignatureValidator from '@tellisim/webhook-signature-validator';\n\ntellisimSignatureValidator.validate(signature, signingKey, webhookDataObject);\n","language":"ts"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"import * as tellisimSignatureValidator from '@tellisim/webhook-signature-validator';\n\ntellisimSignatureValidator.validate(signature, signingKey, webhookDataObject);\n"},"children":[]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"signature"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The header received in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-tellisim-signature"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"signingKey"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The signing key configured for your webhooks."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhookDataObject"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The JSON payload received in the webhook call."},"children":[]}]}]}]}]}]}]}],"panels":[]}]}},{"label":"Data allowance consumed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/openapi/webhook-events/attachment-allowance-consumed","routeSlug":"/openapi/webhook-events/attachment-allowance-consumed","metadata":{"seo":{"title":"Data allowance consumed","description":"Triggered when 50%, 80%, or 100% of a fixed validity plan'sdata allowance is consumed (no events for recurring plans)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"attachment-allowance-consumed","name":"Data allowance consumed","isWebhook":true,"pointer":"/paths/attachment.allowanceConsumed/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data allowance consumed","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Triggered when 50%, 80%, or 100% of a fixed validity plan's"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data allowance is consumed (no events for recurring plans)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"key","description":"Your API key for authentication"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_39","exampleIds":["paths/attachment.allowanceConsumed/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_39","exampleIds":["paths/attachment.allowanceConsumed/post/requestBody/content/application~1json/example"],"pointer":"/paths/attachment.allowanceConsumed/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"attachment.allowanceConsumed","servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"key","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_39","exampleIds":["paths/attachment.allowanceConsumed/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"attachment.allowanceConsumed","href":"webhook-events/attachment-allowance-consumed","openApiOperationId":"attachment-allowance-consumed","summary":"Data allowance consumed"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"schemaId":"schema_39","exampleIds":["paths/attachment.allowanceConsumed/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_39","exampleIds":["paths/attachment.allowanceConsumed/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return a 200 status to indicate that the data was received successfully"}],"pointer":"/paths/attachment.allowanceConsumed/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-events/attachment-allowance-consumed"}],"panels":[]}]},"httpPath":"attachment.allowanceConsumed"},{"label":"SIM location changed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/openapi/webhook-events/subscription-esim-location-changed","routeSlug":"/openapi/webhook-events/subscription-esim-location-changed","metadata":{"seo":{"title":"SIM location changed","description":"Triggered when a SIM's country location changes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"subscription-esim-location-changed","name":"SIM location changed","isWebhook":true,"pointer":"/paths/subscription.esim.locationChanged/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"SIM location changed","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Triggered when a SIM's country location changes.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"key","description":"Your API key for authentication"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_40","exampleIds":["paths/subscription.esim.locationChanged/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_40","exampleIds":["paths/subscription.esim.locationChanged/post/requestBody/content/application~1json/example"],"pointer":"/paths/subscription.esim.locationChanged/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"subscription.esim.locationChanged","servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"key","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_40","exampleIds":["paths/subscription.esim.locationChanged/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"subscription.esim.locationChanged","href":"webhook-events/subscription-esim-location-changed","openApiOperationId":"subscription-esim-location-changed","summary":"SIM location changed"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"schemaId":"schema_40","exampleIds":["paths/subscription.esim.locationChanged/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_40","exampleIds":["paths/subscription.esim.locationChanged/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return a 200 status to indicate that the data was received successfully"}],"pointer":"/paths/subscription.esim.locationChanged/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-events/subscription-esim-location-changed"}],"panels":[]}]},"httpPath":"subscription.esim.locationChanged"},{"label":"SIM SMDP Status Changed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/openapi/webhook-events/esim-smdp-state-changed","routeSlug":"/openapi/webhook-events/esim-smdp-state-changed","metadata":{"seo":{"title":"SIM SMDP Status Changed","description":"The event is sent whenever the SMDP state of an event is changed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"esim-smdp-state-changed","name":"SIM SMDP Status Changed","isWebhook":true,"pointer":"/paths/esim.smdp.stateChanged/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"SIM SMDP Status Changed","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The event is sent whenever the SMDP state of an event is changed.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"query","paramName":"key","description":"Your API key for authentication"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_41","exampleIds":["paths/esim.smdp.stateChanged/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_41","exampleIds":["paths/esim.smdp.stateChanged/post/requestBody/content/application~1json/example"],"pointer":"/paths/esim.smdp.stateChanged/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"esim.smdp.stateChanged","servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"key","in":"query"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_41","exampleIds":["paths/esim.smdp.stateChanged/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"esim.smdp.stateChanged","href":"webhook-events/esim-smdp-state-changed","openApiOperationId":"esim-smdp-state-changed","summary":"SIM SMDP Status Changed"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.tellisim.com","description":"Production server"}],"schemaId":"schema_41","exampleIds":["paths/esim.smdp.stateChanged/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_41","exampleIds":["paths/esim.smdp.stateChanged/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Return a 200 status to indicate that the data was received successfully"}],"pointer":"/paths/esim.smdp.stateChanged/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-events/esim-smdp-state-changed"}],"panels":[]}]},"httpPath":"esim.smdp.stateChanged"}],"content":{"contentType":"group","meta":{"name":"Webhook Events"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhook Events","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operations related to webhook events."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"attachment.allowanceConsumed","summary":"Data allowance consumed","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook-events/attachment-allowance-consumed","deprecated":false},{"title":"subscription.esim.locationChanged","summary":"SIM location changed","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook-events/subscription-esim-location-changed","deprecated":false},{"title":"esim.smdp.stateChanged","summary":"SIM SMDP Status Changed","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook-events/esim-smdp-state-changed","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/CoverageProfile":{"id":"components/schemas/CoverageProfile","kind":"json-schema","title":"CoverageProfile","data":{"type":"object","properties":{"coverage_id":{"type":"string","description":"The unique identifier for the coverage profile","example":"24648a7f-8281-4af7-8fc0-19b2371b2d1d"},"label":{"type":"string","description":"The label for the coverage profile","example":"Green"},"region_name":{"type":"string","description":"The name of the region for which the coverage is applicable","example":"United States"},"region_code":{"type":"string","description":"The ISO code of the region for which the coverage is applicable","example":"US"},"countries":{"type":"array","description":"Optional list of countries included in this coverage profile","items":{"type":"object","properties":{"iso2":{"type":"string","description":"ISO 2-letter country code","example":"US"},"iso3":{"type":"string","description":"ISO 3-letter country code","example":"USA"},"name":{"type":"string","description":"Country name","example":"United States"},"operators":{"type":"array","description":"Optional list of operators available in this country for the coverage profile","items":{"type":"object","properties":{"operator_id":{"type":"string","description":"The unique identifier for the operator","example":"2dea792a-2dea-492c-815d-8fb826be8d49"},"name":{"type":"string","description":"The name of the operator","example":"AT&T USA"},"supported_rats":{"type":"array","description":"List of supported Radio Access Technologies (RATs)","items":{"type":"string"},"example":["4G","5G"]},"mcc_mnc":{"type":"array","description":"List of MCC-MNC codes associated with the operator","items":{"type":"string"},"example":["310-680","310-410"]}}}}}}}},"required":["coverage_id","label","region_name","region_code"]}},"components/schemas/Plan":{"id":"components/schemas/Plan","kind":"json-schema","title":"Plan","data":{"type":"object","properties":{"plan_name":{"type":"string","description":"Name of the plan","example":"USA Plan"},"plan_id":{"type":"string","description":"Unique identifier for the plan","example":"39c3ae26-22a5-49cb-93ca-2fe65b3a5c69"},"coverage_id":{"type":"string","description":"Identifier for the coverage area of the plan","example":"819b05c4-f154-4df9-8fd1-16be3e82f5c6"},"archived_at":{"type":["string","null"],"description":"Timestamp of when the plan was archived (if applicable)","example":null},"region_code":{"type":"string","description":"Code representing the region for the plan","example":"US"},"label":{"type":"string","description":"Label for the plan","example":"blue"},"created_at":{"type":"string","description":"Timestamp of when the plan was created","example":"2025-01-01T00:00:00Z"},"throttling":{"type":"boolean","description":"Indicates if the plan has throttling enabled","example":true},"recurring":{"type":"boolean","description":"Indicates if the plan is recurring","example":true},"data_mega_bytes":{"type":"integer","description":"Amount of data in megabytes included in the plan","example":1024},"period_days":{"type":"integer","description":"Duration of the plan in days","example":30},"archive":{"type":"boolean","description":"Indicates if the plan is archived","example":false},"period_iterations":{"type":"integer","description":"Number of iterations for the plan period","example":12},"throttling_threshold1_perc":{"type":"integer","description":"The percentage threshold for first throttling","example":50,"minimum":0,"maximum":100},"throttling_threshold1_limit":{"type":"string","description":"The limit associated with the first throttling threshold","example":"3072","enum":["32","64","128","256","384","512","1024","3072","5120","7680","10240","20480"]},"throttling_threshold2_perc":{"type":"integer","description":"The percentage threshold for second throttling","example":80,"minimum":0,"maximum":100},"throttling_threshold2_limit":{"type":"string","description":"The limit associated with the second throttling threshold","example":"384","enum":["32","64","128","256","384","512","1024","3072","5120","7680","10240","20480"]},"throttling_threshold3_perc":{"type":"integer","description":"The percentage threshold for third throttling","example":90,"minimum":0,"maximum":100},"throttling_threshold3_limit":{"type":"string","description":"The limit associated with the third throttling threshold","example":"128","enum":["32","64","128","256","384","512","1024","3072","5120","7680","10240","20480"]},"nb_occurrence":{"type":"integer","description":"The number of occurrences for the plan","example":12},"recurring_periodicity_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of periodicity for the recurring plan. Possible values are 0=Daily, 1=Weekly, 2=Monthly."},"children":[]}]}]}],"example":"0","enum":["0","1","2"]},"recurring_periodicity_frequency":{"type":"integer","description":"The frequency of the recurring billing cycle","example":1}},"required":["plan_id","coverage_id","label","data_mega_bytes","period_days","archived_at","region_code","created_at","throttling","recurring","archive","plan_name"]}},"components/schemas/ESIM":{"id":"components/schemas/ESIM","kind":"json-schema","title":"ESIM","data":{"type":"object","properties":{"iccid":{"type":"string","description":"The Integrated Circuit Card Identifier of the eSIM","example":"8937103400004164763"},"label":{"type":"string","description":"A label for the eSIM","example":"Blue"},"lpa":{"type":["string","null"],"description":"The Local Profile Assistant associated with the eSIM if the SIM is an eSIM","example":"LPA:1$rsp-eu.redteamobile.com$0F222CA0C9B2F3A99457DADC94A4958C"},"used":{"type":"boolean","description":"Indicates if the SIM has been used or not","example":false},"esim_id":{"type":"string","description":"The unique identifier for the eSIM","example":"5a15183b-ca25-4725-b8a8-807990f98e03"},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the SIM was created","example":"2025-08-11T14:43:15.761Z"},"is_esim":{"type":"boolean","description":"Indicates if the item is an eSIM or not","example":true}},"required":["iccid","esim_id","is_esim","created_at","label"]}},"components/schemas/ESIMListResponse":{"id":"components/schemas/ESIMListResponse","kind":"json-schema","title":"ESIMListResponse","data":{"type":"object","properties":{"error":{"type":"boolean","description":"Indicates whether an error occurred during the request","example":false},"data":{"type":"array","description":"Contains an array of SIM objects","items":{"$ref":"#/components/schemas/ESIM"}},"next_page":{"type":["string","null"],"description":"A token for pagination, indicating if there are more results available","example":"MQ=="}},"required":["error","data","next_page"]}},"components/schemas/PlanListResponse":{"id":"components/schemas/PlanListResponse","kind":"json-schema","title":"PlanListResponse","data":{"type":"object","properties":{"error":{"type":"boolean","description":"Indicates if there was an error in the request","example":false},"data":{"type":"array","description":"An array of plan objects returned by the request","items":{"$ref":"#/components/schemas/Plan"}},"next_page":{"type":["string","null"],"description":"Token for the next page of results, if available","example":null}},"required":["error","data","next_page"]}},"components/schemas/PlanCreateResponse":{"id":"components/schemas/PlanCreateResponse","kind":"json-schema","title":"PlanCreateResponse","data":{"type":"object","properties":{"error":{"type":"boolean","description":"Indicates if there was an error processing the request","example":false},"message":{"type":"string","description":"A message providing additional information about the error (if any)","example":"plan created successfully"},"plan_id":{"type":"string","description":"The unique identifier for the newly created plan (if successful)","example":"39c3ae26-22a5-49cb-93ca-2fe65b3a5c69"}},"required":["error","message","plan_id"]}},"components/schemas/Subscription":{"id":"components/schemas/Subscription","kind":"json-schema","title":"Subscription","data":{"type":"object","properties":{"subscription_id":{"type":"string","description":"The unique identifier for the subscription","example":"a3b60fe5-a6ae-4b33-b5b0-9fae1832aa64"},"created_at":{"type":"string","description":"The timestamp when the subscription was created","example":"2025-08-08T11:05:57.703"},"activation_at":{"type":["string","null"],"format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active_period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was provided in the request."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value reflects the actual activation time reported by the underlying system when available. If the underlying system does not return an activation timestamp, the API falls back to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active_period.start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active_period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sent, the subscription uses the default behavior (activation at first use) and this field is omitted from the response."},"children":[]}]}]}],"example":"2025-12-10T15:03:28.533603"},"expiration_at":{"type":["string","null"],"format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active_period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was provided in the request."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value reflects the actual expiration time reported by the underlying system when available. If the underlying system does not return an expiration timestamp, the API falls back to:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active_period.end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when it is provided (typically for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"non-recurring plans), or"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the underlying plan validity when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is omitted (typically"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for recurring plans where only a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is sent)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active_period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sent, the subscription uses the default behavior (activation at first use) and this field is omitted from the response."},"children":[]}]}]}],"example":"2025-12-20T15:03:28.533603Z"},"metadata":{"type":"string","description":"Additional metadata related to the subscription","example":"test message"},"esim":{"$ref":"#/components/schemas/ESIM"}},"required":["subscription_id","created_at","esim"]}},"components/schemas/SubscriptionListResponse":{"id":"components/schemas/SubscriptionListResponse","kind":"json-schema","title":"SubscriptionListResponse","data":{"type":"object","properties":{"error":{"type":"boolean","description":"Indicates whether there was an error in the request","example":false},"data":{"type":"array","description":"Contains an array of subscription objects","items":{"type":"object","properties":{"subscription_id":{"type":"string","description":"The unique identifier for the subscription","example":"6174d2d5-f3bd-4336-abe0-13d75cc8a023"},"created_at":{"type":"string","description":"The timestamp when the subscription was created","example":"2025-08-24T14:59:38.037Z"},"metadata":{"type":"string","description":"Additional metadata related to the subscription","example":"usa plan applied"},"esim":{"type":"object","properties":{"esim_id":{"type":"string","description":"The unique identifier for the eSIM","example":"67940632-e09e-4c16-b220-1b47988d50b6"},"iccid":{"type":"string","description":"The Integrated Circuit Card Identifier for the eSIM","example":"8948010000031324500"},"lpa_string":{"type":["string","null"],"description":"The LPA string associated with the eSIM if it is an eSIM else null.","example":"LPA:1$smdp.io$K2-2GNHV6-USUV2O"},"label":{"type":"string","description":"A label for the eSIM","example":"Green"}},"required":["esim_id","iccid","label"]}},"required":["subscription_id","created_at","metadata","esim"]}}},"required":["error","data"]}},"components/schemas/SubscriptionCreateResponse":{"id":"components/schemas/SubscriptionCreateResponse","kind":"json-schema","title":"SubscriptionCreateResponse","data":{"type":"object","properties":{"subscription_id":{"type":"string","description":"The unique identifier for the created subscription","example":"a3b60fe5-a6ae-4b33-b5b0-9fae1832aa64"},"created_at":{"type":"string","description":"Timestamp indicating when the subscription was created","example":"2025-08-08T11:05:57.703Z"},"activation_at":{"type":["string","null"],"format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active_period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was provided in the request."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value reflects the actual activation time reported by the underlying system when available. If the underlying system does not return an activation timestamp, the API falls back to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active_period.start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is omitted entirely if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active_period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was not sent."},"children":[]}]}]}],"example":"2025-12-10T15:03:28.533603Z"},"expiration_at":{"type":["string","null"],"format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active_period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was provided in the request."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value reflects the actual expiration time reported by the underlying system when available. If the underlying system does not return an expiration timestamp, the API falls back to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active_period.end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when provided; otherwise it remains "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is omitted entirely if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active_period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was not sent."},"children":[]}]}]}],"example":"2025-12-20T15:03:28.533603Z"},"metadata":{"type":"string","description":"The metadata provided in the request","example":"usa recurring plan"},"esimdata":{"type":"object","description":"An object containing details about the eSIM or Physical SIM","properties":{"esim_id":{"type":"string","description":"The unique identifier for the eSIM","example":"65a89dca-349e-4278-95fb-a8fe2e9b281f"},"iccid":{"type":"string","description":"The Integrated Circuit Card Identifier for the eSIM","example":"8937103400004164763"},"label":{"type":"string","description":"A label associated with the eSIM","example":"blue"},"lpa_string":{"type":["string","null"],"description":"The LPA string associated with the eSIM","example":"LPA:1$rsp-eu.redteamobile.com$0F222CA0C9B2F3A99457DADC94A4958C"}},"required":["esim_id","iccid","label"]}},"required":["subscription_id","created_at","metadata","esimdata"]}},"components/schemas/SubscriptionDetailResponse":{"id":"components/schemas/SubscriptionDetailResponse","kind":"json-schema","title":"SubscriptionDetailResponse","data":{"type":"object","properties":{"error":{"type":"boolean","description":"Indicates whether there was an error processing the request","example":false},"data":{"type":"object","description":"Contains the details of the subscription","properties":{"subscription_id":{"type":"string","description":"The unique identifier for the subscription","example":"38838e12-4394-4e04-bb11-9250e835668e"},"created_at":{"type":"string","description":"The timestamp when the subscription was created","example":"2025-08-17T15:16:00.890Z"},"metadata":{"type":"string","description":"Additional metadata related to the subscription","example":"Subscription for USA"},"esim":{"type":"object","description":"Contains details about the SIM","properties":{"esim_id":{"type":"string","description":"The unique identifier for the SIM(eSIM or Physical SIM)","example":"5a15183b-ca25-4725-b8a8-807990f98e03"},"iccid":{"type":"string","description":"The ICCID of the SIM(eSIM or Physical SIM)","example":"8937103400004164763"},"lpa_string":{"type":["string","null"],"description":"The LPA string associated with the eSIM else null for physical SIM","example":"LPA:1$rsp-eu.redteamobile.com$0F222CA0C9B2F3A99457DADC94A4958C"},"label":{"type":"string","description":"A label for the SIM","example":"blue"}},"required":["esim_id","iccid","label"]}},"required":["subscription_id","created_at","metadata","esim"]}},"required":["error","data"]}},"components/schemas/DeleteResponse":{"id":"components/schemas/DeleteResponse","kind":"json-schema","title":"DeleteResponse","data":{"type":"object","properties":{"error":{"type":"boolean","description":"A boolean indicating whether there was an error in the request","example":false},"message":{"type":"string","description":"A message indicating the result of the delete operation","example":"Subscription deleted successfully"}},"required":["error","message"]}},"components/schemas/PlanAttachmentListResponse":{"id":"components/schemas/PlanAttachmentListResponse","kind":"json-schema","title":"PlanAttachmentListResponse","data":{"type":"object","properties":{"error":{"type":"boolean","description":"A boolean indicating whether there was an error in the request","example":false},"data":{"type":"array","description":"An array containing details of the plan attachments","items":{"type":"object","properties":{"plan_attachment_id":{"type":"string","description":"The unique identifier for the plan attachment","example":"efff707e-7db0-4ffe-bef9-5817cabcba3b"},"created_at":{"type":"string","description":"The timestamp when the plan attachment was created","example":"2025-08-17T15:15:59.000Z"},"activation_at":{"type":["string","null"],"description":"The timestamp when the plan attachment was activated (may be null)","example":"2025-08-17T15:15:59.000Z"},"expiration_at":{"type":["string","null"],"description":"The timestamp when the plan attachment will expire (may be null)","example":"2025-08-17T15:15:59.000Z"},"used_allowance":{"type":"object","description":"An object containing usage details","properties":{"dataBytes":{"type":"number","description":"The amount of data used in bytes","example":100}},"required":["dataBytes"]},"state":{"type":"string","description":"The current state of the plan attachment","enum":["PENDING_FOR_FIRST_USE","CREATED","ACTIVE","SUSPENDED","EXPIRED"],"example":"ACTIVE"},"plan":{"type":"object","description":"The plan details associated with this attachment","properties":{"name":{"type":"string","description":"The name of the plan","example":"Usa plan green 1gb 7 days"},"_id":{"type":"string","format":"uuid","description":"The unique identifier for the plan","example":"e90b8df8-fc8a-4010-8d70-13c756017747"},"coverage_id":{"type":"string","format":"uuid","description":"The unique identifier for the coverage area","example":"24648a7f-8281-4af7-8fc0-19b2371b2d1d"},"region_code":{"type":"string","description":"The region code for the plan","example":"US"},"label":{"type":"string","description":"The label or tier of the plan","example":"Green"},"throttling":{"type":"boolean","description":"Indicates whether throttling is enabled for this plan","example":false},"recurring":{"type":"boolean","description":"Indicates whether this is a recurring plan","example":false},"data_mega_bytes":{"type":"integer","description":"The data allowance in megabytes","example":1024},"period_days":{"type":"integer","description":"The duration of the plan in days","example":7}}}},"required":["plan_attachment_id","created_at","used_allowance","state","plan"]}}},"required":["error","data"]}},"components/schemas/PlanAttachmentDetailResponse":{"id":"components/schemas/PlanAttachmentDetailResponse","kind":"json-schema","title":"PlanAttachmentDetailResponse","data":{"type":"object","properties":{"error":{"type":"boolean"},"data":{"$ref":"#/components/schemas/PlanAttachment"}}}},"components/schemas/RecurringPlanInfo":{"id":"components/schemas/RecurringPlanInfo","kind":"json-schema","title":"RecurringPlanInfo","data":{"type":"object","description":"Plan details for recurring plan attachments, extending the base plan with recurring-specific fields","properties":{"name":{"type":"string","description":"The name of the plan","example":"recurring india only package"},"_id":{"type":"string","format":"uuid","description":"The unique identifier for the plan","example":"b3de947a-3ee4-4e80-91b3-8d247038d0dd"},"coverage_id":{"type":"string","format":"uuid","description":"The unique identifier for the coverage area","example":"b124f4ed-3cf0-4d67-a625-8bacbb590006"},"region_code":{"type":"string","description":"The region code for the plan","example":"IN"},"label":{"type":"string","description":"The label or tier of the plan","example":"Green"},"throttling":{"type":"boolean","description":"Indicates whether throttling is enabled for this plan","example":false},"recurring":{"type":"boolean","description":"Indicates whether this is a recurring plan","example":true},"data_mega_bytes":{"type":"string","description":"The data allowance in megabytes","example":"1024"},"period_days":{"type":"integer","description":"The duration of each plan period in days","example":1},"nb_occurrence":{"type":"integer","description":"The total number of occurrences for the recurring plan","example":5},"recurring_periodicity_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of periodicity for the recurring plan. Possible values are 0=Daily, 1=Weekly, 2=Monthly."},"children":[]}]}]}],"example":"0","enum":["0","1","2"]},"recurring_periodicity_frequency":{"type":"integer","description":"The frequency of the recurring billing cycle","example":1}},"required":["name","_id","coverage_id","region_code","label","throttling","recurring","data_mega_bytes","period_days"]}},"components/schemas/PlanAttachmentRecurrence":{"id":"components/schemas/PlanAttachmentRecurrence","kind":"json-schema","title":"PlanAttachmentRecurrence","data":{"type":"object","description":"Recurrence metadata for recurring plan attachments","properties":{"nb_occurrence":{"type":"integer","description":"Total number of occurrences configured for the recurring plan","example":5},"nb_created":{"type":"integer","description":"Number of instances created so far","example":5},"active":{"type":"boolean","description":"Whether the recurrence is currently active","example":true},"recurring_periodicity_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of periodicity for the recurring plan. Possible values are 0=Daily, 1=Weekly, 2=Monthly."},"children":[]}]}]}],"example":"0","enum":["0","1","2"]},"recurring_periodicity_frequency":{"type":"integer","description":"The frequency of the recurring billing cycle","example":1},"start_time":{"type":"string","format":"date-time","description":"The timestamp when the recurrence started","example":"2026-06-06T18:20:37.000Z"},"last_instance_creation_time":{"type":"string","format":"date-time","description":"The timestamp when the last instance was created","example":"2026-06-10T16:05:00.000Z"}},"required":["nb_occurrence","nb_created","active","recurring_periodicity_type","recurring_periodicity_frequency","start_time","last_instance_creation_time"]}},"components/schemas/PlanAttachmentInstance":{"id":"components/schemas/PlanAttachmentInstance","kind":"json-schema","title":"PlanAttachmentInstance","data":{"type":"object","description":"Individual instance of a recurring plan attachment","properties":{"instance_id":{"type":"string","format":"uuid","description":"The unique identifier for this plan instance","example":"72d1ad65-62e4-480e-ad20-4841eb8b1eaf"},"activation_at":{"type":"string","format":"date-time","description":"The timestamp when this instance was activated","example":"2026-06-06T18:20:37.000Z"},"expiration_at":{"type":"string","format":"date-time","description":"The timestamp when this instance will expire","example":"2026-06-07T18:20:37.000Z"},"used_allowance":{"type":"object","description":"Usage details for this instance","properties":{"dataBytes":{"type":"number","description":"The amount of data used in bytes","example":23240775}},"required":["dataBytes"]},"instance_state":{"type":"string","description":"The current state of this plan instance","enum":["PENDING_FOR_FIRST_USE","CREATED","ACTIVE","SUSPENDED","EXPIRED"],"example":"EXPIRED"}},"required":["instance_id","activation_at","expiration_at","used_allowance","instance_state"]}},"components/schemas/RecurringPlanAttachment":{"id":"components/schemas/RecurringPlanAttachment","kind":"json-schema","title":"RecurringPlanAttachment","data":{"type":"object","description":"Plan attachment for recurring plans with recurrence metadata and instances","properties":{"plan_attachment_id":{"type":"string","format":"uuid","description":"The unique identifier for the plan attachment","example":"d31bb405-7725-4eb2-ba2e-5ebc85758a4a"},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the plan attachment was created","example":"2026-06-06T17:46:21.025Z"},"activation_at":{"type":["string","null"],"format":"date-time","description":"The timestamp when the plan attachment was activated (may be null for recurring plans)","example":null},"expiration_at":{"type":["string","null"],"format":"date-time","description":"The timestamp when the plan attachment will expire (may be null for recurring plans)","example":null},"used_allowance":{"type":["object","null"],"description":"An object containing usage details (may be null for recurring plans)","properties":{"dataBytes":{"type":"number","description":"The amount of data used in bytes","example":0}}},"state":{"type":["string","null"],"description":"The current state of the plan attachment (may be null for recurring plans)","enum":["PENDING_FOR_FIRST_USE","CREATED","ACTIVE","SUSPENDED","EXPIRED",null],"example":null},"plan":{"$ref":"#/components/schemas/RecurringPlanInfo"},"recurrence":{"$ref":"#/components/schemas/PlanAttachmentRecurrence"},"instances":{"type":"array","description":"Array of plan instances created for this recurring attachment","items":{"$ref":"#/components/schemas/PlanAttachmentInstance"}}},"required":["plan_attachment_id","created_at","plan","recurrence","instances"]}},"components/schemas/RecurringPlanAttachmentListResponse":{"id":"components/schemas/RecurringPlanAttachmentListResponse","kind":"json-schema","title":"RecurringPlanAttachmentListResponse","data":{"type":"object","description":"Response containing a list of plan attachments that may include both recurring and non-recurring plans","properties":{"error":{"type":"boolean","description":"A boolean indicating whether there was an error in the request","example":false},"data":{"type":"array","description":"An array containing details of plan attachments (may include both recurring and non-recurring)","items":{"oneOf":[{"$ref":"#/components/schemas/PlanAttachment"},{"$ref":"#/components/schemas/RecurringPlanAttachment"}]}}},"required":["error","data"]}},"components/schemas/RecurringPlanAttachmentDetailResponse":{"id":"components/schemas/RecurringPlanAttachmentDetailResponse","kind":"json-schema","title":"RecurringPlanAttachmentDetailResponse","data":{"type":"object","description":"Response containing a single plan attachment that may be either recurring or non-recurring","properties":{"error":{"type":"boolean","description":"A boolean indicating whether there was an error in the request","example":false},"data":{"oneOf":[{"$ref":"#/components/schemas/PlanAttachment"},{"$ref":"#/components/schemas/RecurringPlanAttachment"}]}},"required":["error","data"]}},"components/schemas/SMSResponse":{"id":"components/schemas/SMSResponse","kind":"json-schema","title":"SMSResponse","data":{"type":"object","properties":{"error":{"type":"boolean","description":"Indicates whether an error occurred (true if an error occurred)","example":false},"message":{"type":"string","description":"A message providing additional information about the success response","example":"SMS sent successfully"}},"required":["error","message"]}},"components/schemas/SuspendResponse":{"id":"components/schemas/SuspendResponse","kind":"json-schema","title":"SuspendResponse","data":{"type":"object","properties":{"error":{"type":"boolean","description":"A boolean indicating whether an error occurred during the request","example":false},"message":{"type":"string","description":"A string containing any error message, if applicable","example":"Plan attachment suspended successfully"}},"required":["error","message"]}},"components/schemas/ArchiveResponse":{"id":"components/schemas/ArchiveResponse","kind":"json-schema","title":"ArchiveResponse","data":{"type":"object","properties":{"error":{"type":"boolean","description":"Indicates whether there was an error processing the request","example":false},"message":{"type":"string","description":"A message providing additional information about the request status","example":"Plan archived successfully"}},"required":["error","message"]}},"components/schemas/PlanDetailResponse":{"id":"components/schemas/PlanDetailResponse","kind":"json-schema","title":"PlanDetailResponse","data":{"type":"object","properties":{"error":{"type":"boolean","description":"Indicates whether an error occurred during the request","example":false},"data":{"type":"object","description":"Contains the details of the requested plan","properties":{"plan_name":{"type":"string","description":"Name of the plan","example":"USA Plan"},"plan_id":{"type":"string","description":"The unique identifier of the plan","example":"0a3ee1d6-fe5e-4561-91a0-d4649aaf0754"},"coverage_id":{"type":"string","description":"The ID associated with the plan's coverage","example":"819b05c4-f154-4df9-8fd1-16be3e82f5c6"},"archived_at":{"type":["string","null"],"description":"Timestamp indicating when the plan was archived, if applicable","example":"2025-01-01T00:00:00Z"},"region_code":{"type":"string","description":"The code representing the region for the plan","example":"US"},"label":{"type":"string","description":"A human-readable label for the plan","example":"blue"},"throttling":{"type":"boolean","description":"Indicates if throttling is applied to the plan","example":true},"recurring":{"type":"boolean","description":"Indicates if the plan has a recurring billing cycle","example":true},"archive":{"type":"boolean","description":"Indicates if the plan is archived","example":true},"data_mega_bytes":{"type":"integer","description":"The amount of data in megabytes included in the plan","example":1024},"period_days":{"type":"integer","description":"The duration of the plan in days","example":1},"throttling_threshold1_perc":{"type":"integer","description":"The percentage threshold for first throttling","example":10,"minimum":0,"maximum":100},"throttling_threshold1_limit":{"type":"string","description":"The limit associated with the first throttling threshold","example":"3072","enum":["32","64","128","256","384","512","1024","3072","5120","7680","10240","20480"]},"throttling_threshold2_perc":{"type":"integer","description":"The percentage threshold for second throttling","example":10,"minimum":0,"maximum":100},"throttling_threshold2_limit":{"type":"string","description":"The limit associated with the second throttling threshold","example":"3072","enum":["32","64","128","256","384","512","1024","3072","5120","7680","10240","20480"]},"throttling_threshold3_perc":{"type":"integer","description":"The percentage threshold for third throttling","example":10,"minimum":0,"maximum":100},"throttling_threshold3_limit":{"type":"string","description":"The limit associated with the third throttling threshold","example":"3072","enum":["32","64","128","256","384","512","1024","3072","5120","7680","10240","20480"]},"nb_occurrence":{"type":"integer","description":"The number of occurrences for the plan","example":2},"recurring_periodicity_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of periodicity for the recurring plan. Possible values are 0=Daily, 1=Weekly, 2=Monthly."},"children":[]}]}]}],"example":"2"},"recurring_periodicity_frequency":{"type":"integer","description":"The frequency of the recurring billing cycle","example":0}},"required":["plan_id","coverage_id","region_code","label","throttling","recurring","archive","data_mega_bytes","period_days","archived_at","plan_name"]}},"required":["error","data"]}},"components/schemas/UnauthorizedResponse":{"id":"components/schemas/UnauthorizedResponse","kind":"json-schema","title":"UnauthorizedResponse","data":{"type":"object","properties":{"error":{"type":"boolean","description":"Indicates whether an error occurred during the request","example":true},"message":{"type":"string","description":"Error message describing the unauthorized access","example":"Unauthorized: API key is missing"}},"required":["error","message"]}},"components/schemas/WebhookEvent":{"id":"components/schemas/WebhookEvent","kind":"json-schema","title":"WebhookEvent","data":{"type":"object","required":["type","timestamp","data"],"properties":{"type":{"type":"string","description":"The type of webhook event","example":"attachment.allowanceConsumed"},"timestamp":{"type":"integer","description":"The unix timestamp at which this event was fired","example":1730474606},"data":{"type":"object","description":"Event-specific data payload"}}}},"components/schemas/AllowanceConsumedEvent":{"id":"components/schemas/AllowanceConsumedEvent","kind":"json-schema","title":"AllowanceConsumedEvent","data":{"allOf":[{"$ref":"#/components/schemas/WebhookEvent"},{"type":"object","properties":{"type":{"type":"string","default":"attachment.allowanceConsumed","example":"attachment.allowanceConsumed"},"data":{"type":"object","required":["usagePercentage","dataUsageBytes","esim","planId","attachmentId"],"properties":{"usagePercentage":{"type":"number","minimum":0,"maximum":100,"description":"The percentage of data allowance consumed","example":80},"dataUsageBytes":{"type":"number","description":"The amount of data consumed in bytes","example":1231230},"esim":{"type":"string","description":"The eSIM identifier","example":"8937103400004164763"},"planId":{"type":"string","description":"The plan identifier","example":"33de44b0-5103-45ea-9723-0a7aa104c76a"},"attachmentId":{"type":"string","description":"The attachment identifier","example":"a1ac5a45-e05b-4728-9253-17c54fc1c5ff"}}}}}]}},"components/schemas/LocationChangedEvent":{"id":"components/schemas/LocationChangedEvent","kind":"json-schema","title":"LocationChangedEvent","data":{"allOf":[{"$ref":"#/components/schemas/WebhookEvent"},{"type":"object","properties":{"type":{"type":"string","default":"subscription.esim.locationChanged","example":"subscription.esim.locationChanged"},"data":{"type":"object","required":["esim","countryIso2"],"properties":{"esim":{"type":"string","description":"The eSIM identifier","example":"8937204017179541233"},"countryIso2":{"type":"string","description":"The ISO 2-letter country code","example":"IT"}}}}}]}},"components/schemas/SMDPInfo":{"id":"components/schemas/SMDPInfo","kind":"json-schema","title":"SMDPInfo","data":{"type":"object","required":["iccid","state_history"],"properties":{"iccid":{"type":"string","description":"The ICCID of the SIM","example":"8937103400004164763"},"state_history":{"type":"array","description":"History of state changes for the eSIM profile","items":{"type":"object","properties":{"state":{"type":"string","description":"The state of the eSIM profile","enum":["BPP Installation","Enable","Disable","Delete"],"example":"Enable"},"modification_result":{"type":"string","description":"Result of the state modification","example":"SUCCESS"},"modified_at":{"type":"string","format":"date-time","description":"Timestamp when the state was modified","example":"2025-10-28T20:23:59.000Z"}}}},"current_status":{"type":"string","description":"Current status of the eSIM profile","enum":["BPP Installation","Enable","Disable","Delete"],"example":"Enable"}}}},"components/schemas/SMDPInfoResponse":{"id":"components/schemas/SMDPInfoResponse","kind":"json-schema","title":"SMDPInfoResponse","data":{"type":"object","properties":{"error":{"type":"boolean","example":false},"data":{"$ref":"#/components/schemas/SMDPInfo"}}}},"components/schemas/Operator":{"id":"components/schemas/Operator","kind":"json-schema","title":"Operator","data":{"type":"object","properties":{"operator_id":{"type":"string","description":"The unique identifier for the operator","example":"2dea792a-2dea-492c-815d-8fb826be8d49"},"name":{"type":"string","description":"The name of the operator","example":"AT&T USA"},"iso2":{"type":"string","description":"ISO 2-letter country code","example":"US"},"supported_rats":{"type":"array","description":"List of supported Radio Access Technologies (RATs)","items":{"type":"string"},"example":["4G","5G"]},"mcc_mnc":{"type":"array","description":"List of MCC-MNC codes associated with the operator","items":{"type":"string"},"example":["310-680","310-410"]}},"required":["operator_id","name","iso2","supported_rats","mcc_mnc"]}},"components/schemas/OperatorListResponse":{"id":"components/schemas/OperatorListResponse","kind":"json-schema","title":"OperatorListResponse","data":{"type":"object","properties":{"error":{"type":"boolean","description":"Indicates if there was an error in the request","example":false},"data":{"type":"array","description":"An array of operator objects returned by the request","items":{"$ref":"#/components/schemas/Operator"}}},"required":["error","data"]}},"components/schemas/OperatorDetailResponse":{"id":"components/schemas/OperatorDetailResponse","kind":"json-schema","title":"OperatorDetailResponse","data":{"type":"object","properties":{"error":{"type":"boolean","description":"Indicates whether an error occurred during the request","example":false},"data":{"$ref":"#/components/schemas/Operator"}},"required":["error","data"]}},"components/schemas/CustomRegionCoverageProfileResponse":{"id":"components/schemas/CustomRegionCoverageProfileResponse","kind":"json-schema","title":"CustomRegionCoverageProfileResponse","data":{"type":"object","properties":{"error":{"type":"boolean","description":"Indicates whether an error occurred during the request","example":false},"data":{"type":"object","properties":{"coverage_id":{"type":"string","description":"The unique identifier for the coverage profile","example":"85089a51-801c-4737-bd8b-f542705712bf"},"region_code":{"type":"string","description":"The generated region code for the custom region","example":"R33BHT"},"region_name":{"type":"string","description":"The name of the custom region","example":"Usa and Mexico Regional Plan"},"iso2_list":{"type":"array","description":"List of ISO 2-letter country codes included in the custom region","items":{"type":"string"},"example":["US","MX"]}},"required":["coverage_id","region_code","region_name","iso2_list"]}},"required":["error","data"]}},"components/schemas/SubscriptionLocationResponse":{"id":"components/schemas/SubscriptionLocationResponse","kind":"json-schema","title":"SubscriptionLocationResponse","data":{"type":"object","properties":{"error":{"type":"boolean","description":"Indicates if there was an error with the request","example":false},"last_operator":{"type":["object","null"],"description":"Information about the last operator the SIM was connected to. Returns null if the SIM has not been active in the last 7 days.","properties":{"country":{"type":"string","description":"The country where the SIM was last active","example":"Jordan"},"country_alpha_2":{"type":"string","description":"The 2-letter ISO country code","example":"jo"},"operator":{"type":"string","description":"The mobile operator name","example":"ZAIN Jordan"},"event_time":{"type":"string","format":"date-time","description":"The timestamp when the event occurred","example":"2022-11-21T23:08:51.333+01:00"},"rat":{"type":"string","description":"The Radio Access Technology used","example":"4G - LTE"},"imei":{"type":"string","description":"The IMEI of the device","example":"356703224849612"}},"required":["country","country_alpha_2","operator","event_time","rat","imei"]}},"required":["error","last_operator"]}},"components/schemas/SubscriptionGeoLocationResponse":{"id":"components/schemas/SubscriptionGeoLocationResponse","kind":"json-schema","title":"SubscriptionGeoLocationResponse","data":{"oneOf":[{"type":"object","description":"Response when location data is available","properties":{"error":{"type":"boolean","description":"Indicates if there was an error with the request","example":false},"data":{"type":"object","description":"Geographic location data for the subscriber","properties":{"latitude":{"type":"number","description":"The latitude coordinate of the subscriber's last known location","example":41.63565},"longitude":{"type":"number","description":"The longitude coordinate of the subscriber's last known location","example":41.60746},"accuracy":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The estimated median error in meters (radius with 50% confidence level)"},"children":[]}]}]}],"example":2000},"date_time":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The timestamp (UTC+0) when the subscriber was last seen by the system"},"children":[]}]}]}],"example":"2026-04-17T19:43:25Z"}},"required":["latitude","longitude","accuracy","date_time"]}},"required":["error","data"]},{"type":"object","description":"Response when location data is not available","properties":{"error":{"type":"boolean","description":"Indicates if there was an error with the request","example":false},"message":{"type":"string","description":"Message explaining why location data is not available","example":"No known location for this ICCID"}},"required":["error","message"]}]}},"components/schemas/UsageOverPeriodRequest":{"id":"components/schemas/UsageOverPeriodRequest","kind":"json-schema","title":"UsageOverPeriodRequest","data":{"type":"object","required":["period"],"properties":{"period":{"type":"object","description":"The time period for which to retrieve usage data. Maximum period is 7 days including start and end dates.","required":["start","end"],"properties":{"start":{"type":"string","format":"date","description":"Start date of the period (YYYY-MM-DD format). Must come before the end date.","example":"2026-04-13"},"end":{"type":"string","format":"date","description":"End date of the period (YYYY-MM-DD format). Maximum 7 days from start date (inclusive).","example":"2026-04-19"}}}}}},"components/schemas/UsageOverPeriodResponse":{"id":"components/schemas/UsageOverPeriodResponse","kind":"json-schema","title":"UsageOverPeriodResponse","data":{"type":"object","properties":{"error":{"type":"boolean","description":"Indicates whether there was an error processing the request","example":false},"data":{"type":"object","description":"Contains the usage data for the specified period","properties":{"iccid":{"type":"string","description":"The ICCID of the subscription","example":"8948010000094659307"},"start_date":{"type":"string","format":"date","description":"Start date of the usage period","example":"2026-04-13"},"end_date":{"type":"string","format":"date","description":"End date of the usage period","example":"2026-04-19"},"total_usage":{"type":"object","description":"Aggregated usage data for the entire period","properties":{"total_bytes":{"type":"integer","description":"Total data usage in bytes","example":3494556039},"total_gb":{"type":"string","description":"Total data usage in gigabytes (formatted)","example":"3.25"},"reseller_cost":{"type":"number","description":"Total reseller cost for the usage","example":2.1099239888152237}},"required":["total_bytes","total_gb","reseller_cost"]},"usage_per_day":{"type":"array","description":"Daily breakdown of usage data","items":{"type":"object","properties":{"date":{"type":"string","format":"date","description":"The date for this usage entry","example":"2026-04-13"},"total_bytes":{"type":"integer","description":"Total data usage in bytes for this day","example":271708229},"total_gb":{"type":"string","description":"Total data usage in gigabytes for this day (formatted)","example":"0.25"},"reseller_cost":{"type":"number","description":"Reseller cost for this day's usage","example":1.6945269085923083},"countries":{"type":"array","description":"Usage breakdown by country for this day","items":{"type":"object","properties":{"mcc":{"type":"integer","description":"Mobile Country Code","example":602},"country_name":{"type":"string","description":"Name of the country","example":"Egypt"},"country_code":{"type":"string","description":"ISO 3166-1 alpha-2 country code","example":"eg"},"data_usage_bytes":{"type":"integer","description":"Data usage in bytes for this country","example":2129053891},"data_usage_gb":{"type":"string","description":"Data usage in gigabytes for this country (formatted)","example":"1.98"},"operators":{"type":"array","description":"Usage breakdown by mobile network operator","items":{"type":"object","properties":{"mnc":{"type":"integer","description":"Mobile Network Code","example":3},"operator_name":{"type":"string","description":"Name of the mobile network operator","example":"Etisalat Egypt"},"data_usage_bytes":{"type":"integer","description":"Data usage in bytes for this operator","example":2129053891},"data_usage_gb":{"type":"string","description":"Data usage in gigabytes for this operator (formatted)","example":"1.98"}},"required":["mnc","operator_name","data_usage_bytes","data_usage_gb"]}}},"required":["mcc","country_name","country_code","data_usage_bytes","data_usage_gb","operators"]}}},"required":["date","total_bytes","total_gb","reseller_cost","countries"]}},"usage_per_country":{"type":"array","description":"Aggregated usage data by country for the entire period","items":{"type":"object","properties":{"mcc":{"type":"integer","description":"Mobile Country Code","example":602},"country_name":{"type":"string","description":"Name of the country","example":"Egypt"},"country_code":{"type":"string","description":"ISO 3166-1 alpha-2 country code","example":"eg"},"data_usage_bytes":{"type":"integer","description":"Total data usage in bytes for this country","example":2650971109},"data_usage_gb":{"type":"string","description":"Total data usage in gigabytes for this country (formatted)","example":"2.47"},"operators":{"type":"array","description":"Usage breakdown by mobile network operator","items":{"type":"object","properties":{"mnc":{"type":"integer","description":"Mobile Network Code","example":3},"operator_name":{"type":"string","description":"Name of the mobile network operator","example":"Etisalat Egypt"},"data_usage_bytes":{"type":"integer","description":"Total data usage in bytes for this operator","example":2650971109},"data_usage_gb":{"type":"string","description":"Total data usage in gigabytes for this operator (formatted)","example":"2.47"}},"required":["mnc","operator_name","data_usage_bytes","data_usage_gb"]}}},"required":["mcc","country_name","country_code","data_usage_bytes","data_usage_gb","operators"]}}},"required":["iccid","start_date","end_date","total_usage","usage_per_day","usage_per_country"]}},"required":["error","data"]}},"components/schemas/NetworkEventsRequest":{"id":"components/schemas/NetworkEventsRequest","kind":"json-schema","title":"NetworkEventsRequest","data":{"type":"object","required":["period"],"properties":{"period":{"type":"object","description":"The time period for which to retrieve network events. Maximum period is 7 days including start and end dates.","required":["start","end"],"properties":{"start":{"type":"string","format":"date","description":"Start date of the period (YYYY-MM-DD format). Must come before the end date.","example":"2026-08-15"},"end":{"type":"string","format":"date","description":"End date of the period (YYYY-MM-DD format). Maximum 7 days from start date (inclusive).","example":"2026-08-21"}}}}}},"components/schemas/NetworkEventsResponse":{"id":"components/schemas/NetworkEventsResponse","kind":"json-schema","title":"NetworkEventsResponse","data":{"type":"object","properties":{"error":{"type":"boolean","description":"Indicates whether there was an error processing the request","example":false},"label":{"$ref":"#/components/schemas/Label"},"data":{"type":"object","description":"Contains the network events recorded for the subscription during the specified period","properties":{"2g_or_3g_attach":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Network attach events for 2G/3G connections. Used to determine whether the eSIM"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"was able to attach to a 2G/3G network. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"result"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"ok\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the attach succeeded."},"children":[]}]}]}],"items":{"type":"object","properties":{"event_time":{"type":"string","format":"date-time","description":"Timestamp (UTC) when the attach event occurred","example":"2026-08-17T21:51:27Z"},"country_name":{"type":"string","description":"Name of the country where the event occurred","example":"Morocco"},"country_alpha_2":{"type":"string","description":"ISO 3166-1 alpha-2 country code","example":"ma"},"operator":{"type":"string","description":"Name of the mobile network operator","example":"Inwi Morocco"},"result":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Result of the attach attempt. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"ok\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the eSIM successfully attached to the network."},"children":[]}]}]}],"example":"ok"}},"required":["event_time","country_name","country_alpha_2","operator","result"]}},"4g_or_5g_attach":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Network attach events for 4G/5G connections. Used to determine whether the eSIM"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"was able to attach to a 4G/5G network. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"oper_allowed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the attach succeeded."},"children":[]}]}]}],"items":{"type":"object","properties":{"event_time":{"type":"string","format":"date-time","description":"Timestamp (UTC) when the attach event occurred","example":"2026-08-20T22:54:25Z"},"country_name":{"type":"string","description":"Name of the country where the event occurred","example":"Morocco"},"country_alpha_2":{"type":"string","description":"ISO 3166-1 alpha-2 country code","example":"ma"},"operator":{"type":"string","description":"Name of the mobile network operator","example":"Inwi Morocco"},"oper_allowed":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the operator allowed the eSIM to attach to the network. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the eSIM successfully attached."},"children":[]}]}]}],"example":true}},"required":["event_time","country_name","country_alpha_2","operator","oper_allowed"]}},"data_usage":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data session events. Used to determine whether the eSIM, once attached to the network,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"was able to actually use data. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"result"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"success\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the data session succeeded."},"children":[]}]}]}],"items":{"type":"object","properties":{"event_time":{"type":"string","format":"date-time","description":"Timestamp (UTC) when the data session event occurred","example":"2026-08-21T06:32:32Z"},"request_type":{"type":"string","description":"Type of data session request","enum":["Init","Update","Term"],"example":"Update"},"country_name":{"type":"string","description":"Name of the country where the event occurred","example":"Morocco"},"country_alpha_2":{"type":"string","description":"ISO 3166-1 alpha-2 country code","example":"ma"},"operator":{"type":"string","description":"Name of the mobile network operator","example":"Inwi Morocco"},"result":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Result of the data session request. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"success\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the eSIM was able to use data."},"children":[]}]}]}],"example":"success"}},"required":["event_time","request_type","country_name","country_alpha_2","operator","result"]}}},"required":["2g_or_3g_attach","4g_or_5g_attach","data_usage"]}},"required":["error","data"]}},"components/schemas/WalletBalanceModifyRequest":{"id":"components/schemas/WalletBalanceModifyRequest","kind":"json-schema","title":"WalletBalanceModifyRequest","data":{"type":"object","required":["amount"],"properties":{"amount":{"type":"number","description":"Positive value for credit, negative for debit","example":100},"set_balance":{"type":"boolean","description":"When true, forces balance to the specified amount instead of adding/subtracting","default":false,"example":false},"description":{"type":"string","description":"Free-text reason for the transaction (max 512 characters)","maxLength":512,"example":"Top up balance"}}}},"components/schemas/WalletMobilePlanRequest":{"id":"components/schemas/WalletMobilePlanRequest","kind":"json-schema","title":"WalletMobilePlanRequest","data":{"type":"object","required":["apply","label"],"properties":{"apply":{"type":"boolean","description":"true to apply the mobile plan, false to remove it","example":true},"label":{"type":"string","description":"eSIM label to target","example":"Green"},"iccid":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Target eSIM ICCID (optional - auto-selected if omitted when apply=true)"},"children":[]}]}]}],"example":"8948010010036795085"}}}},"components/schemas/WalletTransaction":{"id":"components/schemas/WalletTransaction","kind":"json-schema","title":"WalletTransaction","data":{"type":"object","required":["transaction_id","transaction_type","amount","set_balance","created_at"],"properties":{"transaction_id":{"type":"string","description":"Unique transaction identifier","example":"82bee681-7780-4b3b-9442-fe0899f19634"},"transaction_type":{"type":"string","enum":["CREDIT","DEBIT","SET"],"description":"Type of transaction","example":"CREDIT"},"amount":{"type":"number","description":"Transaction amount","example":100},"set_balance":{"type":"boolean","description":"Whether this was a set balance operation","example":false},"description":{"type":"string","description":"Transaction description","example":"Top up balance"},"created_at":{"type":"string","format":"date-time","description":"Transaction creation timestamp","example":"2025-01-01T10:00:00.000Z"}}}},"components/schemas/WalletPlanInfo":{"id":"components/schemas/WalletPlanInfo","kind":"json-schema","title":"WalletPlanInfo","data":{"type":"object","required":["applied_to_esim"],"properties":{"id":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"Wallet plan ID (null if not configured)","example":3},"applied_to_esim":{"type":"boolean","description":"Whether the plan is currently applied to the eSIM","example":true}}}},"components/schemas/WalletSimMetadata":{"id":"components/schemas/WalletSimMetadata","kind":"json-schema","title":"WalletSimMetadata","data":{"type":"object","required":["esim_id","iccid","lpa","created_at","used","mobile_plan_applied","transaction_count"],"properties":{"esim_id":{"type":"string","description":"Unique eSIM identifier","example":"e2bee681-7780-4b3b-9442-fe0899f19634"},"iccid":{"type":"string","description":"eSIM ICCID","example":"8948010010036795001"},"lpa":{"type":"string","description":"LPA activation code","example":"LPA:1$rsp-eu.redteamobile.com$ABCDEF1234567890"},"created_at":{"type":"string","format":"date-time","description":"eSIM creation timestamp","example":"2025-03-15T09:00:00.000Z"},"used":{"type":"boolean","description":"Whether the eSIM has been used","example":true},"mobile_plan_applied":{"type":"boolean","description":"Whether a mobile plan is currently applied","example":true},"transaction_count":{"type":"integer","description":"Total number of wallet transactions","example":3},"last_transaction_at":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Timestamp of the last transaction (null if no transactions)","example":"2025-04-01T12:00:00.000Z"}}}},"components/schemas/WalletBalanceModifyResponse":{"id":"components/schemas/WalletBalanceModifyResponse","kind":"json-schema","title":"WalletBalanceModifyResponse","data":{"type":"object","required":["error","data"],"properties":{"error":{"type":"boolean","description":"Indicates whether an error occurred","example":false},"data":{"type":"object","required":["transaction_id","iccid","transaction_type","amount","set_balance","created_at"],"properties":{"transaction_id":{"type":"string","description":"Unique transaction identifier","example":"82bee681-7780-4b3b-9442-fe0899f19634"},"iccid":{"type":"string","description":"eSIM ICCID","example":"8948010010036795085"},"transaction_type":{"type":"string","enum":["CREDIT","DEBIT","SET"],"description":"Type of transaction","example":"CREDIT"},"amount":{"type":"number","description":"Transaction amount","example":100},"set_balance":{"type":"boolean","description":"Whether this was a set balance operation","example":false},"description":{"type":"string","description":"Transaction description","example":"Top up balance"},"created_at":{"type":"string","format":"date-time","description":"Transaction creation timestamp","example":"2025-01-01T10:00:00.000Z"}}}}}},"components/schemas/WalletBalanceGetResponse":{"id":"components/schemas/WalletBalanceGetResponse","kind":"json-schema","title":"WalletBalanceGetResponse","data":{"type":"object","required":["error","data"],"properties":{"error":{"type":"boolean","description":"Indicates whether an error occurred","example":false},"data":{"type":"object","required":["iccid","current_balance","wallet_plan","transactions"],"properties":{"iccid":{"type":"string","description":"eSIM ICCID","example":"8948010010036795085"},"current_balance":{"type":"number","description":"Current wallet balance","example":50},"wallet_plan":{"$ref":"#/components/schemas/WalletPlanInfo"},"transactions":{"type":"array","description":"Full transaction history","items":{"$ref":"#/components/schemas/WalletTransaction"}}}}}}},"components/schemas/WalletMobilePlanResponse":{"id":"components/schemas/WalletMobilePlanResponse","kind":"json-schema","title":"WalletMobilePlanResponse","data":{"type":"object","required":["error","data"],"properties":{"error":{"type":"boolean","description":"Indicates whether an error occurred","example":false},"data":{"type":"object","required":["iccid","mobile_plan_applied"],"properties":{"iccid":{"type":"string","description":"eSIM ICCID","example":"8948010010036795085"},"mobile_plan_applied":{"type":"boolean","description":"Whether the mobile plan is now applied","example":true},"id":{"oneOf":[{"type":"number"},{"type":"null"}],"description":"Wallet plan ID (null if plan was removed)","example":3}}}}}},"components/schemas/WalletSimsListResponse":{"id":"components/schemas/WalletSimsListResponse","kind":"json-schema","title":"WalletSimsListResponse","data":{"type":"object","required":["error","data","next_page"],"properties":{"error":{"type":"boolean","description":"Indicates whether an error occurred","example":false},"data":{"type":"array","description":"List of wallet-enabled eSIMs","items":{"$ref":"#/components/schemas/WalletSimMetadata"}},"next_page":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"Base64-encoded cursor for the next page (null if no more pages)","example":null}}}},"components/schemas/ErrorResponse":{"id":"components/schemas/ErrorResponse","kind":"json-schema","title":"ErrorResponse","data":{"type":"object","required":["error","message"],"properties":{"error":{"type":"boolean","description":"Indicates whether an error occurred","example":true},"message":{"type":"string","description":"Error message describing what went wrong","example":"Invalid request body"},"issues":{"type":"array","description":"Detailed validation issues (present for 400 errors)","items":{"type":"object","properties":{"path":{"type":"array","items":{"type":"string"}},"message":{"type":"string"}}}}}}},"components/schemas/ListCoverageProfile":{"id":"components/schemas/ListCoverageProfile","kind":"json-schema","title":"ListCoverageProfile","data":{"type":"object","properties":{"error":{"type":"boolean","example":false},"data":{"type":"array","items":{"$ref":"#/components/schemas/CoverageProfile"}}},"required":["error","data"]}},"components/schemas/CoverageProfileDetailResponse":{"id":"components/schemas/CoverageProfileDetailResponse","kind":"json-schema","title":"CoverageProfileDetailResponse","data":{"type":"object","properties":{"error":{"type":"boolean","description":"Indicates whether an error occurred during the request","example":false},"data":{"$ref":"#/components/schemas/CoverageProfile"}},"required":["error","data"]}},"components/schemas/Label":{"id":"components/schemas/Label","kind":"json-schema","title":"Label","data":{"type":"string","enum":["Green","Aqua","Blue","Voilet","Red","Grey","Orange"]}},"components/schemas/SIMDetailResponse":{"id":"components/schemas/SIMDetailResponse","kind":"json-schema","title":"SIMDetailResponse","data":{"type":"object","properties":{"error":{"type":"boolean"},"data":{"$ref":"#/components/schemas/ESIM"}}}},"components/schemas/ThrottlingThresholdLimit":{"id":"components/schemas/ThrottlingThresholdLimit","kind":"json-schema","title":"ThrottlingThresholdLimit","data":{"type":"string","example":"3072","description":"Limit to apply when the subscriber is crossing the first threshold. It's units is Kbit/sec. Required if throttling is true.","enum":["128","256","384","512","1024","3072","5120","7680","10240","20480"]}},"components/schemas/ThrottlingThresholdSecondLimit":{"id":"components/schemas/ThrottlingThresholdSecondLimit","kind":"json-schema","title":"ThrottlingThresholdSecondLimit","data":{"type":"string","example":"3072","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit to apply when the subscriber is crossing the second threshold. It's units is Kbit/sec. Required if throttling_threshold2_perc is present in request."},"children":[]}]}]}],"enum":["128","256","384","512","1024","3072","5120","7680","10240","20480"]}},"components/schemas/ThrottlingThresholdThirdLimit":{"id":"components/schemas/ThrottlingThresholdThirdLimit","kind":"json-schema","title":"ThrottlingThresholdThirdLimit","data":{"type":"string","example":"3072","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limit to apply when the subscriber is crossing the third threshold. It's units is Kbit/sec. Required if throttling_threshold3_perc is present in request."},"children":[]}]}]}],"enum":["128","256","384","512","1024","3072","5120","7680","10240","20480"]}},"components/schemas/PlanDeleteSuccessResponse":{"id":"components/schemas/PlanDeleteSuccessResponse","kind":"json-schema","title":"PlanDeleteSuccessResponse","data":{"type":"object","properties":{"error":{"type":"boolean","description":"Indicates if an error occurred.","example":false},"message":{"type":"string","description":"A message indicating the result of the operation.","example":"Plan deleted successfully"}}}},"components/schemas/UnauthorizedDeleteResponse":{"id":"components/schemas/UnauthorizedDeleteResponse","kind":"json-schema","title":"UnauthorizedDeleteResponse","data":{"type":"object","properties":{"error":{"type":"boolean","description":"A boolean indicating whether there was an error in the request","example":true},"message":{"type":"string","description":"A message indicating the reason for the unauthorized delete response","example":"Cannot delete a subscription whose esim was installed on a device"}},"required":["error","message"]}},"components/schemas/UnArchiveResponse":{"id":"components/schemas/UnArchiveResponse","kind":"json-schema","title":"UnArchiveResponse","data":{"type":"object","properties":{"error":{"type":"boolean","description":"Indicates whether there was an error processing the request","example":false},"message":{"type":"string","description":"A message providing additional information about the request status","example":"Plan unarchived successfully"}},"required":["error","message"]}},"components/schemas/NoAvailableESIMResponse":{"id":"components/schemas/NoAvailableESIMResponse","kind":"json-schema","title":"NoAvailableESIMResponse","data":{"type":"object","properties":{"error":{"type":"boolean","example":true},"message":{"type":"string","example":"No available eSIM record found for the specified plan label"}},"required":["error","message"]}},"components/schemas/PlanAttachment":{"id":"components/schemas/PlanAttachment","kind":"json-schema","title":"PlanAttachment","data":{"type":"object","properties":{"plan_attachment_id":{"type":"string","format":"uuid","example":"ba3b527f-4a01-42e2-892a-fff6d217217e"},"created_at":{"type":"string","format":"date-time","example":"2025-08-30T08:00:18.681Z"},"activation_at":{"type":["string","null"],"format":"date-time","example":"2025-08-30T08:00:18.681Z"},"expiration_at":{"type":["string","null"],"format":"date-time","example":"2025-08-30T08:00:18.681Z"},"used_allowance":{"type":"object","properties":{"dataBytes":{"type":"number","example":100}}},"state":{"type":"string","example":"CREATED"},"plan":{"type":"object","properties":{"name":{"type":"string","example":"Usa plan green 1gb 7 days"},"_id":{"type":"string","format":"uuid","example":"e90b8df8-fc8a-4010-8d70-13c756017747"},"coverage_id":{"type":"string","format":"uuid","example":"24648a7f-8281-4af7-8fc0-19b2371b2d1d"},"region_code":{"type":"string","example":"US"},"label":{"type":"string","example":"Green"},"throttling":{"type":"boolean","example":false},"recurring":{"type":"boolean","example":false},"data_mega_bytes":{"type":"integer","example":1024},"period_days":{"type":"integer","example":7}}}}}},"components/schemas/SendSMSBadGatewayResponse":{"id":"components/schemas/SendSMSBadGatewayResponse","kind":"json-schema","title":"SendSMSBadGatewayResponse","data":{"type":"object","properties":{"error":{"type":"boolean","description":"Indicates whether an error occurred (true if an error occurred)","example":true},"message":{"type":"string","description":"A message providing additional information about the failure response","example":"SMS Delivery Failed"}},"required":["error","message"]}},"schema_21":{"kind":"json-schema","data":{"type":"object","required":["plan_id","metadata"],"properties":{"iccid":{"type":"string","example":"8948010000031324502","description":"ICCID of the SIM (eSIM or Physical SIM). If not provided, the API will automatically select a free eSIM for the specified plan label. If no free eSIM is available for that label, a 404 error will be returned.\n"},"metadata":{"type":"string","example":"usa recurring plan"},"plan_id":{"type":"string","example":"0a3ee1d6-fe5e-4561-91a0-d4649aaf0754"},"active_period":{"type":["object","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional activation window for the subscription."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Non‑recurring plans"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active_period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is optional."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active_period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"both"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are required."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values are used as the start and end"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"date and time for the active period of the package and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"override"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" any validity period configured in the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"plan."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active_period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided, the package uses"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the default behavior: activation at first use."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recurring plans"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active_period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is optional."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active_period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is optional."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided for a recurring plan, it is ignored."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active_period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provided, the recurring"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscription also uses the default behavior: activation at"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"first use."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a Start date is provided for a recurring plan:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start date in the past (maximum 24 hours): the first"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"subscriber package is created immediately."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start date in the future but within the next 12 hours: the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"first subscriber package is also created immediately."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start date more than 12 hours in the future: no subscriber"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"package is created immediately; the first subscriber package"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will be created by the system 12 hours before its"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"activation time."},"children":[]}]}]}]}],"properties":{"start":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Desired activation start time (ISO 8601, UTC)."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Non‑recurring plans"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active_period"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is provided and must be sent together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recurring plans"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active_period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"provided. You may send only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"example":"2025-12-10T15:03:28.533603"},"end":{"type":["string","null"],"format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Desired expiration time (ISO 8601, UTC)."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Non‑recurring plans"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active_period"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recurring plans"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": optional, but ignored when provided."},"children":[]}]}]}]}],"example":"2025-12-20T15:03:28.533603"}}}}},"id":"schema_21"},"schema_22":{"kind":"json-schema","data":{"type":"string"},"id":"schema_22"},"schema_23":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/PlanAttachmentListResponse"},{"$ref":"#/components/schemas/RecurringPlanAttachmentListResponse"}]},"id":"schema_23"},"schema_24":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/PlanAttachmentDetailResponse"},{"$ref":"#/components/schemas/RecurringPlanAttachmentDetailResponse"}]},"id":"schema_24"},"schema_25":{"kind":"json-schema","data":{"type":"object","required":["from","message"],"properties":{"from":{"type":"string","example":"tellisim"},"message":{"type":"string","example":"test message"}}},"id":"schema_25"},"schema_26":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"boolean","example":true},"message":{"type":"string","example":"Location data is only available for Green label"}}},"id":"schema_26"},"schema_27":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"boolean","example":true},"message":{"type":"string","example":"Subscription not found for ICCID"}}},"id":"schema_27"},"schema_28":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"boolean","example":true},"message":{"type":"string","example":"Invalid period: maximum period is 7 days including start and end dates"}}},"id":"schema_28"},"schema_29":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"boolean","example":true},"message":{"type":"string","example":"Date range must be between 0 and 7 days"}}},"id":"schema_29"},"schema_30":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_30"},"schema_31":{"kind":"json-schema","data":{"type":"string","minimum":1,"maximum":25,"default":10},"id":"schema_31"},"schema_32":{"kind":"json-schema","data":{"$ref":"#/components/schemas/Label"},"id":"schema_32"},"schema_33":{"kind":"json-schema","data":{"type":"object","required":["coverage_id","data_MBs","name","recurring","throttling","period_days"],"properties":{"coverage_id":{"type":"string","example":"819b05c4-f154-4df9-8fd1-16be3e82f5c6","description":"coverage id of the region."},"data_MBs":{"type":"number","example":1024,"description":"The amount of MBs you want in the plan","minimum":1},"name":{"type":"string","example":"test1 recurring and throttling package","description":"Name of the plan which can be any thing you like."},"period_days":{"type":"number","example":1,"minimum":1,"maximum":1825,"description":"plan validity in days"},"recurring":{"type":"boolean","example":true,"description":"Set to true if you want the plan to be recurring"},"throttling":{"type":"boolean","example":true,"description":"Set to true if you want the plan to be throttled"},"nb_occurrence":{"type":"number","example":2,"description":"The number of occurrences for the plan. Required if recurring is true.","minimum":2,"maximum":550},"recurring_periodicity_type":{"type":"string","example":"0","enum":["0","1","2"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recurring periodicity type. Possible values are 0=Daily, 1=Weekly, 2=Monthly. Required if recurring is true."},"children":[]}]}]}]},"recurring_periodicity_frequency":{"type":"number","example":2,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Along with recurring_periodicity_type will determine the frequency at which the subscriber will receive its packages. For example recurring_periodicity_frequency=0 and recurring_periodicity_frequency=2, the subscriber is going to receive a package every 2 days. Required if recurring is true."},"children":[]}]}]}]},"throttling_threshold1_perc":{"type":"number","example":50,"minimum":0,"maximum":100,"description":"First threshold for throttling, in percentage of the total volume of the package. Required if throttling is true."},"throttling_threshold1_limit":{"$ref":"#/components/schemas/ThrottlingThresholdLimit"},"throttling_threshold2_perc":{"type":"number","example":90,"minimum":0,"maximum":100,"description":"Second threshold for throttling, in percentage of the total volume of the package. Required if throttling is true."},"throttling_threshold2_limit":{"$ref":"#/components/schemas/ThrottlingThresholdSecondLimit"},"throttling_threshold3_perc":{"type":"number","example":100,"minimum":0,"maximum":100,"description":"Third threshold for throttling, in percentage of the total volume of the package. Required if throttling is true."},"throttling_threshold3_limit":{"$ref":"#/components/schemas/ThrottlingThresholdThirdLimit"}}},"id":"schema_33"},"schema_34":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_34"},"schema_35":{"kind":"json-schema","data":{"type":"object","required":["region_name","label","iso2_list"],"properties":{"region_name":{"type":"string","description":"The name of the custom region.","example":"Usa and Mexico Regional Plan"},"label":{"$ref":"#/components/schemas/Label"},"iso2_list":{"type":"array","description":"List of ISO 2-letter country codes included in the custom region.","items":{"type":"string"},"example":["US","MX"]}}},"id":"schema_35"},"schema_36":{"kind":"json-schema","data":{"type":"object","required":["error","message"],"properties":{"error":{"type":"boolean","example":true},"message":{"type":"string","example":"Custom region with this name already exists for this organization"},"missing_iso2":{"type":"array","description":"List of ISO2 country codes from the request for which no operators were found.","items":{"type":"string"}}}},"id":"schema_36"},"schema_37":{"kind":"json-schema","data":{"type":"object","required":["error","message","existing_coverage"],"properties":{"error":{"type":"boolean","example":true},"message":{"type":"string","example":"Coverage id with same operator already exists"},"existing_coverage":{"type":"object","required":["coverage_id","region_code","region_name","iso2_list"],"properties":{"coverage_id":{"type":"string","example":"85089a51-801c-4737-bd8b-f542705712bf"},"region_code":{"type":"string","example":"R33BHT"},"region_name":{"type":"string","example":"TEST USA and Mexico"},"iso2_list":{"type":"array","items":{"type":"string"},"example":["US","MX"]}}}}},"id":"schema_37"},"schema_38":{"kind":"json-schema","data":{"type":"integer","default":10},"id":"schema_38"},"schema_39":{"kind":"json-schema","data":{"type":"object","required":["type","timestamp","data"],"properties":{"type":{"type":"string","example":"attachment.allowanceConsumed"},"timestamp":{"type":"integer","description":"Unix timestamp when the event was fired","example":1730474606},"data":{"type":"object","required":["usagePercentage","dataUsageBytes","esim","planId","attachmentId"],"properties":{"usagePercentage":{"type":"number","minimum":0,"maximum":100,"description":"Percentage of data allowance consumed","example":80},"dataUsageBytes":{"type":"number","description":"Data consumed in bytes","example":1231230},"esim":{"type":"string","description":"The eSIM or physical SIM identifier","example":"8937103400004164763"},"planId":{"type":"string","description":"The plan identifier","example":"33de44b0-5103-45ea-9723-0a7aa104c76a"},"attachmentId":{"type":"string","description":"The attachment identifier","example":"a1ac5a45-e05b-4728-9253-17c54fc1c5ff"}}}}},"id":"schema_39"},"schema_40":{"kind":"json-schema","data":{"type":"object","required":["type","timestamp","data"],"properties":{"type":{"type":"string","example":"subscription.esim.locationChanged"},"timestamp":{"type":"integer","description":"Unix timestamp when the event was fired","example":1759429928},"data":{"type":"object","required":["esim","countryIso2"],"properties":{"esim":{"type":"string","description":"The eSIM or physical SIM identifier","example":"8937204017179541233"},"countryIso2":{"type":"string","description":"ISO 2-letter country code","example":"IT"}}}}},"id":"schema_40"},"schema_41":{"kind":"json-schema","data":{"type":"object","required":["type","timestamp","data"],"properties":{"type":{"type":"string","example":"esim.smdp.stateChanged"},"timestamp":{"type":"integer","description":"Unix timestamp when the event was fired","example":1761991449},"data":{"type":"object","required":["sim","smdpStateChange"],"properties":{"sim":{"type":"string","description":"The eSIM or physical SIM identifier","example":"8937204017179541233"},"smdpStateChange":{"type":"object","required":["state","modificationResult"],"properties":{"state":{"type":"string","description":"The SMDP state","enum":["BPP Installation","Enable","Disable","Delete"],"example":"Enable"},"modificationResult":{"type":"string","description":"The result of the state modification","example":"SUCCESS"}}}}}}},"id":"schema_41"}},"exampleStore":{"paths/~1v3~1subscription/post/requestBody/content/application~1json/examples/noActivePeriodProvided":{"value":{"plan_id":"0a3ee1d6-fe5e-4561-91a0-d4649aaf0754","metadata":"usa recurring plan"},"key":"noActivePeriodProvided","summary":"Create subscription without active_period","id":"paths/~1v3~1subscription/post/requestBody/content/application~1json/examples/noActivePeriodProvided"},"paths/~1v3~1subscription/post/requestBody/content/application~1json/examples/nonRecurringWithActivePeriodStartAndEnd":{"value":{"iccid":"8948010000031324502","plan_id":"0a3ee1d6-fe5e-4561-91a0-d4649aaf0754","metadata":"usa non-recurring plan","active_period":{"start":"2025-12-10T15:03:28.533603","end":"2025-12-20T15:03:28.533603"}},"key":"nonRecurringWithActivePeriodStartAndEnd","summary":"Non-recurring plan with active_period start and end","id":"paths/~1v3~1subscription/post/requestBody/content/application~1json/examples/nonRecurringWithActivePeriodStartAndEnd"},"paths/~1v3~1subscription/post/requestBody/content/application~1json/examples/recurringWithActivePeriodStartOnly":{"value":{"iccid":"8948010000031324502","plan_id":"0a3ee1d6-fe5e-4561-91a0-d4649aaf0754","metadata":"usa recurring plan","active_period":{"start":"2025-12-10T15:03:28.533603"}},"key":"recurringWithActivePeriodStartOnly","summary":"Recurring plan with active_period start only","id":"paths/~1v3~1subscription/post/requestBody/content/application~1json/examples/recurringWithActivePeriodStartOnly"},"paths/~1v3~1subscriptions~1{iccid}~1plan-attachments/get/responses/200/content/application~1json/examples/non-recurring":{"value":{"error":false,"data":[{"plan_attachment_id":"db83dfe3-49b7-442a-ad56-31282de2bf88","created_at":"2026-06-07T11:44:33.169Z","activation_at":null,"expiration_at":null,"used_allowance":{"dataBytes":0},"state":"SUSPENDED","plan":{"name":"india 1gb 7day","_id":"2c1de3cb-00fa-487f-9341-d4f21da1c46b","coverage_id":"b124f4ed-3cf0-4d67-a625-8bacbb590006","region_code":"IN","label":"Green","throttling":false,"recurring":false,"data_mega_bytes":"1024","period_days":7}}]},"key":"non-recurring","summary":"Non-recurring plan attachment","id":"paths/~1v3~1subscriptions~1{iccid}~1plan-attachments/get/responses/200/content/application~1json/examples/non-recurring"},"paths/~1v3~1subscriptions~1{iccid}~1plan-attachments/get/responses/200/content/application~1json/examples/recurring":{"value":{"error":false,"data":[{"plan_attachment_id":"d31bb405-7725-4eb2-ba2e-5ebc85758a4a","created_at":"2026-06-06T17:46:21.025Z","activation_at":null,"expiration_at":null,"used_allowance":null,"state":null,"plan":{"name":"recurring india only package","_id":"b3de947a-3ee4-4e80-91b3-8d247038d0dd","coverage_id":"b124f4ed-3cf0-4d67-a625-8bacbb590006","region_code":"IN","label":"Green","throttling":false,"recurring":true,"data_mega_bytes":"1024","period_days":1,"nb_occurrence":5,"recurring_periodicity_type":"0","recurring_periodicity_frequency":1},"recurrence":{"nb_occurrence":5,"nb_created":5,"active":true,"recurring_periodicity_type":"0","recurring_periodicity_frequency":1,"start_time":"2026-06-06T18:20:37.000Z","last_instance_creation_time":"2026-06-10T16:05:00.000Z"},"instances":[{"instance_id":"72d1ad65-62e4-480e-ad20-4841eb8b1eaf","activation_at":"2026-06-06T18:20:37.000Z","expiration_at":"2026-06-07T18:20:37.000Z","used_allowance":{"dataBytes":23240775},"instance_state":"EXPIRED"},{"instance_id":"989ae375-d70e-475e-b353-275c3ba447c1","activation_at":"2026-06-07T18:20:37.000Z","expiration_at":"2026-06-08T18:20:37.000Z","used_allowance":{"dataBytes":0},"instance_state":"EXPIRED"}]}]},"key":"recurring","summary":"Recurring plan attachment with instances","id":"paths/~1v3~1subscriptions~1{iccid}~1plan-attachments/get/responses/200/content/application~1json/examples/recurring"},"paths/~1v3~1subscriptions~1{iccid}~1plan-attachments/get/responses/200/content/application~1json/examples/mixed":{"value":{"error":false,"data":[{"plan_attachment_id":"d31bb405-7725-4eb2-ba2e-5ebc85758a4a","created_at":"2026-06-06T17:46:21.025Z","activation_at":null,"expiration_at":null,"used_allowance":null,"state":null,"plan":{"name":"recurring india only package","_id":"b3de947a-3ee4-4e80-91b3-8d247038d0dd","coverage_id":"b124f4ed-3cf0-4d67-a625-8bacbb590006","region_code":"IN","label":"Green","throttling":false,"recurring":true,"data_mega_bytes":"1024","period_days":1,"nb_occurrence":5,"recurring_periodicity_type":"0","recurring_periodicity_frequency":1},"recurrence":{"nb_occurrence":5,"nb_created":5,"active":true,"recurring_periodicity_type":"0","recurring_periodicity_frequency":1,"start_time":"2026-06-06T18:20:37.000Z","last_instance_creation_time":"2026-06-10T16:05:00.000Z"},"instances":[{"instance_id":"72d1ad65-62e4-480e-ad20-4841eb8b1eaf","activation_at":"2026-06-06T18:20:37.000Z","expiration_at":"2026-06-07T18:20:37.000Z","used_allowance":{"dataBytes":23240775},"instance_state":"EXPIRED"}]},{"plan_attachment_id":"db83dfe3-49b7-442a-ad56-31282de2bf88","created_at":"2026-06-07T11:44:33.169Z","activation_at":null,"expiration_at":null,"used_allowance":{"dataBytes":0},"state":"SUSPENDED","plan":{"name":"india 1gb 7day","_id":"2c1de3cb-00fa-487f-9341-d4f21da1c46b","coverage_id":"b124f4ed-3cf0-4d67-a625-8bacbb590006","region_code":"IN","label":"Green","throttling":false,"recurring":false,"data_mega_bytes":"1024","period_days":7}}]},"key":"mixed","summary":"Mixed response with both recurring and non-recurring plans","id":"paths/~1v3~1subscriptions~1{iccid}~1plan-attachments/get/responses/200/content/application~1json/examples/mixed"},"paths/~1v3~1subscriptions~1{iccid}~1plan-attachments~1{plan_id}/get/responses/200/content/application~1json/examples/non-recurring":{"value":{"error":false,"data":{"plan_attachment_id":"db83dfe3-49b7-442a-ad56-31282de2bf88","created_at":"2026-06-07T11:44:33.169Z","activation_at":null,"expiration_at":null,"used_allowance":{"dataBytes":0},"state":"SUSPENDED","plan":{"name":"india 1gb 7day","_id":"2c1de3cb-00fa-487f-9341-d4f21da1c46b","coverage_id":"b124f4ed-3cf0-4d67-a625-8bacbb590006","region_code":"IN","label":"Green","throttling":false,"recurring":false,"data_mega_bytes":"1024","period_days":7}}},"key":"non-recurring","summary":"Non-recurring plan attachment","id":"paths/~1v3~1subscriptions~1{iccid}~1plan-attachments~1{plan_id}/get/responses/200/content/application~1json/examples/non-recurring"},"paths/~1v3~1subscriptions~1{iccid}~1plan-attachments~1{plan_id}/get/responses/200/content/application~1json/examples/recurring":{"value":{"error":false,"data":{"plan_attachment_id":"d31bb405-7725-4eb2-ba2e-5ebc85758a4a","created_at":"2026-06-06T17:46:21.025Z","activation_at":null,"expiration_at":null,"used_allowance":null,"state":null,"plan":{"name":"recurring india only package","_id":"b3de947a-3ee4-4e80-91b3-8d247038d0dd","coverage_id":"b124f4ed-3cf0-4d67-a625-8bacbb590006","region_code":"IN","label":"Green","throttling":false,"recurring":true,"data_mega_bytes":"1024","period_days":1,"nb_occurrence":5,"recurring_periodicity_type":"0","recurring_periodicity_frequency":1},"recurrence":{"nb_occurrence":5,"nb_created":5,"active":true,"recurring_periodicity_type":"0","recurring_periodicity_frequency":1,"start_time":"2026-06-06T18:20:37.000Z","last_instance_creation_time":"2026-06-10T16:05:00.000Z"},"instances":[{"instance_id":"72d1ad65-62e4-480e-ad20-4841eb8b1eaf","activation_at":"2026-06-06T18:20:37.000Z","expiration_at":"2026-06-07T18:20:37.000Z","used_allowance":{"dataBytes":23240775},"instance_state":"EXPIRED"},{"instance_id":"989ae375-d70e-475e-b353-275c3ba447c1","activation_at":"2026-06-07T18:20:37.000Z","expiration_at":"2026-06-08T18:20:37.000Z","used_allowance":{"dataBytes":0},"instance_state":"EXPIRED"},{"instance_id":"dec20390-003a-467d-a7ff-6a4791a161d2","activation_at":"2026-06-08T18:20:37.000Z","expiration_at":"2026-06-09T18:20:37.000Z","used_allowance":{"dataBytes":0},"instance_state":"EXPIRED"},{"instance_id":"d6f776b4-de21-49f6-ad51-edde2aeb7b66","activation_at":"2026-06-09T18:20:37.000Z","expiration_at":"2026-06-10T18:20:37.000Z","used_allowance":{"dataBytes":0},"instance_state":"EXPIRED"},{"instance_id":"c9f7c7ba-aebb-471f-bae0-324f1429265c","activation_at":"2026-06-10T18:20:37.000Z","expiration_at":"2026-06-11T18:20:37.000Z","used_allowance":{"dataBytes":0},"instance_state":"EXPIRED"}]}},"key":"recurring","summary":"Recurring plan attachment with instances","id":"paths/~1v3~1subscriptions~1{iccid}~1plan-attachments~1{plan_id}/get/responses/200/content/application~1json/examples/recurring"},"paths/~1v3~1subscriptions~1{iccid}~1location/get/responses/200/content/application~1json/examples/successful_response":{"value":{"error":false,"last_operator":{"country":"Jordan","country_alpha_2":"jo","operator":"ZAIN Jordan","event_time":"2022-11-21T23:08:51.333+01:00","rat":"4G - LTE","imei":"356703224849612"}},"key":"successful_response","summary":"Location data available","id":"paths/~1v3~1subscriptions~1{iccid}~1location/get/responses/200/content/application~1json/examples/successful_response"},"paths/~1v3~1subscriptions~1{iccid}~1location/get/responses/200/content/application~1json/examples/no_recent_activity":{"value":{"error":false,"last_operator":null},"key":"no_recent_activity","summary":"No recent activity (SIM not active in last 7 days)","id":"paths/~1v3~1subscriptions~1{iccid}~1location/get/responses/200/content/application~1json/examples/no_recent_activity"},"paths/~1v3~1subscriptions~1{iccid}~1geo-location/get/responses/200/content/application~1json/examples/location_available":{"value":{"error":false,"data":{"latitude":41.63565,"longitude":41.60746,"accuracy":2000,"date_time":"2026-04-17T19:43:25Z"}},"key":"location_available","summary":"Location data available","id":"paths/~1v3~1subscriptions~1{iccid}~1geo-location/get/responses/200/content/application~1json/examples/location_available"},"paths/~1v3~1subscriptions~1{iccid}~1geo-location/get/responses/200/content/application~1json/examples/location_unavailable":{"value":{"error":false,"message":"No known location for this ICCID"},"key":"location_unavailable","summary":"Location data not available","id":"paths/~1v3~1subscriptions~1{iccid}~1geo-location/get/responses/200/content/application~1json/examples/location_unavailable"},"paths/~1v3~1subscriptions~1{iccid}~1usage-over-period/post/requestBody/content/application~1json/example":{"value":{"period":{"start":"2026-04-13","end":"2026-04-19"}},"id":"paths/~1v3~1subscriptions~1{iccid}~1usage-over-period/post/requestBody/content/application~1json/example"},"paths/~1v3~1subscriptions~1{iccid}~1usage-over-period/post/responses/200/content/application~1json/example":{"value":{"error":false,"data":{"iccid":"8948010000094661394","start_date":"2026-04-30","end_date":"2026-05-01","total_usage":{"total_bytes":2650971109,"total_gb":"2.47","reseller_cost":2.1099239888152237},"usage_per_day":[{"date":"2026-05-01","total_bytes":2129053891,"total_gb":"1.98","reseller_cost":1.6945269085923083,"countries":[{"mcc":602,"country_name":"Egypt","country_code":"eg","data_usage_bytes":2129053891,"data_usage_gb":"1.98","operators":[{"mnc":3,"operator_name":"Etisalat Egypt","data_usage_bytes":2129053891,"data_usage_gb":"1.98"}]}]},{"date":"2026-04-30","total_bytes":521917218,"total_gb":"0.49","reseller_cost":0.41539708022291566,"countries":[{"mcc":602,"country_name":"Egypt","country_code":"eg","data_usage_bytes":521917218,"data_usage_gb":"0.49","operators":[{"mnc":3,"operator_name":"Etisalat Egypt","data_usage_bytes":521917218,"data_usage_gb":"0.49"}]}]}],"usage_per_country":[{"mcc":602,"country_name":"Egypt","country_code":"eg","data_usage_bytes":2650971109,"data_usage_gb":"2.47","operators":[{"mnc":3,"operator_name":"Etisalat Egypt","data_usage_bytes":2650971109,"data_usage_gb":"2.47"}]}]}},"id":"paths/~1v3~1subscriptions~1{iccid}~1usage-over-period/post/responses/200/content/application~1json/example"},"paths/~1v3~1subscriptions~1{iccid}~1network-events/post/requestBody/content/application~1json/example":{"value":{"period":{"start":"2026-08-15","end":"2026-08-21"}},"id":"paths/~1v3~1subscriptions~1{iccid}~1network-events/post/requestBody/content/application~1json/example"},"paths/~1v3~1subscriptions~1{iccid}~1network-events/post/responses/200/content/application~1json/example":{"value":{"error":false,"label":"Green","data":{"2g_or_3g_attach":[{"event_time":"2026-08-17T21:51:27Z","country_name":"Morocco","country_alpha_2":"ma","operator":"Inwi Morocco","result":"ok"}],"4g_or_5g_attach":[{"event_time":"2026-08-20T22:54:25Z","country_name":"Morocco","country_alpha_2":"ma","operator":"Inwi Morocco","oper_allowed":true}],"data_usage":[{"event_time":"2026-08-21T06:32:32Z","request_type":"Update","country_name":"Morocco","country_alpha_2":"ma","operator":"Inwi Morocco","result":"success"}]}},"id":"paths/~1v3~1subscriptions~1{iccid}~1network-events/post/responses/200/content/application~1json/example"},"paths/~1v3~1subscriptions~1{iccid}~1network-events/post/responses/400/content/application~1json/examples/period_exceeds_7_days":{"value":{"error":true,"message":"Date range must be between 0 and 7 days"},"key":"period_exceeds_7_days","summary":"Requested period exceeds the maximum of 7 days","id":"paths/~1v3~1subscriptions~1{iccid}~1network-events/post/responses/400/content/application~1json/examples/period_exceeds_7_days"},"paths/~1v3~1subscriptions~1{iccid}~1network-events/post/responses/400/content/application~1json/examples/missing_required_field":{"value":{"error":true,"message":"Invalid input: expected string, received undefined"},"key":"missing_required_field","summary":"Request body is missing a required field","id":"paths/~1v3~1subscriptions~1{iccid}~1network-events/post/responses/400/content/application~1json/examples/missing_required_field"},"paths/~1v3~1plans/post/requestBody/content/application~1json/examples/default":{"value":{"coverage_id":"819b05c4-f154-4df9-8fd1-16be3e82f5c6","data_MBs":1024,"name":"test1 recurring and throttling package","period_days":1,"recurring":true,"throttling":true,"nb_occurrence":2,"recurring_periodicity_type":"0","recurring_periodicity_frequency":2,"throttling_threshold1_perc":50,"throttling_threshold1_limit":"10240","throttling_threshold2_perc":75,"throttling_threshold2_limit":"5120","throttling_threshold3_perc":90,"throttling_threshold3_limit":"1024"},"key":"default","summary":"With recurring and throttling enabled","id":"paths/~1v3~1plans/post/requestBody/content/application~1json/examples/default"},"paths/~1v3~1plans/post/requestBody/content/application~1json/examples/minimal":{"value":{"coverage_id":"819b05c4-f154-4df9-8fd1-16be3e82f5c6","data_MBs":1024,"name":"minimal package","period_days":1,"recurring":false,"throttling":false},"key":"minimal","summary":"Minimal example with recurring and throttling disabled","id":"paths/~1v3~1plans/post/requestBody/content/application~1json/examples/minimal"},"paths/~1v3~1plans/post/requestBody/content/application~1json/examples/throttling_only":{"value":{"coverage_id":"819b05c4-f154-4df9-8fd1-16be3e82f5c6","data_MBs":1024,"name":"throttling only package","period_days":1,"recurring":false,"throttling":true,"throttling_threshold1_perc":50,"throttling_threshold1_limit":"10240","throttling_threshold2_perc":75,"throttling_threshold2_limit":"5120","throttling_threshold3_perc":90,"throttling_threshold3_limit":"1024"},"key":"throttling_only","summary":"With only throttling enabled","id":"paths/~1v3~1plans/post/requestBody/content/application~1json/examples/throttling_only"},"paths/~1v3~1plans/post/requestBody/content/application~1json/examples/recurring_only":{"value":{"coverage_id":"819b05c4-f154-4df9-8fd1-16be3e82f5c6","data_MBs":1024,"name":"recurring only package","period_days":1,"recurring":true,"throttling":false,"nb_occurrence":2,"recurring_periodicity_type":"0","recurring_periodicity_frequency":2},"key":"recurring_only","summary":"With only recurring enabled","id":"paths/~1v3~1plans/post/requestBody/content/application~1json/examples/recurring_only"},"paths/~1v3~1coverage-profiles~1custom-region/post/requestBody/content/application~1json/examples/default":{"value":{"region_name":"Usa and Mexico Regional Plan","label":"Green","iso2_list":["US","MX"]},"key":"default","summary":"Example custom region request","id":"paths/~1v3~1coverage-profiles~1custom-region/post/requestBody/content/application~1json/examples/default"},"paths/~1v3~1coverage-profiles~1custom-region/post/responses/200/content/application~1json/examples/success":{"value":{"error":false,"data":{"coverage_id":"85089a51-801c-4737-bd8b-f542705712bf","region_code":"R33BHT","region_name":"Usa and Mexico Regional Plan","iso2_list":["US","MX"]}},"key":"success","summary":"Successful custom region creation","id":"paths/~1v3~1coverage-profiles~1custom-region/post/responses/200/content/application~1json/examples/success"},"paths/~1v3~1coverage-profiles~1custom-region/post/responses/400/content/application~1json/examples/nameAlreadyExists":{"value":{"error":true,"message":"Custom region with this name already exists for this organization"},"key":"nameAlreadyExists","summary":"Custom region name already exists","id":"paths/~1v3~1coverage-profiles~1custom-region/post/responses/400/content/application~1json/examples/nameAlreadyExists"},"paths/~1v3~1coverage-profiles~1custom-region/post/responses/400/content/application~1json/examples/missingOperatorsForIso2":{"value":{"error":true,"message":"No operators found for one or more provided iso2 codes","missing_iso2":["UK"]},"key":"missingOperatorsForIso2","summary":"No operators found for one or more provided ISO2 codes","id":"paths/~1v3~1coverage-profiles~1custom-region/post/responses/400/content/application~1json/examples/missingOperatorsForIso2"},"paths/~1v3~1coverage-profiles~1custom-region/post/responses/409/content/application~1json/examples/coverageConflict":{"value":{"error":true,"message":"Coverage id with same operator already exists","existing_coverage":{"coverage_id":"85089a51-801c-4737-bd8b-f542705712bf","region_code":"R33BHT","region_name":"TEST USA and Mexico","iso2_list":["US","MX"]}},"key":"coverageConflict","summary":"Coverage with same operator already exists","id":"paths/~1v3~1coverage-profiles~1custom-region/post/responses/409/content/application~1json/examples/coverageConflict"},"paths/~1v3~1sims~1{iccid}~1smdp-info/get/responses/200/content/application~1json/example":{"value":{"error":false,"data":{"iccid":"8948010000031326267","state_history":[{"state":"Enable","modification_result":"SUCCESS","modified_at":"2025-10-28T20:23:59.000Z"},{"state":"BPP Installation","modification_result":"SUCCESS","modified_at":"2025-10-28T20:23:51.000Z"}],"current_status":"Enable"}},"id":"paths/~1v3~1sims~1{iccid}~1smdp-info/get/responses/200/content/application~1json/example"},"paths/~1v3~1wallet~1{iccid}~1balance/post/requestBody/content/application~1json/examples/set_balance":{"value":{"amount":150,"set_balance":true,"description":"Set balance to 150.00"},"key":"set_balance","summary":"Set balance to specific amount","description":"Forces the wallet balance to exactly 150.00","id":"paths/~1v3~1wallet~1{iccid}~1balance/post/requestBody/content/application~1json/examples/set_balance"},"paths/~1v3~1wallet~1{iccid}~1balance/post/requestBody/content/application~1json/examples/add_balance":{"value":{"amount":50,"set_balance":false,"description":"Add 50.00 to balance"},"key":"add_balance","summary":"Add balance to current amount","description":"Adds 50.00 to the current wallet balance","id":"paths/~1v3~1wallet~1{iccid}~1balance/post/requestBody/content/application~1json/examples/add_balance"},"paths/~1v3~1wallet~1{iccid}~1balance/post/requestBody/content/application~1json/examples/decrease_balance":{"value":{"amount":-100,"set_balance":false,"description":"Deduct 100.00 from balance"},"key":"decrease_balance","summary":"Decrease balance by specific amount","description":"Removes 100.00 from the current wallet balance","id":"paths/~1v3~1wallet~1{iccid}~1balance/post/requestBody/content/application~1json/examples/decrease_balance"},"paths/attachment.allowanceConsumed/post/requestBody/content/application~1json/example":{"value":{"type":"attachment.allowanceConsumed","timestamp":1730474606,"data":{"usagePercentage":80,"dataUsageBytes":1231230,"esim":"8937103400004164763","planId":"33de44b0-5103-45ea-9723-0a7aa104c76a","attachmentId":"a1ac5a45-e05b-4728-9253-17c54fc1c5ff"}},"id":"paths/attachment.allowanceConsumed/post/requestBody/content/application~1json/example"},"paths/subscription.esim.locationChanged/post/requestBody/content/application~1json/example":{"value":{"type":"subscription.esim.locationChanged","timestamp":1759429928,"data":{"esim":"8937204017179541233","countryIso2":"IT"}},"id":"paths/subscription.esim.locationChanged/post/requestBody/content/application~1json/example"},"paths/esim.smdp.stateChanged/post/requestBody/content/application~1json/example":{"value":{"type":"esim.smdp.stateChanged","timestamp":1761991449,"data":{"sim":"8937204017179541233","smdpStateChange":{"state":"Enable","modificationResult":"SUCCESS"}}},"id":"paths/esim.smdp.stateChanged/post/requestBody/content/application~1json/example"}},"securitySchemeStore":{"ApiKeyAuth":{"id":"ApiKeyAuth","type":"apiKey","description":"Your API key for authentication","in":"query","paramName":"key"}},"servers":[{"url":"https://api.tellisim.com","description":"Production server"}]},"options":{"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi.json?download"},{"url":"/_bundle/openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"TelliSIM API v3","description":"# API explanation\n\n![API explanation diagram](https://cdn.tellisim.com/tellisim-website-images/tellisim-api-docs-diagram.png)\n"}},"baseSlug":"/openapi","routesMapping":{}}