{"items":[{"type":"link","label":"TelliSIM API v3","link":"/openapi","routeSlug":"/openapi"},{"type":"link","label":"API explanation","link":"/openapi/section/api-explanation","routeSlug":"/openapi/section/api-explanation"},{"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"httpPath":"/v3/subscriptions/{iccid}/network-events"}]},{"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."}},"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."}},"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."}},"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."}},"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."}},"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."}},"httpPath":"/v3/plans/{planId}/unarchive"}]},{"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."}},"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"}},"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."}},"httpPath":"/v3/coverage-profiles/custom-region"}]},{"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."}},"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."}},"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."}},"httpPath":"/v3/sims/{iccid}/smdp-info"}]},{"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."}},"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."}},"httpPath":"/v3/operators/{operatorId}"}]},{"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."}},"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."}},"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."}},"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."}},"httpPath":"/v3/wallet/sims"}]},{"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"},{"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)."}},"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."}},"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."}},"httpPath":"esim.smdp.stateChanged"}]}]}