# List async change requests Source: https://docs.hologram.io/api/1/asyncchangerequests/get /api/1/openapi.yaml get /asyncchangerequests Returns a paginated list of async change requests. Async change requests represent background operations such as plan changes and SIM configuration updates that are processed asynchronously. Non-super-admin callers only receive requests for organizations they can access. # Get a single async change request by ID Source: https://docs.hologram.io/api/1/asyncchangerequests/requestid/get /api/1/openapi.yaml get /asyncchangerequests/{requestId} Returns the full detail for a single async change request, including its child request IDs and decoded metadata. # List events Source: https://docs.hologram.io/api/1/csr/data/get /api/1/openapi.yaml get /csr/data Returns a paginated list of events # Get single event Source: https://docs.hologram.io/api/1/csr/data/recordid/get /api/1/openapi.yaml get /csr/data/{recordId} Alias of GET /data/messages/{recordId}. # Get event tags Source: https://docs.hologram.io/api/1/csr/tags/get /api/1/openapi.yaml get /csr/tags Returns a paginated list of event tags. Events are tagged with one or more tags to categorize them. Alerts in the frontend then "subscribe" to these tags and allow you to create notifications for different types of events. # Get past active SIM count Source: https://docs.hologram.io/api/1/devices/activecount/get /api/1/openapi.yaml get /devices/activecount Returns the count of SIMs (devices) that were active at a given point in time. # Get bulk state change job status Source: https://docs.hologram.io/api/1/devices/batch/state/get /api/1/openapi.yaml get /devices/batch/state Get the status of all current bulk state change jobs. State changes can take time to process for large numbers of devices. If the org does not have a plan that supports seeing activity history, this endpoint will return a 403. # Change SIM state (batch) Source: https://docs.hologram.io/api/1/devices/batch/state/post /api/1/openapi.yaml post /devices/batch/state Create a batch job to change the state of a large set of SIMs using the device ID for each SIM. Accepts device IDs directly or a bulk filter criteria. Returns a list of tasks for the batch runner. # Update SIM data usage limits (batch) Source: https://docs.hologram.io/api/1/devices/batch/usagelimit/post /api/1/openapi.yaml post /devices/batch/usagelimit Create a batch job to update the usage limits for a large set of SIMs using the device ID for each SIM. Returns a list of tasks for the batch runner. Data usage limits are applied above the included data in the SIM's data plan; a 500 MB data plan with a 250 MB data limit will trigger an event when the SIM uses 750 MB of data. SMS limits can be reduced, or raised back up to your organization's maximum SMS limit. # Change data plan for SIMs (bulk) Source: https://docs.hologram.io/api/1/devices/changeplan/post /api/1/openapi.yaml post /devices/changeplan Change the data plan for the given devices. Non-pending paused profiles (PAUSED-USER, PAUSED-SYS) can change plans when the new plan uses the same CSP (no coverage change). Pending paused profiles remain rejected. Warning: Changing data plans will remove any set data limits. Changing data plans in your dashboard will retain these limits. # Get SIM count Source: https://docs.hologram.io/api/1/devices/count/get /api/1/openapi.yaml get /devices/count Returns the total number of SIMs (devices) for the organization. # Change SIM data plan Source: https://docs.hologram.io/api/1/devices/deviceid/changeplan/post /api/1/openapi.yaml post /devices/{deviceId}/changeplan Change the data plan for the given device. Non-pending paused profiles (PAUSED-USER, PAUSED-SYS) can change plans when the new plan uses the same CSP (no coverage change). Pending paused profiles remain rejected. Warning: Changing data plans will remove any set data limits. # Get a SIM by device ID Source: https://docs.hologram.io/api/1/devices/deviceid/get /api/1/openapi.yaml get /devices/{deviceId} Retrieves the details of an existing SIM (device). Specify the SIM's unique device ID in the request URL, which you can find in your dashboard. # Rename, transfer, or manage tunneling for a SIM Source: https://docs.hologram.io/api/1/devices/deviceid/put /api/1/openapi.yaml put /devices/{deviceId} Updates the specified SIM by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This endpoint allows you to rename a SIM/device, transfer ownership of the SIM to a different organization, and enable or disable secure device tunneling with Spacebridge. # Change SIM state Source: https://docs.hologram.io/api/1/devices/deviceid/state/post /api/1/openapi.yaml post /devices/{deviceId}/state Change the state of a SIM in a device. Supported state values are `pause`, `live`, and `deactivate`. Pausing the SIM will prevent your device from passing any data on all profiles installed on the SIM. Paused SIMs still incur Monthly Recurring Charges. Deactivating permanently removes the SIM card from service. Deactivation is supported from any non-deactivated state, including SIMs in Test Mode (network states of `TEST-ACTIVATE`, `TEST-HIBERNATE`, `TEST-AUTOACTIVATE`, and their `-PENDING` variants). # Update SIM usage limits Source: https://docs.hologram.io/api/1/devices/deviceid/usagelimit/post /api/1/openapi.yaml post /devices/{deviceId}/usagelimit Updates the data usage limit, SMS limit, and data warning threshold for a SIM using the device ID for the SIM. Values must be >= -1, where -1 means no limit. Data usage limits are applied above the included data in the SIM's data plan; a 500 MB data plan with a 250 MB data limit will trigger an event when the SIM uses 750 MB of data. SMS limits can be reduced, or raised back up to your organization's maximum SMS limit. # Get SIM webhook Source: https://docs.hologram.io/api/1/devices/deviceid/webhook/get /api/1/openapi.yaml get /devices/{deviceId}/webhook Returns the webhook configuration for the specified SIM (device). # List SIMs (devices) Source: https://docs.hologram.io/api/1/devices/get /api/1/openapi.yaml get /devices Retrieve a list of SIMs (devices) with their detailed information including profile information (cellular links), session data, and metadata. SIMs are returned sorted by creation date, with the most recent SIMs appearing first. Use the `limit` and `startafter` parameters together for cursor-based pagination through large SIM lists. # Get SIM locations Source: https://docs.hologram.io/api/1/devices/locations/get /api/1/openapi.yaml get /devices/locations Retrieve location information for SIMs (devices) that have reported location data. Returns a paginated list of SIMs with their most recent location including latitude, longitude, and accuracy range. # Send TCP/UDP cloud message to a SIM Source: https://docs.hologram.io/api/1/devices/messages/post /api/1/openapi.yaml post /devices/messages Send a cloud message (data) to one or more SIMs using device IDs. Messages can be sent as plain text using the `data` parameter or as base64-encoded content using the `base64data` parameter. Port must be between 1 and 65535. Protocol must be TCP or UDP. Max data size is 10K. # Get SIM (device) names Source: https://docs.hologram.io/api/1/devices/names/get /api/1/openapi.yaml get /devices/names Retrieve a mapping of device IDs to names for SIMs in the organization. Returns a paginated list with device IDs as keys and names as values. # Update SIM names (bulk) Source: https://docs.hologram.io/api/1/devices/names/post /api/1/openapi.yaml post /devices/names Bulk update SIM names. Either supply `prefix` to rename each selected device to `{prefix} ({last 5 ICCID digits})` (or the prefix alone when `skipPostfix` is true), or supply `names` to set an explicit name per device. With `prefix`, devices are selected via `deviceids`, bulk-selection filters, or a combination of both; with `names`, the listed devices are renamed and all selection parameters are ignored. Requires the `bulk_rename` feature flag on the organization. # List SIMs with open data sessions Source: https://docs.hologram.io/api/1/devices/opensessions/get /api/1/openapi.yaml get /devices/opensessions Returns a list of device IDs that currently have an open cellular data session. # List SIMs (paginated) Source: https://docs.hologram.io/api/1/devices/pages/get /api/1/openapi.yaml get /devices/pages Retrieve pagination information for SIMs retrieved from `/devices` for organizations with many SIMs. This endpoint will return empty data if there are fewer SIMs than the limit specified. # Search for SIMs Source: https://docs.hologram.io/api/1/devices/search/post /api/1/openapi.yaml post /devices/search # Change SIM state (bulk) Source: https://docs.hologram.io/api/1/devices/state/post /api/1/openapi.yaml post /devices/state Change the state of SIMs in multiple devices at once. Supported state values are `pause`, `live`, and `deactivate`. Pausing the SIM will prevent your device from passing any data on all profiles installed on the SIM. Paused SIMs still incur Monthly Recurring Charges. Deactivating permanently removes SIM cards from service and is supported from any non-deactivated state, including SIMs in Test Mode (network states of `TEST-ACTIVATE`, `TEST-HIBERNATE`, `TEST-AUTOACTIVATE`, and their `-PENDING` variants). # List all tags Source: https://docs.hologram.io/api/1/devices/tags/get /api/1/openapi.yaml get /devices/tags Get all tags. If you specify an org, this will only return the tags for the org. # Create a tag Source: https://docs.hologram.io/api/1/devices/tags/post /api/1/openapi.yaml post /devices/tags Creates a new SIM tag in the caller's current organization. SIMs (devices) can optionally be linked to the tag at creation time via deviceids or bulk-selection parameters. Bulk selection requires the `bulk_tag` feature flag on the organization. # Delete tag Source: https://docs.hologram.io/api/1/devices/tags/tagid/delete /api/1/openapi.yaml delete /devices/tags/{tagId} Deletes a SIM tag. If the tag is associated with any SIMs, the tag is removed from those SIMs. # Add tag to SIMs Source: https://docs.hologram.io/api/1/devices/tags/tagid/link/post /api/1/openapi.yaml post /devices/tags/{tagId}/link Add a tag to specified SIMs (devices) via deviceids or bulk-selection parameters. Bulk selection requires the `bulk_tag` feature flag on the organization. # Remove tag from SIMs Source: https://docs.hologram.io/api/1/devices/tags/tagid/unlink/post /api/1/openapi.yaml post /devices/tags/{tagId}/unlink Removes a tag from specified SIMs (devices) via deviceids or bulk-selection parameters. Returns the tag with its remaining linked devices. Bulk selection requires the `bulk_tag` feature flag on the organization. # Rename a tag Source: https://docs.hologram.io/api/1/devices/tags/tagid/updatetagname/put /api/1/openapi.yaml put /devices/tags/{tagId}/updatetagname Update a tag name for the given tag # Transfer SIMs to organization (bulk) Source: https://docs.hologram.io/api/1/devices/transfer/post /api/1/openapi.yaml post /devices/transfer Transfer devices to a different organization. Maximum of 3000 devices per request. All devices must belong to the same source organization. # Update SIM usage limits (bulk) Source: https://docs.hologram.io/api/1/devices/usagelimit/post /api/1/openapi.yaml post /devices/usagelimit Updates the data usage limit, SMS limit, and data warning threshold for one or more SIMs using the device ID for each SIM. Values must be >= -1 where -1 means no limit. Data usage limits are applied above the included data in the SIM's data plan; a 500 MB data plan with a 250 MB data limit will trigger an event when the SIM uses 750 MB of data. SMS limits can be reduced, or raised back up to your organization's maximum SMS limit. # Activate SIMs (bulk) Source: https://docs.hologram.io/api/1/links/cellular/bulkclaim/post /api/1/openapi.yaml post /links/cellular/bulkclaim Activate SIMs by ICCID range, individual ICCID list, or EID range. Any ICCID of a profile manufactured on the SIM can be used to activate a SIM. Maximum of 2,500 SIMs per request. Once a SIM is activated, you can begin passing data. `plan` and `zone` are required for all live activations. The start and end ICCID in a range must be real ICCIDs. # Update location / Network refresh Source: https://docs.hologram.io/api/1/links/cellular/updatelocation/post /api/1/openapi.yaml post /links/cellular/updatelocation Triggers an update location command for the specified profiles, using the cellular link ID for each profile. Update location / network refresh commands are not supported by all carriers. Only profiles in a `LIVE`, `TEST-ACTIVATE`, or `TEST-AUTOACTIVATE` network state can open data sessions and are eligible for this command, other states will fail. # List organizations Source: https://docs.hologram.io/api/1/organizations/get /api/1/openapi.yaml get /organizations List organizations. Returns all organizations that you are a member of. This includes the personal organization tied to your user. When you create your Hologram account, a personal organization associated solely with your account is also created. This personal org is named after you. You cannot add other users to this personal organization. # Get organization account balance Source: https://docs.hologram.io/api/1/organizations/orgid/balance/get /api/1/openapi.yaml get /organizations/{orgId}/balance/ # List balance history for an organization Source: https://docs.hologram.io/api/1/organizations/orgid/balancehistory/get /api/1/openapi.yaml get /organizations/{orgId}/balancehistory/ # Get organization billing configuration Source: https://docs.hologram.io/api/1/organizations/orgid/billing/get /api/1/openapi.yaml get /organizations/{orgId}/billing Get billing info for the organization # Get data plan inventory for organization Source: https://docs.hologram.io/api/1/organizations/orgid/devices/plans/get /api/1/openapi.yaml get /organizations/{orgId}/devices/plans Returns a summary of device data plan distribution for an organization. # Get an organization Source: https://docs.hologram.io/api/1/organizations/orgid/get /api/1/openapi.yaml get /organizations/{orgId} Get organization details # List billing statements for an organization Source: https://docs.hologram.io/api/1/organizations/orgid/statements/get /api/1/openapi.yaml get /organizations/{orgId}/statements Get billing statement records that match the passed in parameters # Download a billing statement as a CSV file Source: https://docs.hologram.io/api/1/organizations/orgid/statements/statementid/csv/get /api/1/openapi.yaml get /organizations/{orgId}/statements/{statementId}/csv Get a billing statement stream from DB (regenerated CSV) # List pending invites Source: https://docs.hologram.io/api/1/organizations/pending/get /api/1/openapi.yaml get /organizations/pending Get all the pending invites for an organization # Create organization Source: https://docs.hologram.io/api/1/organizations/post /api/1/openapi.yaml post /organizations Create a new organization # List data plans Source: https://docs.hologram.io/api/1/plans/get /api/1/openapi.yaml get /plans List all data plans. Returns all data plans matching the specified parameters. # Get data plan Source: https://docs.hologram.io/api/1/plans/planid/get /api/1/openapi.yaml get /plans/{planId} Retrieves the details of a specific data plan. # Get all data plan pricing Source: https://docs.hologram.io/api/1/plans/pricing/get /api/1/openapi.yaml get /plans/pricing Get pricing for a plan. Retrieves the pricing details of available plans. # Get SIM counts for the current organization Source: https://docs.hologram.io/api/1/reports/devices/get /api/1/openapi.yaml get /reports/devices # List SIM configurations Source: https://docs.hologram.io/api/1/simcards/configurations/get /api/1/openapi.yaml get /simcards/configurations/ Returns available sim configurations based on the plans visible to all of a user's orgs. Optionally filter specific configurations with the parameters below. # Get a single SIM configuration Source: https://docs.hologram.io/api/1/simcards/configurations/simconfigurationid/get /api/1/openapi.yaml get /simcards/configurations/{simConfigurationId}/ Get a single SIM configuration via its id. Optionally provide an orgid or plan_ids to validate a configuration is applicable. # Apply a SIM configuration to one or more SIM cards Source: https://docs.hologram.io/api/1/simcards/configure/post /api/1/openapi.yaml post /simcards/configure Dispatches a configuration change to the specified SIM cards. Non-admin users may only target SIM cards they can access and configurations allowed by their plan. # Apply a SIM configuration to a single SIM card Source: https://docs.hologram.io/api/1/simcards/simcardid/configure/post /api/1/openapi.yaml post /simcards/{simCardId}/configure/ Dispatches a configuration change to the specified SIM card. Non-admin users may only target a SIM card they can access and configurations allowed by their plan. # Route an inbound SMS to a SIM Source: https://docs.hologram.io/api/1/sms/incoming/post /api/1/openapi.yaml post /sms/incoming/ Authenticated endpoint for delivering inbound SMS to a SIM. # Send an outbound SMS from a SIM Source: https://docs.hologram.io/api/1/sms/outgoing/post /api/1/openapi.yaml post /sms/outgoing/ # List tunnel keys for the current user Source: https://docs.hologram.io/api/1/tunnelkeys/get /api/1/openapi.yaml get /tunnelkeys/ Returns the authenticated user's tunnel keys. Requires the organization to have tunnel access enabled. # Disable a tunnel key Source: https://docs.hologram.io/api/1/tunnelkeys/keyid/disable/post /api/1/openapi.yaml post /tunnelkeys/{keyId}/disable/ # Enable a tunnel key Source: https://docs.hologram.io/api/1/tunnelkeys/keyid/enable/post /api/1/openapi.yaml post /tunnelkeys/{keyId}/enable/ # Create a tunnel key Source: https://docs.hologram.io/api/1/tunnelkeys/post /api/1/openapi.yaml post /tunnelkeys/ Creates a new tunnel key. If `public_key` is omitted, the server generates a 2048-bit RSA keypair and returns the private key in the response — save it immediately, it is not stored. The key type must be `ssh-rsa`. At most 5 enabled keys are allowed per user. If the org does not have a plan that supports device tunneling, this endpoint returns 403. # Get current billing period usage for a SIM card Source: https://docs.hologram.io/api/1/usage/billing/simcard/simcardid/get /api/1/openapi.yaml get /usage/billing/simcard/{simcardid} Returns one aggregate usage record for a SIM's current unique 30-day billing period. Optionally restrict the total to one cellular link; linkids identifies all links included in the aggregate. Set with_session_details=true to also receive, per link, the most recent closed session rolled into the total (most_recent_sessions) and any in-flight session not yet billed (open_sessions). # List billing usage records Source: https://docs.hologram.io/api/1/usage/data/billing/get /api/1/openapi.yaml get /usage/data/billing Returns total data usage for each SIM summarized by the SIM's unique 30-day billing period. Records are returned per link (profile) ID by billing period, within the date range specified. Monthly Recurring Charges are billed every 30 days beginning at the time the device was activated. Data is available for the last three months. # List daily aggregated data usage Source: https://docs.hologram.io/api/1/usage/data/daily/get /api/1/openapi.yaml get /usage/data/daily # List recent data usage records Source: https://docs.hologram.io/api/1/usage/data/get /api/1/openapi.yaml get /usage/data/ # Get the last billing period that had usage activity Source: https://docs.hologram.io/api/1/usage/data/last-period-with-usage/get /api/1/openapi.yaml get /usage/data/last-period-with-usage # List monthly aggregated data usage Source: https://docs.hologram.io/api/1/usage/data/monthly/get /api/1/openapi.yaml get /usage/data/monthly # Get aggregated total data usage Source: https://docs.hologram.io/api/1/usage/data/total/get /api/1/openapi.yaml get /usage/data/total # List SMS usage records Source: https://docs.hologram.io/api/1/usage/sms/get /api/1/openapi.yaml get /usage/sms/ # List users Source: https://docs.hologram.io/api/1/users/get /api/1/openapi.yaml get /users/ # Get the current user's API key Source: https://docs.hologram.io/api/1/users/me/apikey/get /api/1/openapi.yaml get /users/me/apikey/ # Generate a new API key for the current user Source: https://docs.hologram.io/api/1/users/me/apikey/post /api/1/openapi.yaml post /users/me/apikey/ # Get the currently authenticated user Source: https://docs.hologram.io/api/1/users/me/get /api/1/openapi.yaml get /users/me/ # Get a user by ID Source: https://docs.hologram.io/api/1/users/userid/get /api/1/openapi.yaml get /users/{userId}/ # Update a user Source: https://docs.hologram.io/api/1/users/userid/post /api/1/openapi.yaml post /users/{userId}/ # Hologram REST API Source: https://docs.hologram.io/api/v1 The Hologram HTTP API is a REST-style interface for managing Hologram SIMs, accounts, and cloud data. Using this API, you can activate SIMs, get your devices' approximate location, send SMS messages to your devices, update data usage limits, and much more. In Hologram's API, a "device" represents a SIM card. Each item returned by `/devices` endpoints represents a single SIM card. You can find more information about Hologram terminology in our [Glossary](/guides/get-started/glossary) and the Hologram [Connectivity overview](/guides/get-started/sim-connectivity-overview). The device ID and SIM ID are effectively the same and represent one SIM, but device ID is used in older API endpoints and SIM ID is used in newer API endpoints. ## Base URL ``` https://dashboard.hologram.io/api/1 ``` ## Authentication Hologram supports **HTTP Basic authentication** using API keys. Set the username to `apikey` and use your API key as the password. ### Using cURL ```bash theme={null} curl --verbose GET \ 'https://dashboard.hologram.io/api/1/users/me' \ -u apikey:YOUR_API_KEY ``` ### Using authorization header You can also base64 encode `apikey:YOUR_API_KEY` and include it in the Authorization header: ```bash theme={null} curl --verbose GET \ 'https://dashboard.hologram.io/api/1/users/me' \ --header "Authorization: Basic BASE64_ENCODED_CREDENTIALS" ``` ## API access levels * **Read Access**: Available to Editor roles and higher. * **Write Access**: Varies by endpoint based on role access, generally limited to Admin and Manager roles. Users without appropriate permissions will receive 403 errors for restricted operations. ## Requests Request bodies can be provided in either JSON or form-urlencoded formats: ### JSON format (recommended) ```bash theme={null} curl --request POST \ --header "Content-Type: application/json" \ --header "Authorization: Basic YOUR_ENCODED_CREDENTIALS" \ --data '{"deviceid": 56668, "body": "Hello SIM!"}' \ 'https://dashboard.hologram.io/api/1/sms/incoming' ``` ### Form-urlencoded format ```bash theme={null} curl --request POST \ --header "Content-Type: application/x-www-form-urlencoded" \ --header "Authorization: Basic YOUR_ENCODED_CREDENTIALS" \ --data 'deviceid=56668&body=Hello%20SIM!' \ 'https://dashboard.hologram.io/api/1/sms/incoming' ``` ## Responses **Important:** All Hologram dates and times are stored and displayed in **UTC**. ### Response format All API responses are JSON objects that include the following fields. Indicates whether the request was successful. Contains the requested data or information about the operation performed. Only present when success is true. Information about why the request failed. Only present when success is false. ### Limited responses Most GET responses will also include the following fields if a limit is included as part of the query string: The query limit. Some endpoints have this value built in and others often have a maximum value. The number of values returned by the query. Only returned if there are more values than were returned in the response. Contains information related to the query performed. The API endpoint path. API base URL. URL with query string to get the next results. ## Rate limiting In order to provide a consistent quality of service to all of our customers, we enforce a rate limit on all API requests. If you exceed the rate limit you will receive a HTTP 429 response with a JSON response body like this: ```json theme={null} { "success": false, "error": "API rate limit exceeded" } ``` If you receive this response, you should refrain from making requests for 5-10 seconds and then retry the request. ## Generating an API key Find your account API key in your [dashboard](https://dashboard.hologram.io/settings/api) under the **Settings** section in the main menu, then opening the **API** page. Your API can be used to access all organizations you are a member of. **Caution:** **Keep your API key secure** and never store it in publicly accessible places like GitHub repositories. ## Organization IDs Your API key gives you access to all organizations you are a member of. If no organization is specified in an API request, the request will be performed for your personal organization. Many endpoints accept an `orgid` parameter to filter for SIMs within a specific organization. Learn how to find your organization's ID in [this guide](/dashboard/orgs-and-users/organization-overview). ## OpenAPI and Swagger links OpenAPI - [https://dashboard.hologram.io/api/1/docs/openapi.json](https://dashboard.hologram.io/api/1/docs/openapi.json)
Swagger - [https://dashboard.hologram.io/api/1/docs](https://dashboard.hologram.io/api/1/docs) ## Support For API support, questions, or additional assistance, please [contact our support team](/guides/get-started/contact-support). # Set a default organization Source: https://docs.hologram.io/dashboard/account/change-default-organization Choose which organization opens by default when you log in. Change default organization ## How to change your default organization Open the **Settings** section in the main menu, then open the **My organizations** tab. In the **Default organization** card, open the **Change** menu and select the organization you want to set as default. The next time you log in, this organization will open automatically. # Delete your account Source: https://docs.hologram.io/dashboard/account/delete-account Deleting your account is a manual process. My account must be in good standing without a negative balance, and have no active SIMs. Deleting your account will **permanently delete all organizations owned by that account**. This includes all organization with an owner that matches your email address. Deletion requests must come from the account owner's email address. **If you want to transfer ownership of an organization to someone else**, follow this [guide](/dashboard/orgs-and-users/transfer-ownership) instead. ## Requirements before deleting your account Before you delete your account, you can check your account status in the My account page [here](/dashboard/account/update-account-details) to see if you have remaining balance or own any other organizations. Verify all organizations that you own by checking your [Account settings](/dashboard/account/update-account-details) page and the [organization details](/dashboard/orgs-and-users/organization-overview) pages for each organization. All SIMs within **all organizations you own** have been permanently deactivated by following the instructions in [this guide](/dashboard/sim-actions/deactivate-sims), or have been transferred to other organizations your account does not own by following [these instructions](/dashboard/sim-actions/transfer-to-organization). The accout balance for **all organizations you own** must be paid and \$0. If the organization has a balance, it must be paid in the [Account page](/dashboard/billing/add-balance) before Hologram can delete the organization. We recommend also turning off auto-refill in the [Account page](/dashboard/billing/auto-refill). If you have a positive balance, you can save a step by requesting a refund when submitting your support request. Gather the [organization ID(s)](/guides/troubleshooting/find-org-id) of all organization(s) you own. **Important:** Hologram can only delete an organization in which all SIMs are either deactivated or [transferred](/dashboard/sim-actions/transfer-to-organization), and the organization's balance is not negative. *In accordance with our Terms of Service, we are not required to provide refunds for any remaining positive balance when a customer requests the termination or deletion of their account. Our policies are designed to ensure clarity and consistency in financial transactions while upholding the agreed-upon terms of use. If you have any concerns or require further clarification regarding this policy, we encourage you to review our [Terms of Service](https://www.hologram.io/terms-of-use/).* ## How to delete your account Email [support@hologram.io](mailto:support@hologram.io) ***from the email address associated with your Hologram account***, filling out the template below. You will need the following information: * **Organization ID(s).** Provide all Organization IDs in your [Dashboard](https://dashboard.hologram.io/) that you are an Owner of. * **Do you have active SIM(s) on your account?** You are required to delete or transfer SIM(s) in order for Hologram to delete your account. Go to your [dashboard](https://dashboard.hologram.io/) and follow [this quick guide to delete or transfer SIMs](/dashboard/sim-actions/deactivate-sims). * **Your balance must not be negative.** If your account is negative, it must be paid before Hologram can delete your account. Find it in your [dashboard](https://dashboard.hologram.io/) * **Are you the owner of the account?** You must send your request from the account email address matching the email address in your [dashboard](https://dashboard.hologram.io/). If you are not the owner, CC the owner in your request, who will need to verify the request. Once all steps above have been completed Hologram Support will proceed with deleting your Hologram Dashboard(s). ## Email template ### Subject ```text theme={null} DELETE ACCOUNT ``` ### Body ```text theme={null} Account email address to delete: Organization ID(s): All SIMs have been deactivated or transferred?: Balance has been paid?: Are you the owner of all listed organizations?: Please permanently delete the following organizations associated with my account: . I acknowledge that I have already permanently deleted or transferred all SIMs associated with these organizations. ``` ## Example email ### Subject ```text theme={null} DELETE ACCOUNT ``` ### Body ```text theme={null} Account email address to delete: kiera.bennett@hlgresearch.com Organization ID(s): 12345, 12346 All SIMs have been deactivated or transferred?: Deactivated Balance has been paid?: Yes Are you the owner of all listed organizations?: Yes Please permanently delete the following organizations associated with my account: 12345, 12346. I acknowledge that I have already permanently deleted or transferred all SIMs associated with these organizations. ``` # Generate and manage your REST API key Source: https://docs.hologram.io/dashboard/account/rest-api-key Your API key is your personal access token for the Hologram REST API, and can be managed in the **Settings** page in the main menu, under the **My account** tab. Your API key gives you access to your personal account, as well as any organizations you are a member of. API keys are user-level credentials that work across all organizations you belong to. Your permissions within specific organizations are determined by your role in that organization. ## Generate an API key In your dashboard, navigate to the **Settings** section in the main menu, then open the **My account** tab. Scroll down to the **API** card where to view, generate, or regenerate your API key. API card in My account page **Caution:** Safeguard API keys and never share them in plaintext. Regenerate immediately if compromised. ## Related actions # Update account details Source: https://docs.hologram.io/dashboard/account/update-account-details Update your name, email address, and password in your account settings. Under the **Settings** page in the main menu, open the **My account** page to update account details, find your API key, and view pending invitations. My account page ## Update name or email address From the **Settings** section in the main menu, open the **My account** page. In the **Personal info** card, press the **Update information** button to update your name or email address. ## Change password From the **Settings** section in the main menu, open the **My account** page. In the **Password** card, perss the **Change password** button to change your password. You will use your new password the next time you log in. ## Change default organization Choose which organization opens by default when you log in. ## Switch organizations Change the active organization in your dashboard. ## Accept an invite Accept an invite to collaborate in an organization. ## Delete account Deleting your account is a manual process. My account must be in good standing without a negative balance, and have no active SIMs. Instructions are outlined in [this guide](/dashboard/account/delete-account). # Activate SIMs Source: https://docs.hologram.io/dashboard/activation/activation-overview Activating SIM cards is easy with Hologram. Whether you are activating one SIM or thousands, you can bulk activate and get connected quickly. ## How activation works in your dashboard During the activation process, you will select a data plan for your new SIMs, review coverage and rates, set data usage limit preferences, organize your SIMs with tags or name prefixes, then finally pay and activate the SIMs so that they can connect for the first time. If you are activating SIMs for the first time, please note that you'll need to add **payment details and a billing address** to complete the activation process. [Learn more about adding a billing address](/dashboard/billing/billing-account-overview). **Limited access:** Learn more about Test Mode and streamline your deployments by contacting our [sales team](https://www.hologram.io/contact-sales?utm_source=docs\&utm_medium=website\&utm_content=test_mode_callout). You can navigate away from and return to the activation process at any time without losing your progress. Your progress is saved until you log out. First, enter the ICCIDs of the SIMs you want to activate. You can add SIMs individually, by entering a range, or by list upload using a CSV file. You can enter ICCIDs or EIDs when activating SIMs. Read about [how to find SIM ICCIDs](/guides/troubleshooting/how-to-find-sim-iccids-and-eids). If a SIM or profile cannot be added, you will see an error that distinguishes SIM-level issues from profile-level issues. #### Enter SIMs individually by ICCID Enter an ICCID by typing or copy/paste. You can add multiple ICCIDs separated by a comma, space, or line break. Barcode scanners can help quickly enter ICCIDs using the bardcode printed on each SIM card. Enter ICCIDs individually #### Enter a range of SIMs To choose a range of SIMs, enter the first and last ICCIDs in the range of SIMs to activate. You can find these ICCIDs printed on the box of SIMs you receive as the “ICCID Start” and “ICCID End”. #### Upload a CSV You can add a list of SIMs by uploading a list of ICCIDs in a `CSV` file using the template linked on the page. Click the **Download this template** link to download the CSV template, or use the format shown below this step. Upload CSV ##### CSV template format ```csv theme={null} ICCID YOUR_ICCID_1234567890 YOUR_ICCID_1234567891 YOUR_ICCID_1234567892 ``` Once the ICCIDs are successfully verified, they display in a table with the **SIM SKU**, **manufactured profile ICCIDs**, and the profiles installed on the SIM. Installed profiles determine the coverage and data plans available to the SIM. If there are any errors when verifying a SIM or profile, you will see a red or yellow notification callout with an explanation.   After entering SIMs, you can choose from data plans available to those SIMs. Data plans define the **coverage** and **pricing** available to a SIM, based on its installed connectivity profile(s). Activation step 2 - Choose coverage and rates, selecting a data plan The page only shows data plans that have coverage or favorable rates for the SIMs you have entered. However, you can **display all data plans** available to your account by toggling off the **Show only recommended plans** switch at the bottom of the page. If you have contracted rates available to your organization this reads **Show all data plans**. Any data plans without coverage or negotiated rates for the SIMs you've selected are marked in the list. Activation step 2 - Show all available data plans including those without coverage or negotiated rates   Next, you'll review all of the rates and coverage details for the data plan you've selected. Activation step 3 - Review coverage and rates, setting data usage limits *Optional.* Here you can also set **data usage limits** to pause SIMs automatically if they use over a certain amount of data. We recommend pausing at **10 GB** to protect against runaway usage from theft or device misconfiguration. You can also leave SIMs unlimited or set a custom amount, but the amount must be greater than the included data amount for plans with included data. You cannot set a 0 B limit on data plans that do not include data. Read more about [data usage limits](/guides/billing/manage-fleet-data-usage). Activation step 3 - Review coverage and rates, setting data usage limits *Optional.* You can also set a **data usage warning threshold** to create an event when a SIM reaches a certain amount of data usage. Create an [alert](/dashboard/event-monitoring/alerts-and-notifications) to be notified. A threshold of 0 B alerts at the first data usage of each billing period. Read more about [data warning thresholds](/dashboard/sim-actions/set-data-warning-threshold).   *Optional.* In this step you can **rename** your SIMs using a custom prefix, or add **tags** to help you better manage and organize your fleet. Tags are an especially useful way to organize and report on your fleet, and are useful to get notified of events for specific groups of SIMs when creating alerts. Activation step 4 - Configure SIMs with name prefixes and tags   You're almost there! In the final step, you have the chance to review all the selections you have made so far, confirm payment information and activate your device. Activation step 5 - Review charges, choose payment method, and activate SIMs If your account is prepaid and draws down from an account balance, you can set up account auto-refill to ensure that your devices never go offline due to insufficient funds. Read more about [auto-refill](/guides/billing/auto-refill). An auto-refill card appears in the page if you have not yet set up auto-refill for your organization After configuring auto-refill you'll see auto-refill configuration in the Payment method card   Once you click **Pay and activate**, you will see a final confirmation screen with a reminder to set the APN for your device before you are taken back to your dashboard. Read more about [setting the APN for your device](/guides/get-started/set-the-device-apn). After activation, you'll be prompted to set your device's APN based on the profiles installed on your SIMs   ## Activating SIMs out of Test Mode SIMs in Test Mode will automatically activate after their free testing period ends with **no downtime or action required** on your part. [Learn more about Test Mode](/guides/sims/test-mode). If your devices have limited connectivity windows or other constraints, you can [force activate](/dashboard/sim-actions/force-activate-from-test-mode) them out of Test Mode. This can also be used to activate SIMs with legacy Global-1 (G1) profiles, which experience a brief disconnection when activating to update profile states. ## Related guides ## Activating SIMs using the REST API Activate SIMs (bulk) POST /links/cellular/bulkclaim ## Related actions Force-activate SIMs that are in Test Mode Configure per-SIM data and SMS limits # Add account balance Source: https://docs.hologram.io/dashboard/billing/add-balance Top up your prepaid balance to keep your SIMs connected ## Add balance to your account To add balance to your Hologram account go to the **Billing** section on the left hand-side navigation bar of your Dashboard. Once the Account page opens, make sure there is a valid payment method on file in the **Payment method** card. Payment method card showing credit card on file Next, in the **Account balance** card, click the **Add balance** button. Add balance button in the Account balance card Enter the amount you want to add to your balance in the **Add balance** modal that appears, then press the **Add balance** button. Add balance modal with amount input field After submitting you should see the amount added to your account's balance. You can also [enable auto-refill](/dashboard/billing/auto-refill) which is the best way to make sure you don't experience any balance related service interruptions. # Auto-refill your account balance Source: https://docs.hologram.io/dashboard/billing/auto-refill Most Hologram organizations are prepaid and have an account balance that they will draw down from like a debit card or checking account. **Auto-refill** automatically adds funds to your account when your balance falls below a specified threshold, helping prevent service interruptions for your IoT devices. **Note:** We recommend that **all organizations with prepaid billing** enable auto-refill to help prevent service interruptions for your IoT devices. Account auto-refill does not apply to organizations with monthly invoicing. ## Set up account auto-refill In your Dashboard, open **Billing** from the left navigation. The **Account** page opens by default. Scroll to the **Account balance** card, which will display your current balance and auto-refill settings for your organization. Account auto-refill card Enter the minimum balance threshold that triggers auto-refill, and the amount to add when auto-refill is triggered. Save your changes. Account auto-refill thresholds ## Change account Auto-refill during activation If you have not yet configured auto-refill for your organization, it will appear in the final **Pay and activate** step of the activation process. If you do have auto-refill set up this information will not appear in the activation workflow. Changing auto-refill during activation ## Related actions Configure auto-refill during SIM activation ## Related guides # Account overview page Source: https://docs.hologram.io/dashboard/billing/billing-account-overview Your billing account page provides an overview of your billing account balance, billing address, and payment method. This is where you can add a billing address and credit card so that you can activate SIMs for the first time. ## Billing account balance Most organizations are prepaid and will have a balance in their account that they will draw down from like a debit card. The **Account balance** card shows your current balance, a high level breakdown of your balance, and allows you to **Add balance** and **Apply promo codes**. Account balance card, add balance, and current balance ## Add or change a billing address A billing address is required to activate SIMs, make purchases, and refill account balances. Billing address card Learn how to add or change a billing address for your organization. ## Add or change a payment method All organizations must have a credit card on file in order to activate SIMs, make purchases, and refill account balances. Payment method card Accounts with monthly invoicing and postpaid billing will see this card listed as **Backup payment method**. Backup payment method card Learn how to add or change a payment method for your organization. ## Account auto-refill If you have prepaid billing, you can enable auto-refill to automatically add funds when your balance falls below a specified threshold. **Auto-refill** section in the **Account balance** card shows the status and setting of your auto-refill selection. Account auto-refill card Learn how to set up account auto-refill for your organization. ## Credit card email recipients Credit card receipts will be sent to all Admins in your organization as well as any additional email addresses you specify here. Billing notifications recipients card with credit card email recipients field **Important:** If your organization has monthly invoicing, this field *only* applies to charges made with a credit card. To change who receives invoices, update recipients in your Stripe account. See Stripe's guide: `https://support.stripe.com/questions/change-the-email-address-where-stripe-emails-are-sent`. # Review, add, and remove email addresses that receive credit card receipts and invoices Source: https://docs.hologram.io/dashboard/billing/billing-email-recipients Manage who receives billing notification emails for your organization. ## Billing account notifications General billing notifications are sent to your organization's **Owner**, the primary contact for your account. To update who receives these notifications, update your organization **Owner**'s email address in the **Settings → My account** page. My account page with name and email address ## Invoice notifications If you receive invoices from Hologram and need to send invoices to a specific email address, you can change who receives invoice emails in your linked Stripe account. Invoices are sent through your Stripe account, and will be sent to the [email addresses you specify in Stripe](https://support.stripe.com/questions/change-the-email-address-where-stripe-emails-are-sent). Your Stripe account is created with the same email address as the **Owner** of your Hologram organization. If you are unable to access this email address or the associated account, please contact [support@hologram.io](mailto:support@hologram.io) for assistance. Billing notifications card with Stripe link ## Credit card receipt notifications We send limited credit card receipts to your organization's **Owner**, and to any other email addresses you choose. These receipts are **only generated for charges made with a credit card** that are not charged against your account balance. This typically happens only for charges like SIM activations or data plan changes. To share credit card billing emails go to the **Account** page in the **Billing** section of the main menu. Scroll down to the **Billing notifications** card where you can add the email addresses of any additional recipients. To add multiple emails, separate them with a comma. **Note:** Learn more about if you qualify for monthly invoicing by contacting our [sales team](https://www.hologram.io/contact-sales/). # Billing section overview Source: https://docs.hologram.io/dashboard/billing/billing-overview The **Billing** section of your dashboard provides an overview of your billing account balance, allows you to manage your billing settings and payment method, and provides access to your billing statements and transactions. ## Billing functionality Hologram's billing information is available in the **Billing** section of your dashboard. The information available to you depends on your organization's billing type. Most organizations are prepaid and will maintain a balance in their account that they will draw down from like a debit card or checking account. Contracted organizations can optionally receive monthly invoicing (postpaid billing) and have different views of billing information. Each organization maintains separate billing information and is billed independently. * **Account overview** - All organizations, content varies by billing method. * **Data plans** - All organizations. * **Balance history** - All organizations. * **Transaction history** - All organizations. * **Invoices** - Postpaid organizations with monthly invoicing only. * **Credit card receipts** - All organizations. Manage your billing account, current balance, billing address, and payment method. View all data plans and SIM pricing available to your organization. Detailed transaction history, and account balance history. ## Billing for contracted organizations The Invoices page lists all historical invoices for your organization. # Coverage Explorer Source: https://docs.hologram.io/dashboard/billing/coverage-explorer Use Coverage Explorer to find network coverage and rates available on a data plan. Find specific details with search and filters by profile, RAT, and country. Coverage Explorer lists out all the **networks** and **rates** available to SIMs on a data plan. You can search and filter by profile, RAT, and country to find specific details. Rates displayed in the Coverage Explorer are determined by the SIM's current data plan. Each data plan supports specific connectivity profiles that may be installed on SIMs. SIMs activated onto a data plan may have different coverage and rates based on the profiles installed on the SIM. **Note:** Data plan coverage includes networks and rates for **all profiles** available on the data plan, not just coverage for the SIMs you have selected. ## How do I find coverage and rates for a data plan? Open the **Billing** section in the main menu and open the **Data plans** page. Data plans page Open the **Coverage** tab in the data plan's details page to view the Coverage Explorer for the data plan. **Important:** Coverage information for a data plan includes coverage for **all profiles** available on the data plan, not just coverage for the SIMs you have selected. Each SIM's coverage is determined by the **profiles installed on that SIM**. Coverage and rates for a data plan in Coverage Explorer ## How do I find coverage and rates when activating SIMs or changing data plans? Begin the [activation](/dashboard/activation/activation-overview) or [data plan change](/dashboard/sim-actions/change-data-plans) process. After adding SIMs, while selecting a data plan and after confirming the plan, each data plan listed will have a link to **View coverage and rates**. Click that button to open the Coverage Explorer for the data plan. View coverage and rates for a data plan ## How do I find coverage and rates for a single SIM? Coverage details for a single SIM are available in the SIM's **Coverage** tab. Coverage available to a SIM is determined by the SIM's active data plan, and the profiles installed on the SIM card. The enabled profile on a SIM determines networks it can connect to. ## How do I use Coverage Explorer? ### Search Filter the table by network or country names using the **Search** bar. ### Filters * **Profile**: Filter by all profiles installed on your SIM, or choose a specific profile to see coverage and rates for a particular Mobile Core Operator. This is especially helpful when evaluating backup coverage on Hyper SIMs with Outage Protection™. * **RAT**: Filter by supported Radio Access Technologies such as NB-IoT, Cat-M1 (LTE-M), or 5G. * **Country**: Restrict results to specific countries. ### Coverage table The table lists all networks your SIM can connect to, based on its enabled and installed profiles, and shows the rates determined by the SIM's current data plan. You can sort the table by network name (default) or country name. Network name. The last connected network for your SIM displays a "Last seen" label. Profile the network is available on. Data usage/overage rate when using data on this network, as determined by the SIM's current data plan. Country the network operates in. Available Radio Access Technologies for this network/profile/country combination. ### Export to XLSX or CSV Generate and download a full coverage list for your SIM, including detailed network metadata. Exported data includes the following fields: * **Profile name**: Name of the profile the network is available on. * **Network name**: Name of the network. * **Rate per MB**: Data usage/overage rate when using data on this network, as determined by the data plan. * **Country**: Country the network operates in. * **UNC**: Hologram's Universal Network Code that determines network-level billing rates. * **TADIG**: The TADIG for the network. * **MCC**: The Mobile Country Code for the network. * **MNC**: The Mobile Network Code for the network. * **RATs**: Available Radio Access Technologies for this network/profile/country combination. ### Deep link with URL filters Share or bookmark a filtered view of coverage and rates by appending URL parameters. Supported filters: ```text theme={null} ?coverage=PROFILESHORTNAME|ALL ?rat=RATNAME|ALL ?search=SEARCHTERM ``` **Note:** Access to some networks requires custom data plans. Review Hologram's public coverage page and contact sales if you need tailored coverage. ## Related guides # Receipts page Source: https://docs.hologram.io/dashboard/billing/credit-card-receipts All charges made with a credit card are recorded in the **Receipts** page. Most organizations can find credit card receipts within the Receipts page in the main menu. Organizations with monthly invoicing can find receipts in the [Invoices](/dashboard/billing/invoices) page. Credit card receipts are generated for all charges made with a credit card that are not charged against your account balance. Credit card charges are most often used for account balance refills, auto-refill charges, SIM activations, and data plan changes if the MRC is different from the current data plan. Credit card receipts page ## Who receives credit card receipt emails? Credit card receipts are sent to the owner of your organization and any additional email addresses you specify in the **Billing notifications** card on the Billing → [Account page](/dashboard/billing/billing-account-overview#credit-card-email-recipients). ## Where can I find hardware purchases? Hardware purchases are sent separately from credit card receipts, and like SIM orders are **sent only via email**. Please contact [support](/guides/get-started/contact-support) to request a copy of a receipt for your hardware purchases. ## Where can I find credit card receipts if I have monthly invoicing? Organizations with monthly invoicing can find credit card receipts in the [Invoices](/dashboard/billing/invoices) page. Credit card receipts tab in the Invoices page ## Related guides Where to manage billing, payment methods, and history Review transactions and monthly statements Add or change your organization's billing address # Data plans pages Source: https://docs.hologram.io/dashboard/billing/data-plans The **Data plans** page provides a list of all data plans available to your organization. Clicking into a data plan provides detailed pricing, rate, and coverage information for SIMs active on that data plan. ## What information is available on the Data plans page? The data plans page lists all data plans available to your organization. By default, data plans without any active SIMs are hidden from view, but can be displayed using the toggle switch. Clicking into a data plan will take you to the details page for that data plan. Plans are categorized by plan type within separate cards: **Pay as you go** plans, **Included data** plans, and **Data pools**. If your organization has an active contract, Custom data plans with negotiated rates are separated from Standard data plans within each card. Each plan also lists the number of SIMs active on that data plan, and—if your organization has access—the number of pre-deployment SIMs that will be configured with that plan on activation. Clicking on the SIM counts will filter the SIMs page to only show SIMs active on that data plan. Data plans page ## Data plan details The data plan details page gives you more detailed information about a data plan. ### Pricing tab The **Pricing** tab of the page gives an overview of the data plan's pricing, including monthly recurring charges, data usage rate ranges, included data amounts, and SMS rates. Pricing tab for a data plan ### Coverage tab The **Coverage** tab of the page contains the [Coverage Explorer](/dashboard/billing/coverage-explorer) for the data plan. Here you can find a detailed view of network-level coverage available to SIMs on that data plan. **Important:** Coverage information for a data plan includes coverage for **all profiles** available on the data plan, not just coverage for the SIMs you have selected. Each SIM's coverage is determined by the **profiles installed on that SIM**. Coverage and rates for a data plan in Coverage Explorer ## Related guides ## Related actions # Invoices page Source: https://docs.hologram.io/dashboard/billing/invoices Organizations with monthly invoicing can find and pay invoices in the **Invoices** page. Credit card receipts can be found in the **Credit card receipts** tab. The **Invoices tab** lists all your available invoices with key details and links to view or download the invoice. Opening an invoice will take you to a Stripe-hosted payment page for secure viewing and payment. Invoices page ## How to view and pay invoices Open the **Billing** section in the main menu, then open the **Invoices** page. Open the **Download** menu for the invoice, and choose **Monthly invoice PDF** option to download your invoice. Pay unpaid or past due invoices using the **Pay invoice** button, which will open a Stripe-hosted invoice payment page. ### Invoice fields The invoice number or identifier. Click to open the Stripe-hosted invoice. The date the invoice was issued. The date payment is due (if applicable). Total amount of the invoice. Current status of the invoice (e.g., open, paid, past due, void). Download the invoice PDF. ## Who receives invoice emails? Invoice delivery is managed through your linked Stripe account for organizations on monthly invoicing. Stripe sends invoices to the email addresses configured in your Stripe billing settings. * To change who receives invoices, update recipients in your Stripe account. See Stripe's guide: `https://support.stripe.com/questions/change-the-email-address-where-stripe-emails-are-sent`. * For credit card receipts (prepaid), add recipients in the Billing notifications card on the Billing → [Account page](/dashboard/billing/billing-account-overview#credit-card-email-recipients). If you change an account owner's email address and still have outstanding invoices, please contact [support](/guides/get-started/contact-support) to update the email address on record. ## Where can I find hardware purchases? Hardware purchases like SIM orders are only sent via email today. Please contact [support](/guides/get-started/contact-support) to request a copy of a receipt for your hardware purchases. ## Related guides Where to manage billing, payment methods, and history Review transactions and monthly statements Add or change your organization's billing address # Add a promo code Source: https://docs.hologram.io/dashboard/billing/promo-codes Apply promotional codes to add credits to your account balance ## How do I add a promo code to my account balance? If your organization is prepaid and has an account balance, you can apply promo codes to add credits to your account balance. To add a promo code to your Hologram account go to the **Billing** section in the main menu of your dashboard and open the **Account** page. Look for the **Account balance** card and click the **Apply promo code** button. Apply promo code button in the Account balance card Enter your promo code in the **Apply promo code** modal that opens, then press the **Apply promo code** button. After submitting you should see the amount added to your account balance and display in a **Promotional credit** total. If your organization receives monthly invoices, you will need to contact our [support team](/guides/get-started/contact-support) to apply promo codes to your account balance. # Billing transactions and balance history Source: https://docs.hologram.io/dashboard/billing/statements-and-transactions Billing transactions provide a historical view of all billed charges for your organization. If you have questions about charges, invoice details, or want to analyze the underlying data, start with billing transactions. **Important:** The **Statements** page has been deprecated. Detailed transaction history is now available on the **Transactions** page and can be downloaded as an XLSX or CSV file. The **Transactions** page provides a historical view of all billed charges for your organization, and has two views of your billing history. The **Balance history** tab displays a summary of transactions against your balance history, by month. The **Transaction history** tab displays a detailed list of all billed transactions for your organization that can be downloaded for analysis or reporting purposes. ## Balance history tab The **Balance history** page displays a summary of transactions against your balance history, by month. Totals are calculated at the end of each calendar month. It includes the following information: * **Billing period**: The month and year of the billing period. * **Charges**: Running total of all charges during the billing period. * **Credits and adjustments**: Total of all credits and adjustments during the month. * **Total charges**: The total amount of charges less credits and adjustments during the month. Each row also links to the detailed **Transaction history** for that month. Balance history page ## Transactions tab On the **Transactions** page, you will see a list of historical transactions for your organization, grouped by charge type, with filters for date range and SIM tags. This page has some differences in content and functionality depending on your organization's billing type. **Prepaid organizations** with an account balance: * Can view transactions for the current month * Data usage transactions may be aggregated per SIM to meet a minimum charge threshold of \$0.25 **Postpaid organizations** with monthly invoicing: * Can view transactions only for prior months, after invoices have been generated for that month - Data usage transactions are aggregate per SIM, by Universal Network Code (UNC), per month. You can map transactions to specific networks to determine exact session-level charges. Transactions page To download the transactions as an XLSX file, click the **Download** button in the top right corner of the page. To download other file formats, hover over the transactions table, click the three-dot menu that appears, select **Export**, then choose the desired file format. ## About billing transactions Learn how to interpret billing statements and transactions and find descriptions of transaction types and fields. # Add or change a billing address Source: https://docs.hologram.io/dashboard/billing/update-billing-address A billing addresses is required for all organizations to activate SIMs, make purchases, and refill account balances. ## Add or change a billing address Expand the **Billing** section in the main menu and navigate to the **Account** page. Scroll to the **Account details** card. In the **Account details** card, select **Update billing address**. Billing address card with Update billing address button In the form that displays within the card, enter your billing address and select **Update billing address** to save. Update billing address form *** ## Related guides Use the Billing Account page to add or change your billing address Where to manage billing, payment methods, and history # Add or change a credit card for payment Source: https://docs.hologram.io/dashboard/billing/update-payment-method All organizations must have a credit card on file in order to activate SIMs, make purchases, and refill account balances. ## How do I add or update a credit card for payment? Hologram requires all organizations to have a credit card on file in order to activate SIMs and renew SIMs. For prepaid organizations with an account balance, a credit card is required to add funds to your account balance. For organizations with monthly invoicing and postpaid billing, a credit card is required as a backup payment method. Expand the **Billing** section in the main menu and navigate to the **Account** page. Scroll to the **Payment method** card. In the **Payment method** card, select **Update credit card**. Payment method card In the modal, enter your payment method information and select **Update payment method** to save. ## Update ACH payment method If your organization has monthly invoicing and postpaid billing, you can update your ACH payment by [contacting support](/guides/get-started/contact-support). *** ## Related guides Where to see and manage your account balance, billing address, and payment methods. # Create a new Hologram account Source: https://docs.hologram.io/dashboard/create-an-account Create a new Hologram account and learn how to manage your globally connected SIMs, understand data usage, collaborate with your team, and receive billing information. ## Create a free Hologram account [Sign up for a free Hologram account](https://dashboard.hologram.io/account/register) using your work email address. Create a new Hologram account ## Accept an invitation to collaborate ### If you have not yet created a Hologram account... Press the **Create account** button in your invitation email and create a new Hologram account. This will create a new Organization within your account. Using the **Organization dropdown** menu in the top left corner of your dashboard, switch to the organization you were invited to. ### If you have already created a Hologram account... In order to accept an invitation, make sure you have first [verified your email address](/guides/troubleshooting/what-can-i-do-if-i-havent-received-a-verification-email). Press the **Accept invite** button in your invitation email and log in to your account. You will join the new organization and it will open automatically. If you can't find the email, log in to your dashboard, Navigate to the **Settings** section in the main menu, open the **My account** page, navigate to the **Organizations** tab, and press the **Accept invitation** button. ## Log in to the Hologram Dashboard If you already have a Hologram account, you can access your dashboard by logging in. Head straight to [dashboard.hologram.io](https://dashboard.hologram.io), or visit [hologram.io](https://www.hologram.io/) and look for the **Log in** button in the upper right corner of the website. At the login screen, enter your email and password to access your dashboard. If you don't have an account yet, you can create one directly from the login screen, following the same process as above. ### Forgot your password? If you're having problems logging in, you may need to [reset your password](/guides/troubleshooting/how-do-i-reset-my-password). ## What's next? After you have created your account, you will be taken to a landing page for your organization. First, you'll need to purchase and activate some SIMs to make use of your new dashboard. Purchase SIMs from the Hologram Store. Learn how data metering and billing periods work for your fleet. Let's talk if you plan to manage over 500 SIMs or use more than 50 MB of data per device, to see if you qualify for discounted rates and custom coverage. Invite some collaborators from your team. # Set up notifications for events using Alerts Source: https://docs.hologram.io/dashboard/event-monitoring/alerts-and-notifications When events occur in your fleet, events are created in the Hologram Cloud that you can view in the **Event monitoring** section of your dashboard. You can create **Alerts** to subscribe to these events when they occur and send notifications via email or webhooks. Read about how alerts work, event tags, and the types of events you can subscribe to. ## How to manage alerts for a single SIM First find the SIM's details page from the **SIMs** pages or using **global search**. Open the **Alerts** tab for the SIM. The card will display all alerts for this SIM. Alerts cards displaying all alerts configured for this SIM You can find all events that have been created for this SIM on the **Events** tab, including any events that triggered an alert. These events include the message data and contents, event tags, and any errors that occurred during the event, which is useful for troubleshooting and reference before creating a new alert. Press the **Create alert** button to create a new alert for the SIM you want to monitor. You'll be presented with a list of event types available to subscribe to. Then, you can configure the alert to send notifications via email or webhooks. ## How to manage alerts for your entire fleet Alerts page displaying all alerts configured for your fleet **Important:** Legacy alert types that are no longer supported are marked with warnings and can only be deleted in the UI. Some deprecated alert types are still functional, but will be removed in a future release. Navigate to the **Event monitoring** section in the main menu and open the **Alerts** page. On the Alerts page you will find a list of all the Alerts that have been created across your organization. Here, you can add, edit, or delete alerts for your fleet. ## Related actions Send TCP, UDP, or SMS messages to your devices Learn how to configure and manage alerts Fix common alert configuration issues # View event history Source: https://docs.hologram.io/dashboard/event-monitoring/event-history View a history of events created in the Hologram Cloud across your fleet, including SIM messaging, IMEI changes, data limits reached, and more. Events are created when specific events occur in your fleet, and are tracked using event tags. Get notified when events occur by creating an [alert](/dashboard/event-monitoring/alerts-and-notifications). **Note:** **Event monitoring** replaces the **Activity console** drawer that was previously available in the bottom of your dashboard. Events for a single SIM are now tracked in the **Events** tab when viewing a SIM's details page. ## How to view event history Navigate to the **Event monitoring** section in the main menu and open the **Event history** page. Event history page The page displays a list of all events created in the Hologram Cloud across your fleet. You can filter events by type using the tabs at the top of the page, search for events by device ID, filter by event tags, or filter by date range. Events are processed and created shortly after the event occurs, and are **not real-time**. Each event is displayed with the following information: * **Inbound or outbound**: Whether the event was inbound to a SIM or outbound from it. * **SIM ID**: The ID of the SIM that triggered the event. * **Event date**: The date and time in UTC that the event occurred. * **Message data**: The message data or JSON payload that was passed when the event occurred. * **Event tags**: Any event tags associated with the event. **Event tags** determine the type of event that occurred, the device affected by the event, and any SIM tags that were attached to SIMs affected by the event. * **Errors**: Any errors that occurred during the event. Pressing the **Details** button will open a modal with more information about the event, including raw message contents. ## How to view specific types of events The tabs at the top of the page allow you to filter events by type, including: * **Recent**: Displays all events created in the Hologram Cloud across your fleet, sorted by most recent first. * **Errors**: Displays all events where an error occurred during the event. * **Data limits**: Displays all events where a data limit was reached for a SIM and the SIM was paused. * **First IMEI**: Displays all events where an IMEI was detected for the first time for a SIM. * **IMEI changes**: Displays all events where the IMEI or IMEI TAC of a SIM changed between data sessions. * **Messaging**: Displays all events where a message was sent or received by a SIM, including SMS, and TCP or UDP cloud messages * **API**: Displays any API responses to events, such as messages that failed to deliver to a SIM. ## Related guides Read about how alerts work, event tags, and the types of events you can subscribe to. # Detect IMEI events and get notified when a SIM has moved to another device Source: https://docs.hologram.io/dashboard/event-monitoring/tac-change-detection Track when SIMs are moved between devices using IMEI and TAC change detection. IMEI and IMEI TAC change events are available in [Event monitoring](/guides/cloud-and-tools/event-monitoring-and-alerts-overview) and can be used to create [alerts](/guides/cloud-and-tools/event-monitoring-and-alerts-overview) to notify you when a SIM is moved to a new device. ## What is IMEI and IMEI TAC? Every cellular connected device has an [IMEI (International Mobile Equipment Identity)](https://en.wikipedia.org/wiki/International_Mobile_Equipment_Identity) number, which is used to identify the hardware that is being connected to the network. This is very useful when it comes to mapping SIMs to specific devices and detecting when a SIM is being used in a new device. Hologram can always trace a SIM using [your dashboard](https://dashboard.hologram.io/) and determine what device it's being used in by viewing session data as described [in this guide](/dashboard/usage/usage-single-sim). The [Type Allocation Code (TAC)](https://en.wikipedia.org/wiki/Type_Allocation_Code) is the initial eight-digit portion of the IMEI, and it indicates the manufacturer, make, and model of the device. An `_IMEI_TAC_CHANGE_` message means that the new IMEI has a completely different manufacturer, make, or model than the old IMEI. An `_IMEI_CHANGE_` message indicates that the new device has the same manufacturer, make, and model as the old device. ## How does Hologram detect IMEI and IMEI TAC changes? Hologram has built-in IMEI detection that keeps track of the IMEI of the device used with the SIM as provided by networks during data sessions. These events are tracked and recorded in the [Event monitoring](/guides/cloud-and-tools/event-monitoring-and-alerts-overview) section of your dashboard, and are created: Activity console showing IMEI change detection messages with tags * When a SIM is **first connected** by sending a message and attaching an `_IMEI_FIRST_` tag. * When a SIM is connected using a **different IMEI** compared to the previous session by sending a message describing the change and attaching an `_IMEI_CHANGE_` tag. * When a SIM is connected using a **different modem model (different IMEI and TAC)** by sending a message describing the change and attaching an `_IMEI_TAC_CHANGE_` tag. ## How I get notified when a SIM is moved to a new device? You can create a new Alert to receive notifications about IMEI changes. Navigate to the **Event monitoring** section in the main menu and open the **Alerts** page. Press the **Create alert** button in the top right corner of the page. In the list of event types that appears, you can choose to subscribe to "First IMEI recognized" or "Hardware change (IMEI or TAC changed)" events. Create alert form showing topic selection Configure the notification settings to send notifications to email, SMS, or webhooks when specific events occur. # Dashboard documentation Source: https://docs.hologram.io/dashboard/get-started Hologram's dashboard is a simple, comprehensive tool to manage global device fleets of any size. Your dashboard provides everything you need to quickly troubleshoot, diagnose, and act on connectivity issues across your fleet.

Here you'll find detailed documentation about features, functionality, and data available in your dashboard. How-to and troubleshooting guides, walkthroughs, and FAQs are available in [Help & FAQs](/index). ## Set up your account First you'll need to order some Hologram SIMs. Sign up for a Hologram account using your work email address. This will create your new **Organization** which you will use to manage your fleet. Activate your new SIMs and get your devices connected. Invite your team to collaborate and manage your fleet. ## Manage your fleet Organize and manage your fleet in the SIMs pages. Take actions on your SIMs, such as pausing or resuming data usage, tagging, renaming, transferring, and deactivating SIMs. View and manage details for a single SIM. Investigate and report on data usage for your SIMs. ## Manage billing and payments Manage your billing account, payment methods, and find your historical billing transactions. # Home page Source: https://docs.hologram.io/dashboard/home-page The Home page gives you a quick heads-up view of the all the SIMs in your organization. Teams large and small can get real-time visibility and a quick pulse check on their fleet's health, connectivity statuses, inventory counts, and Test Mode readiness. Dashboard home page showing fleet overview with status counts and charts New organizations that have not activated SIM cards will see a **Welcome** page with resources to help you get started while data is being populated. Once you have activated SIMs, you will be redirected to the Home page. **For organizations with [Test Mode](/guides/sims/test-mode),** you will be able to see the count of how many devices configured for pre-deployment testing are ready and how many are inactive directly in the homepage. **Limited access:** Learn more about Test Mode and streamline your deployments by contacting our [sales team](https://www.hologram.io/contact-sales?utm_source=docs\&utm_medium=website\&utm_content=test_mode_callout). ## View SIM status breakdowns Your home page provides an at-a-glance summary of your fleet's current status. Here you'll find the total count of the most important device status types in your fleet — Active, Connected, Ready, and Paused. Click a status to navigate to the SIMs page with the table pre-filtered based on the status you chose. This gives you the ability to see the full device status breakdown at-a-glance in your homepage, and easily drill down one layer deeper for device-level data with one click. For example, clicking "Ready" SIMs takes you to the **Active SIMs** page with the Ready status checked in the **SIM status filter**. Clicking "Connected" SIMs opens the same page with the **Connected** filter checked instead. You can then filter further or take action on specific SIMs. Any SIM can be "Connected", so this count overlaps with other counts on the page. A Ready SIM with an open data session is counted in both Ready and Connected. ## How are SIM statuses defined? Below you will find the definitions of how the Active device SIM count is calculated in the homepage, and what each status means in both the dashboard and the API: | Dashboard | API | Description | | - | - | - | | **Ready** | `LIVE` | The SIM is activated and is able to use data on our network. | | **Connected** | Open data session | The SIM is currently connected to our network, or has connected recently to our network and has an open data session. Connected SIMs are also counted toward their status, such as Ready. | | **Pending** | `LIVE-PENDING` | This SIM is being configured for use on the Hologram network.

*(Includes SIMs that are activating for the first time, and SIMs that are resuming data usage from a `PAUSED-...` state.)* | | **Pausing** | `PAUSE-PENDING-USER` `PAUSE-PENDING-SYS` | A pause command has been sent to local carriers. While paused, your device will not be able to use data or access SMS services. | | **Paused by user** | `PAUSED-USER` | This device has been manually paused by you or a team member. While paused, your device will not be able to send or receive data or SMS messages. Monthly access fees for this device still apply while it is paused. | | **Paused by system** | `PAUSED-SYS` | Your device was paused after reaching a [data limit](/dashboard/sim-actions/set-usage-limits), [SMS limit](/guides/rest-api/set-a-sims-sms-limit-using-the-rest-api), or due to [insufficient funds](/guides/billing/insufficient-balance). While paused, your device will not be able to send or receive data or SMS messages. See here to learn more about adding balance to your account: | **Note:** There are no Pending or temporary states included on the Home page in the Hologram Dashboard. This is to avoid SIM state counts overlapping, since these states have a relatively short lifespan before switching into another state. Any additional statuses display in a small count in the bottom-right of the Active SIMs card. ## How are Test Mode SIM statuses defined? Below you will find the definitions of how the Test Mode Device SIM count is calculated in the homepage, and what each status means in both the dashboard and the API. The two Test Mode device SIM counts are calculated, or made up of the following [SIM state](/dashboard/sims/sim-states-and-statuses) values in both the dashboard and the API. SIMs being configured for Test Mode in the "Entering testing" status (`TEST-ACTIVATE-PENDING`) are not displayed on the Home page. | Dashboard homepage | API | Description | | - | - | - | | **In testing** | `TEST-ACTIVATE` | Your device is enrolled in *Hologram Test Mode* and can use 100 KB of data, 10 outbound SMS messages, or reach the end of it's testing period before it will automatically activate.

We haven't seen this device yet on the network. \[or] This device has connected to the network but has not successfully transmitted data yet. \[or] This device has successfully connected and transmitted data on the network. \[or] This SIM is in pre-deployment testing and is currently transmitting data or has recently connected to our network, and has an open data session. | | **Available** | `INACTIVE` | This SIM is assigned to your organization, but has not been activated. Activate it at any time to start using data on the Hologram network. | | **Connected SIMs** | Open data session | Pre-deployment SIMs with an open data session. Shown only when at least one pre-deployment SIM is connected. These SIMs are also counted in **In testing**. | **Note:** There are no **Deactivated**, **Deactivating**, or **Test Mode Pending** SIM statuses included on the Home page. # Log in to your account Source: https://docs.hologram.io/dashboard/log-in-to-dashboard This guide will walk you through how to log in to your dashboard, create an account, or reset your password. The first step will be looking for the **Log in** button on the upper right hand corner of our [website](https://www.hologram.io/). Log in button on Hologram homepage If you are new to Hologram, welcome! We are glad to have you here in the Hologram family. If you are an existing customer, welcome back! Login screen with email and password fields This will launch you into a login screen. If you are an existing Hologram customer, go ahead and log in! If you are new to Hologram you can create an account by clicking the **Create one** button at the bottom of the card. You will then be prompted to create a **free Hologram account**. Create a new Hologram account using your work email address If you're having problems logging in, you may need to [reset your password](/guides/troubleshooting/how-do-i-reset-my-password). # Accept an invite to collaborate in an organization Source: https://docs.hologram.io/dashboard/orgs-and-users/accept-organization-invite How to accept an invitation to collaborate on a Hologram organization To collaborate with your team in an organization, an Admin must invite you. You will receive an email with an invite link to join the organization, or you can accept the invite from your account settings. ## Accept an emailed invitation Click **Accept Invite** (or **Create Account** if you don't have an account yet) and follow the prompts. If you already have a Hologram account, sign in to join. If not, create your account, then you'll be taken into the invited organization. ## Accept when logged in to an organization Pending invitations in the Settings page's My organizations tab Open the **Settings** section in the main menu, then open the **My account** page. Scroll to the **Organizations** card, find the organization you were invited to, and click **Accept invitation**. *** ## Related guides Learn how to invite collaborators and manage access levels # Create an organization Source: https://docs.hologram.io/dashboard/orgs-and-users/create-organization Create a new organization to manage your SIMs and collaborators ## How to create an organization ### From the organizations menu Open the **Organization** menu that shows the name of the current organization in the top right corner of your Dashboard, then click **Create organization**. ### From your account settings Open the **Settings** section in the main menu, then open the **My account** page. Scroll to the **Organizations** card, then click the **Create organization** button. # Delete an organization Source: https://docs.hologram.io/dashboard/orgs-and-users/delete-organization Deleting organizations can be useful when merging accounts or simplifying your dashboard. Deletion is a manual process that must be requested by the organization owner. Before deleting an organization, you must deactivate or transfer all SIMs and pay any negative balance. **Important:** Hologram can only delete an organization in which all SIMs are either deactivated or transferred, and that the organization's balance is \$0. Please [click here](/dashboard/sim-actions/transfer-to-organization) for more information on transferring SIMs to other organizations and [click here](/guides/billing/transfer-balance) for more information on transferring funds to other organizations. ## Requirements before deleting an organization You must be the owner of the organization. If you are not the owner, please request the owner to take these steps. You can find the owner's email in the [organization settings](/dashboard/orgs-and-users/organization-overview) page. All SIMs have been permanently deactivated by following the instructions in [this guide](/dashboard/sim-actions/deactivate-sims), or have been transferred to other organizations your account does not own by following [these instructions](/dashboard/sim-actions/transfer-to-organization). The organization's balance must be paid and \$0. If the organization has a balance, it must be paid in the [Account page](/dashboard/billing/add-balance) before Hologram can delete the organization. We recommend also turning off auto-refill in the [Account page](/dashboard/billing/auto-refill). Gather the [organization ID(s)](/guides/troubleshooting/find-org-id) of the organization(s) you want to delete. ## How to delete an organization To delete an organization, email [support@hologram.io](mailto:support@hologram.io) ***from the email that owns the organization you want deleted*** filling out the template below. If active, Hologram will turn off account auto-refill after all SIMs are deactivated. Once all steps above have been completed Hologram Support will proceed with deleting your organization(s). ## Email template ### Subject ```text theme={null} DELETE ORGANIZATION ``` ### Body ```text theme={null} Organization ID(s): All SIMs have been deactivated or transferred?: Balance has been paid?: Are you the owner of all listed organizations?: Please permanently delete the following organizations: . I acknowledge that I have already permanently deleted or transferred all SIMs associated with these organizations. ``` ## Example email ### Subject ```text theme={null} DELETE ORGANIZATION ``` ### Body ```text theme={null} Organization ID(s): 12345, 12346 All SIMs have been deactivated or transferred?: Deactivated Balance has been paid?: Yes Are you the owner of all listed organizations?: Yes Please permanently delete the following organizations: 12345, 12346. I acknowledge that I have already permanently deleted or transferred all SIMs associated with these organizations. ``` # Invite collaborators Source: https://docs.hologram.io/dashboard/orgs-and-users/invite-collaborators Add teammates to your organization and choose their access level. ## How to invite collaborators to an organization Open the **Settings** section in the main menu, then navigate to the **This organization** page. The **Team** tab will open by default. Click the **Invite collaborators** button in the header. Enter a comma-separated list of email addresses, then use the **Role** dropdown menu to select the collaborator's access level (Editor, Manager, Admin) based on what they should be able to do. Click the **Send invitation** button to send the invitation to the email addresses you entered. ## How to resend or cancel pending invitations After sending an invitation, pending invitations will be listed in the **Team** tab in the **Pending invitations** card at the bottom of the page. You can cancel or resend invitations from this card. ## User role permissions Permissions are granted to users based on their role in the organization. | Permission | Admin | Manager | Editor | Editor limited | | - | - | - | - | - | | View SIMs, data usage, and cloud messages | ✅ | ✅ | ✅ | ✅ | | Pause and resume data usage | ✅ | ✅ | ✅ | ✅ | | Manage settings that don't affect costs | ✅ | ✅ | ✅ | | | Manage app integrations | ✅ | ✅ | ✅ | | | Invite users with lower permissions | ✅ | ✅ | ✅ | | | Activate and deactivate SIMs | ✅ | ✅ | | | | Manage settings that could affect costs (e.g. changing data plans) | ✅ | ✅ | | | | Change billing settings | ✅ | | | | **Note:** Only organization Owners and Admins can change user roles. The Editor Limited role is available to organizations with an active contract by [contacting our support team](/guides/get-started/contact-support). ## Related guides Get an overview of user roles and permissions and how to change them # Organizations details Source: https://docs.hologram.io/dashboard/orgs-and-users/organization-overview An organization is the shared account for your company or team. An organization lets you manage a collection of SIMs, and each organization is a single billed entity. Learn about organizations, collaborators, and how to manage access in Hologram. ## Organization details Find details about your organization including the name, ID, and current users and roles by opening the **Settings** section in the main menu and navigating to the **This organization** page. Each user also has a personal organization by default. Collaborators cannot be invited to personal organizations. ## Switching organizations In the top left corner of your dashboard, you will see the name of the current organization you are working in. Click on this name to open the **Organization picker** and switch to another organization. ## Related actions Change which organization you are working in Add teammates to your organization Join an organization as a collaborator Choose which organization opens by default # Switch organizations Source: https://docs.hologram.io/dashboard/orgs-and-users/switch-organizations You have access to multiple organizations in your dashboard, and may need to switch between them to manage your SIMs or collaborate with your team(s). ## How to switch organizations Switch organizations by clicking the dropdown menu in the **top left corner** of your dashboard that shows the name of the current organization. Click your current organization name in the top left corner of the main menu. Organization picker If you're a member of multiple organizations, select the one you want to switch into. Organization picker The organizations you have access to are also listed under **Settings → My account** in the **Organizations** tab. This is the same list of organizations you see in the dropdown menu, and you can switch to any of them by selecting the organization name. ## How to set your default organization If your dashboard continues to open your personal organization by default, you [change your default organization](/dashboard/account/change-default-organization). ## Related guides Create a new organization Choose which organization opens by default Learn about how to delete an organization # Transfer ownership of an organization Source: https://docs.hologram.io/dashboard/orgs-and-users/transfer-ownership Sometimes organization ownership needs to be transferred when a user leaves the organization or is no longer able to manage it. This guide outlines the process to follow to transfer ownership to a different user in your organization. ## How can I transfer ownership of an organization In order to transfer the ownership of an organization to a different user, first make sure that that user is added as collaborator on the organization in question. Read more about [creating and managing organizations](/dashboard/orgs-and-users/organization-overview). Once the desired new **Owner** is a collaborator on the organization, the current Owner must email [support@hologram.io](mailto:support@hologram.io) ***from the email that owns the Hologram organization you want deleted*** following the template below. Replace the `<>` tags with your request: **Note:** Requesting a transfer of ownership will not update your [billing information](/dashboard/billing/update-payment-method) or [transfer your SIMs](/dashboard/sim-actions/transfer-to-organization) from either Dashboard. You may take those actions within the desired Dashboard, after access is granted. **Subject** ``` Account transfer ``` **Body** ``` Please permanently transfer Organization to user . I acknowledge that I will no longer be the owner of that organization or the SIMs that are in it. ``` ## How can I transfer ownership if we no longer have access to the owner's email? If you no longer have access to an organization owner's email address, you must follow this process so that Hologram can verify that you are the owner of the email address and domain. 1. Add a **TXT** DNS Record on the business domain associated with the owner's email address. For example, `hlgresearch.com` for a an owner address of of `kiera.bennett@hlgresearch.com`.\` * Set the TXT record to **`holoadmin=owneremail@yourdomain.com`** 2. Reach out to Hologram's support team at [support@hologram.io](mailto:support@hologram.io) and request a transfer of ownership. Provide the domain name, email address, organization ID, and confirmation that you have added the TXT record using the template below. 3. Hologram's support team will verify the TXT record was added within 24-48 hours using a DNS service. 4. Once this is confirmed we can proceed with the transfer of ownership. **Subject** ``` Organization transfer TXT record verification ``` **Body** ``` Please permanently transfer Organization to user . I acknowledge that I will no longer be the owner of that organization or the SIMs that are in it. Previous owner's email: Previous owner's domain: I have added a DNS TXT record to the domain to confirm ownership: ``` # Change user roles Source: https://docs.hologram.io/dashboard/orgs-and-users/user-roles Manage team members with access to collaborate in an organization, and limit or grant access to dashboard features with user roles. ## Changing user roles Open the **Settings** section in the main menu, then navigate to the **This organization** page. In the **Team** tab that loads by default you will see a list of all current users in your organization. Click the **Manage access** button in the right side of the user's row. Change user roles In the **Change user role** modal, select the new role and press **Update role** to save your changes. ## User role permissions Permissions are granted to users based on their role in the organization. | Permission | Admin | Manager | Editor | Editor limited | | - | - | - | - | - | | View SIMs, data usage, and cloud messages | ✅ | ✅ | ✅ | ✅ | | Pause and resume data usage | ✅ | ✅ | ✅ | ✅ | | Manage settings that don't affect costs | ✅ | ✅ | ✅ | | | Manage app integrations | ✅ | ✅ | ✅ | | | Invite users with lower permissions | ✅ | ✅ | ✅ | | | Activate and deactivate SIMs | ✅ | ✅ | | | | Manage settings that could affect costs (e.g. changing data plans) | ✅ | ✅ | | | | Change billing settings | ✅ | | | | **Note:** Only organization Owners and Admins can change user roles. The Editor Limited role is available to organizations with an active contract by [contacting our support team](/guides/get-started/contact-support). ## Related actions Add teammates to your organization # Take bulk actions on your SIMs Source: https://docs.hologram.io/dashboard/sim-actions/bulk-actions-overview Your dashboard gives you control to manage, troubleshoot, and act on your devices in a simple interface. This guide covers the bulk actions available for managing multiple SIMs at once through the Hologram Dashboard, providing efficient ways to perform common operations across your fleet. ## How do I take bulk actions on many SIMs? All available bulk actions can be found in the **Manage SIMs** menu at the top of the SIMs pages. Find the SIMs you need to act on with filters and sorting, then select SIMs in the table to take bulk actions. Shift-click to select a range of SIMs, or right-click any checkbox to select the first 10, 1,000, or 10,000 SIMs. See [Filtering the SIMs pages](/dashboard/sims/sims-filters) for all selection options. The SIMs and filters you have selected will stay selected even if you change filters or navigate away from the page. Manage SIMs menu interface All of these bulk actions and more can also be [taken on a single SIM](/dashboard/sim-actions/single-sim-actions-overview). For advanced automation or to work around limits for larger fleets, consider using the [Hologram REST API](/api/v1) to programmatically manage your SIM fleet. **Note:** Some actions may not be available depending on a SIM's current status (active, in testing, or deactivated), your user role permissions, or features available to your organization. ## Available bulk actions Prevent or allow data usage. No SIM limit. Add, edit, and delete tags from your SIMs. No SIM limit. Rename your SIMs using custom prefixes. Limited to 1,000 SIMs. Send SMS messages, or TCP or UDP cloud messages to your SIMs. No SIM limit. Activate Test Mode SIMs out of pre-deployment testing before their testing has completed. SIMs must be on the same data plan. Limited to 10,000 SIMs. End your SIMs' current data sessions and reconnect them to the first available network. Active SIMs page only. Ineligible SIMs are skipped. Move your SIMs to a different data plan. Limited to 10,000 SIMs. Set a new data limit for all selected SIMs. No SIM limit. Updates run in 2,000 SIM batches. Set a new data warning threshold for all selected SIMs. No SIM limit. Updates run in 2,000 SIM batches. Move devices to different organizations. Limited to 10 SIMs. Configure Spacebridge tunneling settings. Limited to 10 SIMs. Permanently deactivate SIMs you no longer need. Limited to 10 SIMs. ## How do I track the progress of bulk actions? Taking bulk actions on thousands of devices may take some time to complete. The **Pending activity list** allows customers to track progress on pending and in progress bulk action requests made through the Hologram Dashboard or REST API. **Set data usage limits** and **Set data warning thresholds** run in the action modal instead. Updates are written in 2,000 SIM batches, and progress displays in the modal footer. ### View pending bulk actions When any bulk action is in progress, a new icon will appear in the header of your dashboard between the search field and your organization's name. Click on this activity icon to open the list of pending bulk actions. **Note:** The pending activity list button will only be visible if there is a pending bulk action. The pending activity list shows all pending and in progress bulk actions. Each action listed shows the status of the activity, the number of affected devices, when the activity started, and who made the request. To view completed bulk actions, press the **Review completed actions** button shown immediately beneath the list, which will open the [Activity history](/dashboard/sims/sims-activity-history) page.   **Note:** We plan to add additional bulk actions and lift SIM limits for existing bulk actions in the future. If you have a specific use case in mind, please send us feedback using the **Support** menu in your dashboard. **Limited functionality:** Some functionality in your dashboard is restricted or unavailable if you are in a Manager, Editor, or Editor Limited role. # Change data plans Source: https://docs.hologram.io/dashboard/sim-actions/change-data-plans Move SIMs to a different data plan to adjust network coverage or pricing. If you have contracted rates, you may want to change data plans to make sure your SIMs are on the right plan for your needs. ## How to change data plans for a single SIM Open a SIM from the **SIMs** pages or using **global search**. Click the **Manage SIM** menu at the top right of the SIM's details page and choose **Change data plans**. Select the target data plan from the available options. Choose **Pause at 10 GB** (recommended), **Unlimited**, a **custom amount**, or **Keep existing data limits**. See [data limits when changing plans](#data-limits-when-changing-plans). Review pricing changes and confirm the plan change. ## How to change data plans in bulk You can change data plans for up to 10,000 SIMs at a time in your dashboard. If you choose SIMs on different data plans, the plan change and any changes to tags or naming will only be applied to SIMs that are *not already on the new plan you choose*. SIMs already on the new plan still receive the data usage limit you set. You can only choose data plans available to all SIMs you have selected. Selecting SIMs with different installed profiles may restrict your choice of data plans. The workflow displays each SIM's **SKU** and **manufactured profile ICCIDs**. If a SIM or profile cannot be added to the change, you will see an error that distinguishes SIM-level issues from profile-level issues. Navigate to the **Active SIMs** page in the **SIMs** section in the main menu. Use filters to **find and select** the SIMs you want to want to change to a new data plan. Click the **Manage SIMs** menu at the top of the page and choose **Change data plans**. **Choose your new data plan** from the available options, then review the plan change details and charges and confirm the plan change. Review the plan rates and coverage for the new data plan. *Optional:* Set a data usage limit — **Pause at 10 GB** (recommended), **Unlimited**, a **custom amount**, or **Keep existing data limits** — or a data warning threshold. See [data limits when changing plans](#data-limits-when-changing-plans). *Optional.* Update name prefixes or tags for SIMs that will be updated. Review the plan change details and charges, then confirm the plan change. ## Data limits when changing plans Data usage limits are entered as the SIM's **total** limit, including any data included in the new plan. The form pre-fills the SIMs' existing total limits when it can. * **Custom amount:** Must be more than the new plan's included data. You cannot set a 0 B limit on data plans that do not include data. * **Pause at 10 GB:** Not available on plans that include 10 GB or more. * **Unlimited:** Removes any existing data usage limit from the selected SIMs. * **Keep existing data limits:** Keeps each SIM's current total limit. This option is disabled, with an explanation, when the selected SIMs have different limits, when the existing limit isn't more than the new plan's included data, or when existing limits couldn't be looked up. If a data limit can't be written to SIMs that are already on the new plan, a notification tells you how many SIMs to update. Set their limits from the **SIMs** pages using [Set data usage limits](/dashboard/sim-actions/set-usage-limits). ## How to change data plans using the REST API Change data plan for devices (bulk) POST /devices/changeplan ## Related actions Set data usage limits to control costs with new plans Pause or resume SIMs to manage data usage during transitions # Deactivate SIMs Source: https://docs.hologram.io/dashboard/sim-actions/deactivate-sims Deactivation is a **permanent, irreversible process** that ends all network connectivity and billing for a SIM that you no longer need. You can deactivate up to 10 SIMs at a time in your dashboard. You must be in an Organization **Owner**, **Admin**, or **Manager** role to have the necessary permissions to deactivate SIMs. **Danger:** Deactivation is a **permanent and irreversible process**. Once deactivation is confirmed with our carrier partners and the SIM completes the deactivation process, it cannot be undone and the SIM will need to be physically replaced. If you aren't using a device for some time—like for seasonal deployments—and want to avoid any charges for data usage, you likely want to **pause** the SIMs instead of deactivating them. Read about how to [pause SIMs](/dashboard/sim-actions/pause-resume-sims). After a SIM is deactivated, it appears in the **[Deactivated SIMs](/dashboard/sims/sims-deactivated)** page. ## Deactivate SIMs in bulk Bulk deactivation in your dashboard is limited to 10 SIMs at a time. We limit this action to limit accidental deactivations by customers that really want to pause their SIMs. To bulk deactivate more than 10 SIMs at a time, [you will need to use the API](/guides/rest-api/deactivate-sims-using-the-rest-api). Open the SIMs section from the in the main menu of your dashboard. The Active SIMs page will open by default. Find the SIMs you would like to deactivate, then use the checkboxes on the left-hand side of the SIMs list to select the SIMs. After selecting the SIMs to deactivate, open the **Manage SIMs** menu above the SIMs table and select **Deactivate SIMs**. The Deactivate SIMs modal will then display and show important information about the deactivation process. **All fields are required**, including filling in the bottom two fields exactly as labeled. *Click and hold* the **Hold to deactivate** button at the bottom of the screen to begin the deactivation process. This button does not work on mobile devices. When the confirmation notification appears, we send on the deactivation request to our carrier partners, beginning the deactivation process. Once this process completes with our carrier partners, a process which can take **up to 30 days**, the SIM is permanently and irreversibly deactivated. ## Deactivate a single SIM Find your SIM using the **SIMs** pages or **global search** and open the SIM's details page. In the header of the SIM's details page, open the **Manage SIM** menu and select **Deactivate SIM**. Follow the same process as the [bulk deactivation process](/dashboard/sim-actions/deactivate-sims#deactivate-sims-in-bulk) outlined above. ## Deactivate SIMs using the REST API Pause, resume, or deactivate devices (bulk) POST /devices/batch/state ## Related actions Pause or resume SIMs for temporary service suspension Change data plans for your SIMs Set data usage limits for your SIMs # End Test Mode and activate SIMs Source: https://docs.hologram.io/dashboard/sim-actions/force-activate-from-test-mode Activate multiple SIMs out of pre-deployment testing before their free testing period has completed. This action activates SIMs out of Test Mode, and begins regular billing of data usage and monthly recurring charges. You can force activate SIMs out of Test Mode before their free testing period has completed. This action activates SIMs out of Test Mode, and begins regular billing of data usage and monthly recurring charges. Generally this is not needed for any SIMs except for SIMs that are on a legacy Global-1 (G1) data plan, which experience a brief disconnection when activating to update profile states. **Note:** SIMs in Test Mode will activate automatically after using free data, with **no downtime or action required** on your part. Read more about [how Test Mode works](/guides/sims/test-mode). ## How to end testing early and force activate SIMs To force activate SIMs out of Test Mode, they must be on the same preconfigured data plan. Scroll the pre-deployment SIMs page to the right to see the data plan each SIM will activate into, or use filters to select SIMs on specific plans. SIMs selected in the Pre-deployment SIMs page with the SIM Actions menu open and 'End testing and activate' visible Navigate to the **Pre-deployment SIMs** page in the **SIMs** section in the main menu. Use filters to **find and select** the SIMs you want to activate. *Required:* Confirm that all selected SIMs are on the same data plan. If SIMs are on different data plans, you can filter and activate SIMs on each data plan separately. Click the **Manage SIMs** menu at the top of the page and choose **End testing and activate**. *Optional.* Confirm or change the target data plan from the available options. Review the plan rates and coverage for the new data plan. *Optional:* Set a data usage limit — **Pause at 10 GB** (recommended), **Unlimited**, or a **custom amount** — or a data warning threshold. You cannot set a 0 B data limit on data plans that do not include data. *Optional.* Update name prefixes or tags. Review the activation details and charges, then confirm the activation. **Warning:** Activating SIMs will begin regular Monthly Recurring Charges and data usage billing. Ensure your account has sufficient balance before proceeding. Once activated, SIMs cannot return to Test Mode. ## How to activate SIMs using the REST API For programmatic activation, use the [SIM Activation API endpoints](/api/1/) to activate SIMs via REST API calls. Force activate SIMs (bulk) POST /links/cellular/bulkclaim ## Related actions Set data usage limits to control costs after activation **Limited access:** Learn more about Test Mode and streamline your deployments by contacting our [sales team](https://www.hologram.io/contact-sales?utm_source=docs\&utm_medium=website\&utm_content=test_mode_callout). # Refresh a SIM's network connection Source: https://docs.hologram.io/dashboard/sim-actions/network-refresh Perform a **network refresh**, issuing an update location request, to end a SIM's current data session and have it reconnect to the first available network. Use it when you can't physically reboot a device. If the SIM is connected, the refresh should close the current session and reconnect. If the SIM isn't connected, the refresh happens the next time the SIM tries to connect to a network. **Note:** Hologram recommends rebooting your device instead of using a network refresh if your device is physically accessible. ## Which SIMs can perform a network refresh? SIMs that meet both of these conditions can be refreshed: * The SIM is in the **Ready** or **In testing** status (`LIVE` or `TEST-ACTIVATE` network state). * The carrier for the SIM's enabled profile supports update location. G2 and US2 profiles, for example, don't support update location requests. ## How to refresh a single SIM 1. Open a SIM from the SIMs pages or using global search. 2. Click the **Manage SIM** menu at the top of the page and choose **Network refresh...**. 3. Review the details, then click **Submit network refresh**. ## How to refresh SIMs in bulk 1. Navigate to the **SIMs** section in your dashboard and open the **Active SIMs** page. 2. Use filters to find and select up to 10 SIMs you want to refresh. 3. Click the **Manage SIMs** menu at the top of the list and choose **Network refresh...**. ## How to perform a network refresh using the REST API Update location / Network refresh POST /links/cellular/updatelocation The REST API works differently from the dashboard: * You pass profile (cellular link) IDs, up to 10 per request. * If any profile in the request fails a check, the whole request is rejected and none of the profiles are refreshed. * Add `?preview=1` to run every check without sending the refresh. This lets you confirm a selection is eligible first. ## Related actions Pause or resume data usage for your SIMs Switch a SIM with Outage Protection™ to a different profile # Pause or resume SIMs' data usage Source: https://docs.hologram.io/dashboard/sim-actions/pause-resume-sims You can pause or resume data usage for multiple SIMs in bulk through your dashboard. This action prevents or allows data usage across your selected SIMs without affecting their activation status. ## What does pausing a SIM do? Pause a SIM's data usage to temporarily disable all connectivity for your device through the SIM. The SIM will not be able to send or receive SMS, or connect to the internet. This may be useful if you expect a device to be inactive for a period of time and want to ensure you aren't charged for any data usage. When you or another user pauses a SIM's data usage: * The SIM stops passing data immediately, closing any open data sessions. * The SIM enters a **Paused** status. * **Monthly recurring charges (MRCs) still apply** to retain access to the Hologram network. * The SIM remains activated and can be resumed at any time. * You cannot change the SIM's data plan. **Note:** SIMs paused by Hologram will show a **Paused by system** status (`PAUSED-SYS` state). This most often occurs after running out of funds in your account balance. After you add funds to your account balance, it will automatically resume. These SIMs cannot otherwise be manually resumed. When you resume a SIM's data usage: * Resuming a SIM from a **Paused** usually takes under a minute, but can take up to 10 minutes to complete and timing may vary across profiles. * The SIM can again freely pass data based on its data plan. * The SIM remains activated and can be paused at any time. ## How are paused SIMs charged? Monthly recurring charges (MRCs) still apply to retain access to the Hologram network. There are no additional charges or fees to resume usage. There are no prorated discounts, changes to billing cycles, or other special cost considerations for paused SIMs. If you have access to zero-data rates, then zero-data discounts or charges are applied for each SIM that did not pass data during a billing cycle at the end of that billing cycle. ## How to pause or resume a single SIM 1. Open a SIM from the SIMs pages or using global search. 2. Click the **Manage SIM** menu at the top of the page. 3. Choose **Pause data usage** or **Resume data usage**. 4. Confirm your selection. ## How to pause or resume SIMs in bulk 1. Navigate to the **SIMs** page in your dashboard. 2. Use filters to find and select the SIMs you want to modify. 3. Click the **Manage SIMs** menu at the top of the list and choose **Pause data usage** or **Resume data usage**. 4. Confirm your selection. ## Are there any special considerations for paused SIMs? Note: **USA-2** profiles can be paused for a maximum of 90 consecutive days and a maximum of 180 days per calendar year. ## Viewing a record of pause and resume actions You can view a record of all pause and resume actions taken on your SIMs in the **Activity history** page in the **SIMs** section of your dashboard. 1. Navigate to the **SIMs** section in your dashboard and open the **Activity history** page. 2. View the record of user-initiated pause and resume actions taken on your SIMs in the **Bulk actions** card. ## How to pause or resume data usage using the REST API Pause or resume devices (bulk) POST /devices/batch/state ## Related actions Set data usage limits to automatically pause SIMs at a certain usage amount Permanently deactivate SIMs and remove them from the Hologram network # Rename SIMs Source: https://docs.hologram.io/dashboard/sim-actions/rename-sims Rename multiple SIMs at once using custom prefixes to improve organization and identification across your fleet. This action helps maintain consistent naming conventions and makes device management more efficient. Consistent naming conventions help you identify SIMs quickly. Read more about [how to organize your fleet](/guides/sims/how-to-organize-your-fleet). ## How to rename a single SIM 1. Open a SIM from the SIMs pages or using global search. 2. Click the **name** of the SIM in the header of the SIM's details page. 3. Enter the new name. ## How to rename SIMs in bulk 1. Navigate to the **SIMs** section in your dashboard. 2. Use filters to find and select the SIMs you want to rename. 3. Click the **Manage SIMs** menu at the top of the page and choose **Rename SIMs**. 4. Enter your desired name prefix. The last 5 digits of the SIM's ICCID will be appended to the prefix to create the new name. 5. Confirm your selection. ## How to rename SIMs using the REST API Overview of how to rename SIMs with custom or sequential names using the REST API. Update device names (bulk) POST /devices/names ## Related guides How to organize your fleet Tag SIMs to organize your fleet. # Send messages to SIMs Source: https://docs.hologram.io/dashboard/sim-actions/send-messages-to-sims Learn how to send SMS, TCP, or UDP messages to SIMs through the Hologram Dashboard. This feature enables you to communicate with your devices or trigger specific actions across your fleet. The Hologram Cloud provides an API and an interface in your dashboard to send inbound SMS, TCP, or UDP messages to a cellular device through a SIM. By running a server on your device that listens on a given port, you can receive and process these messages. Hologram's cloud messaging allows you to send a **TCP or UDP message** to a specified port on your device. This is helpful when you want to send messages to your device using only data. **SMS** is commonly used by IoT devices to send command, configure, and control messages. For example, setting the APN without requiring any additional device setup. **Note:** Inbound SMS message are always free. ## How to send a message to a single SIM 1. Open a SIM from the SIMs pages or using global search. 2. Click the **Manage SIM** menu at the top of the page and choose **Send message to SIM** 3. Select your message type (**SMS**, **TCP**, or **UDP**) 4. Enter your message content, specify the port number for TCP/UDP messages, and send your message. ## How to send bulk messages 1. Navigate to the **SIMs** section in your dashboard. 2. Use filters to find and select the target SIMs. 3. Open the **Manage SIMs** menu at the top of the page and choose **Send message to SIMs**. 4. Select your message type (**SMS**, **TCP**, or **UDP**) 5. Enter your message content, specify the port number for TCP/UDP messages, and send your message. ## Subscribing to messaging events SIM messaging events are tracked in the **Event monitoring** section of your dashboard, including: * Outbound SMS messages sent from a SIM * Inbound SMS messages sent to a SIM * Inbound SMS messages received by a SIM * TCP or UDP messages sent to a SIM * API successful or failed responses for sending messages to a SIM You can subscribe to these events to receive email or webhook notifications when messages are sent to or received from your SIMs using [Alerts](/guides/cloud-and-tools/event-monitoring-and-alerts-overview). **Beta:** Alerts functionality is in beta and replaces our legacy Routes functionality. Some Routes functionality is no longer available, and you may find issues during the beta period. Please send us your feedback using the **Support** menu in your dashboard. ## How to send a message to SIMs using the REST API Send a message to SIMs POST /devices/message Send a SMS to SIMs POST /sms/incoming Send SMS from SIM to phone number POST /sms/outgoing ## Related actions View outbound SMS usage details Get outbound SMS usage GET /usage/sms # Monitor usage with data usage warning thresholds Source: https://docs.hologram.io/dashboard/sim-actions/set-data-warning-threshold Data warnings help you monitor data usage and take action before incurring additional charges or reaching a data usage limit. Set a data warning threshold to create an [event](/guides/cloud-and-tools/event-types-and-tags) when a certain amount of data is reached. Then, create an [alert](/dashboard/event-monitoring/alerts-and-notifications) to be notified when the threshold is reached. ## What are data usage warning thresholds? Data warning thresholds are set per-SIM, and are triggered when a SIM's usage crosses a threshold you define after a data session closes. Data warning thresholds, like data usage limits, are tracked at the SIM's unique 30-day billing cycle. **Data usage thresholds do not prevent data usage**, they create events that you can monitor with alerts to then take action before incurring additional charges or reaching a data usage limit. For automated data usage enforcement, combine data usage warnings with [data usage limits](/dashboard/sim-actions/set-usage-limits) to track usage, and then manage data usage before the limit is reached and your SIM is paused. **Warning:** Data usage thresholds do not pause SIM data. To automatically stop data at a threshold, set a **[data usage limit](/dashboard/sim-actions/set-usage-limits)** instead. This value is the `datathreshold` parameter returned in the REST API. A threshold of **0 B** is allowed. It creates a warning event at the first data usage of each billing period. **Tip:** Set the data warning threshold **below** the SIM's data usage limit. A warning is only created when a session ends that brings the SIM over both values, so a threshold at or above the limit may never be reached. ## Set a data warning threshold for a single SIM 1. Find the SIM in the SIMs pages or using global search. 2. Open the **Manage SIM** menu in the header, and select **Set data warning threshold**. 3. Enter the threshold amount in KB/MB/GB, and confirm the update. ## Set data warning thresholds in bulk You can set data warning thresholds for any number of SIMs. Updates are written in batches of 2,000 SIMs, and the modal shows progress while the update runs. If the SIMs you selected have data limits set to the same value, the modal shows that limit for context. This check will work for up to 500 SIMs. 1. Navigate to the **SIMs** section in your dashboard and open the **Active SIMs** page. 2. Use filters and sorting to find and select the SIMs you want to set usage thresholds for. 3. Open the **Manage SIMs** menu at the top of the page and choose **Set data warning threshold**. 4. Configure the usage threshold settings and select **Update**. **Note:** If an update only succeeds for some of the selected SIMs, the modal stays open, reports how many SIMs were updated, and refreshes those SIMs in inventory so you can retry the rest. Success messages name the SIMs that were updated. ## Set data warning thresholds during activation or when changing data plans In the **Review rates and coverage** step of the SIM activation and change data plan process, you can set a new data usage threshold for your selected SIMs. **Warning:** When updating data usage thresholds during activation or when changing data plans, all existing thresholds will be removed. If you specify a new usage threshold for your SIMs, all existing thresholds will be replaced with the new setting. ## Set data warning thresholds using the REST API Set data warning thresholds (bulk) POST /devices/usagelimit (use the `datathreshold` parameter) Create a batch job to update data warning thresholds POST /devices/batch/usagelimit (use the `datathreshold` parameter) ## Related actions Set a data usage limit for all selected SIMs to prevent unexpected data usage charges or overage. Take actions on a single SIM from its details page with full control over SIM management. # Set data usage limits Source: https://docs.hologram.io/dashboard/sim-actions/set-usage-limits Data usage limits help you manage your SIMs' data usage and prevent unexpected charges or overage. A **data usage limit** defines the total amount of data the device can consume during a billing period. When a SIM reaches the limit you set, its data usage is paused. The organization's owner will also get an email notifying them of the pause. Data usage limits are checked at the close of each data session. If the SIM's data plan has included data, the data limit has a minimum value of that included data. This value is the `overagelimit` parameter returned in the REST API, and is checked *above* plan included data amounts. We recommend pausing SIMs at **10 GB** to protect against runaway data usage from theft or device misconfiguration. You can also leave a SIM unlimited or set a custom amount. **Warning:** You cannot set a **0 B** data usage limit on a data plan that does not include data. A 0 B limit would pause the SIM at the first data usage of the billing period. If a SIM already has a 0 B limit, the form will not pre-fill that value. ## How to set a limit for a single SIM 1. Open a SIM from the SIMs pages or using global search. 2. Click the **Manage SIM** menu in the header and choose **Set data usage limits**. 3. Choose a limit: * **Pause at 10 GB** (recommended) * **Unlimited** * **Custom amount** in KB/MB/GB 4. Confirm the update. ## How to set usage limits in bulk You can set data usage limits for any number of SIMs. Updates are written in batches of 2,000 SIMs, and the modal shows progress while the update runs. If the SIMs you selected have data limits set to the same value, the modal shows that limit for context. This check will work for up to 500 SIMs. If SIMs are on data plans with different included data amounts, will need to update SIMs on each plan individually. 1. Navigate to the **SIMs** section in your dashboard. 2. Use filters and sorting to find and select the SIMs you want to update. 3. Open the **Manage SIMs** menu and choose **Set data usage limits**. 4. Choose **Pause at 10 GB**, **Unlimited**, or a **custom amount**. 5. Review and apply the changes. **Note:** If an update only succeeds for some of the selected SIMs, the modal stays open, reports how many SIMs were updated, and refreshes those SIMs in inventory so you can retry the rest. Success messages name the SIMs that were updated. ## How to set usage limits using the REST API Update SIM data usage limits in bulk POST /devices/usagelimit Create a batch job to update SIM data usage limits POST /devices/batch/usagelimit **Note:** Set `overagelimit` in bytes; use `-1` for unlimited. Optional fields include `datathreshold` (alert only) and `smslimit`. ## Subscribing to data usage limit events SIMs that reach a data usage limit will create an event in the **Event monitoring** section of your dashboard. You can subscribe to these events to receive email or webhook notifications when a SIM's data usage limit is reached using [Alerts](/guides/cloud-and-tools/event-monitoring-and-alerts-overview). ## Why did my SIM pause before or after my exact limit? Data usage limits are checked at the **close of each data session**, not continuously during a session. Your SIM reports its usage when a session ends, and Hologram pauses the SIM if that total has reached or exceeded your limit. Because of this, the pause happens at a session boundary rather than at the exact byte: * If a session pushes cumulative usage past your limit, the SIM pauses when that session closes — so a SIM can use somewhat *more* than the limit within a single long session before pausing. * A SIM can also appear to pause slightly *below* a round number, because the limit was reached partway through a session and enforced at the next session close. When a limit pauses a SIM, it moves to the **Paused by system** status. To resume it, raise or remove the limit — usage restarts automatically. See [what causes the "Paused by system" status](/guides/troubleshooting/paused-by-system-sim-status). In addition, **data usage limits are checked against the SIM's 30-day billing period** that began on the day it was activated (making it an Active SIM). If you have monthly invoicing, this may not align with monthly billing periods for your organization, leading to data limit enforcement behavior that doesn't exactly match what you see in your dashboard. ## Related actions Set a data warning threshold for your SIMs to receive notifications when a certain amount of data is reached. Pause or resume SIMs to prevent or allow data usage. Change data plans for your SIMs. # Manage a single SIM Source: https://docs.hologram.io/dashboard/sim-actions/single-sim-actions-overview Your dashboard gives you the ability to take direct actions on your SIMs while referencing the most important information you need for troubleshooting. Take actions on a single SIM from its details page with full control over SIM management. ## What actions can I take from a SIM's details page? Every action you can take on a single SIM can be found in the page header. You can take actions on a single SIM by finding the SIM using search or from the SIMs pages and opening the SIM's details page. SIM details page header Most actions you can take on a SIM are also available as [bulk actions](/dashboard/sim-actions/bulk-actions-overview) from the SIMs pages. **Note:** Some actions may not be available depending on your SIM's current status (active, in testing, or deactivated), your user role permissions, or features available to your organization. ## Available single SIM actions Prevent or allow data usage for the SIM. For SIMs with fallback enabled and multiple installed profiles, switch this SIM to a different profile. Add, edit, and delete tags from the SIM using the tags field in the header. Rename a SIM by clicking on the name in the header. Send an SMS message to the SIM, or send a TCP or UDP cloud message to the SIM. Move this SIM to a different data plan. Set a new data limit for this SIM. Set a new data warning threshold for this SIM. End the SIM's current data session and reconnect it to the first available network, like a remote reboot. Configure secure device tunneling settings for this SIM. Move this SIM to a different organization. Activate Test Mode SIMs out of pre-deployment testing before their testing has completed. Permanently deactivate this SIM and remove it from the Hologram network. ## Actions available by SIM status | Action | Active SIM | Pre-deployment | Deactivated | | - | - | - | - | | Pause or resume data usage | | | | | Switch profiles | | | | | Tag SIM | | | | | Rename SIM | | | | | Send message to SIM | | | | | Set data usage limit | | | | | Set usage alert threshold | | | | | Change data plan | | | | | Transfer to another organization | | | | | Enable or disable secure device tunneling | | | | | Network refresh | | | | | End testing and activate SIM | | | | | Deactivate SIM | | | | **Limited access:** Some functionality in your dashboard is restricted or unavailable if you are in a Manager, Editor, or Editor Limited role. # Enable or disable secure device tunneling with Spacebridge Source: https://docs.hologram.io/dashboard/sim-actions/spacebridge-tunneling Configure Spacebridge tunneling to enable or disable secure, authenticated tunnels for inbound connectivity to any port on your IoT devices. Spacebridge provides secure remote access without exposing devices to the public internet. ## How to enable/disable secure tunneling for a single SIM 1. Find your SIM from the SIMs pages or using global search. 2. Click the **Manage SIMs** menu at the top of the page. 3. Choose **Manage secure device tunneling** 4. Confirm the configuration change ## How to enable/disable secure tunneling in bulk 1. Navigate to the **SIMs** page in your dashboard 2. Filter for devices you want to configure 3. Select up to 10 devices by checking the boxes 4. Click the **Manage SIMs** menu at the top of the list and Choose **Manage secure device tunneling** 5. Confirm the configuration change **Note:** For programmatic Spacebridge management, use the [Device Tunneling API endpoints](/api/1/tunnelkeys/get) to manage tunnel settings via REST API calls. ## Related guides Get started with device tunneling Establish a secure tunnel to a device using SSH Troubleshooting device tunneling # Switch profiles on a Multi-Core SIM Source: https://docs.hologram.io/dashboard/sim-actions/switch-profiles You can manually switch profiles on Multi-Core Hyper SIMs with Outage Protection™ to optimize connectivity. ## How do I switch profiles manually on a Multi-Core SIM We limit the ability to switch profiles to SIMs that are actively able to use data. If your SIM's data usage is paused, you will need to resume it before trying to switch profiles. This option will only appear for a SIM if its profile is able to be switched and the profile is Enabled or Disabled (`ENABLED` or `DISABLED` states). Open a SIM's details page from the **SIMs** section of your dashboard or by **searching** for it in the top navigation. In the details page that appears, press the **Manage SIM** button in the page header, and in the dropdown menu that appears choose the **Switch profiles** option. The Switch profiles modal window that appears gives an overview of how the profile configuration on your SIM will change after issuing a Switch Profile request. Press the **Switch Profiles button** to issue the request. A banner will appear on the SIM's details page if there is an active switch profile request pending for the SIM. Switching profiles should take under 10 minutes for most SIMs. ## Related guides # Tag SIMs Source: https://docs.hologram.io/dashboard/sim-actions/tag-sims Organize and manage your SIM fleet with tags. Tags help you categorize and report on SIMs by deployment location, device type, fleet customer, or any other criteria you choose. ## What are SIM tags? Tags are labels you can apply to SIMs to: * Group related SIMs together (e.g., "Chicago Office", "Temperature Sensors", "East Coast", "v2 hardware"). * Filter and search for specific groups of SIMs. * Apply bulk actions to tagged groups. * Generate reports and analytics by tag categories. ## How to tag a single SIM 1. Open a SIM from the SIMs pages or using global search. 2. Press the tags field in the header. 3. In the Tags modal that appears, add or remove existing tags or create new ones. 4. Confirm your selection. ## How to tag SIMs in bulk When bulk tagging SIMs, you can see tags that are already applied to some or all of the SIMs you've selected. 1. Navigate to the **SIMs** pages in your dashboard, and use filters to find the SIMs you want to tag. 2. Select SIMs by checking the boxes next to each SIM. 3. Click the **Manage SIMs** menu at the top of the page. 4. Choose **Manage tags**. 5. Add or remove existing tags or create new ones. ## How to tag SIMs during Activation During the [activation process](/dashboard/activation/activation-overview) or when changing data plans, you can apply tags to the SIMs you've selected after choosing a data plan. ## How to edit or remove tags from SIMs using the REST API List all tags GET /devices/tags Create a tag POST /devices/tags Update tag name PUT /devices/tags//updatetagname Delete a tag DELETE /devices/tags/ Add tag to SIMs POST /devices/tags//link Remove tag from SIMs POST /devices/tags//unlink ## Limitations * Tags are organization-specific and not shared across organizations. * Updating a tag is an immediate change. * Transferring SIMs between organizations does not transfer tags. # Transfer SIMs to a different organization Source: https://docs.hologram.io/dashboard/sim-actions/transfer-to-organization Transfer SIMs between organizations to organize your team's device deployments and consolidate organizations. Since SIMs belong to organizations and not users, transferring a SIM effectively transfers its ownership. ## Requirements to transfer SIMs Before you transfer a SIM: * You must be a member of both the originating and destination organizations. * You must be an Admin or Manager in the organization you are transferring the SIMs from. If you are trying to transfer SIMs to a new owner, they may need to create a new organization and add you as a collaborator. * Both organizations must have access to the SIM's **current data plan**. If the destination organization does not have access to the device's current data plan, then [contact support for help](/guides/get-started/contact-support). ## How to transfer multiple SIMs 1. Navigate to the **SIMs** pages in your dashboard. 2. Select the SIM(s) you want to transfer. You can transfer up to 10 SIMs at once. 3. Open the **Manage SIMs** menu and select **Transfer to organization**. 4. In the **Transfer SIMs** modal, select the organization you want to transfer the device(s) to from the list of organizations you are a member of. 5. Click **Transfer SIMs** to complete the transfer. **Note:** To transfer more than 10 SIMs at a time, use the [REST API](#how-to-transfer-sims-using-the-rest-api). ## How to transfer a single SIM 1. Open a SIM from the SIMs pages or using global search. 2. Open the **Manage SIM** menu and select **Transfer to organization**. 3. In the **Transfer SIMs** modal, select the destination organization. 4. Click **Transfer SIMs** to complete the transfer. ## How to transfer SIMs using the REST API For transferring SIMs programmatically or in larger batches, use the REST API. Transfer SIMs between organizations POST /devices/transfer ## Related actions Organize transferred SIMs with appropriate tags Apply new naming conventions in the destination organization # Search for SIMs and devices Source: https://docs.hologram.io/dashboard/sims/search Use the global search to quickly find any SIM or device in your organization by ICCID, name, IMEI, SIM ID, device ID, so that you can dig deeper or take quick actions. ## How to search for SIMs To find a SIM, use the **Search** bar at the top of the page. Search is globally available from every page of your dashboard. The search modal can be opened by clicking on the search bar in the nav menu, or use the **Ctrl+K** keyboard shortcut on Windows or **⌘+K** on a Mac. Search bar in navigation Once you type in a search term, we will automatically search across all **Active**, **Pre-deployment** and **Deactivated** SIMs with a single action. The search results page will display the first 8 matching SIMs in a list. To open a given SIM, either click on it with your mouse, or navigate using the arrow keys on your keyboard and hit **Enter** (**Return** on a Mac) to open the SIM's details page. Search results modal If there are more than 8 matching results and you don't see the device you are looking for, you may want to use a more specific search term. Or, you can open the **SIMs** page and use a combination of filters and sorting to find the SIM. ## Search terms You can search across the following data, returning results that **begin with** or **end with** your search term, using a minimum of 3 characters. Searching on SIM names will also return any name that **contains** your search term. * SIM ID * SIM name * SIM EID (eUICC ID) * Installed profile ID (link ID) * Installed profile ICCID * Device ID * Last known IMEI * Phone number *(if purchased)* ## Troubleshooting search results If you are searching for a SIM in your fleet and unable to locate it, please first check for misspellings, and that you have typed in the correct and accurate information you are searching for. Searches require **at least 3 characters**. Searches only return results that **begin with** or **end with** your search term, unless you are searching on name. Confirm that you have the correct organization selected. If you have just activated or renamed a SIM, it can take a few minutes for the SIM to be available via search. The update process is constantly running, so try to wait a couple minutes, refresh the page, and try the search again. If your organization has many devices with the same name, there may be a large number of results returned and finding the exact device you want might be hard. In this case, try narrowing your search by using a different ID. You can search for profiles currently installed on your SIM, and profiles manufactured on your SIM. Any other profiles. If your SIM has received over-the-air EUICC updates to uninstall a profile that was not manufactured on your SIM, that profile will not be searchable. ## Searching by IMEI The IMEI is the unique identifier of your hardware's installed modem. We usually get this from data session information shared from networks, and when we do, we store it in our system and it is available for search. In some cases, we do not get the IMEI back from a network, in which case you should try the ICCID, SIM ID, or name instead. If you are trying to find a SIM by searching for an IMEI, it is always best to use the entire IMEI number. If you do not have the entire IMEI, here are some helpful hints to help get you the best search results: * Search using the **last four or five** digits of the IMEI. * **Do not** search by using the middle portion of the IMEI. * Search for the **first few** digits of the IMEI. As long as you include the very first digit of the IMEI, any number of digits will work (the more the merrier). A partial search that does not include the very first digit will not display your intended device. When searching IMEI, here are some sample searches that will (or won't) work: IMEI search examples ## Still having trouble? If you have recently updated any of the SIM's information or added a new SIM to your organization, your new SIM or name updates may not be immediately available in Hologram's search database. However, these updates are regularly processed within a few minutes on a rolling basis for accurate search results. If after a few minutes you are still unable to find a SIM via the search bar, please reach out to [support@hologram.io](mailto:support@hologram.io) with your search parameters and any other identifying information about the device so the team can investigate. ## Related guides Use filters to find and manage specific SIMs. Find detailed data usage information across your fleet with comprehensive filtering. # SIM Alerts tab Source: https://docs.hologram.io/dashboard/sims/sim-details-alerts-tab Use the Alerts tab to create and manage alerts for Hologram Cloud events tracked for a SIM. Events that trigger alerts display on the Events tab, and include SIM messaging, IMEI changes, data limits reached, and more. Here you can find a list of alerts configured for this SIM. Each alert shows the event type, the devices or tags it is configured to trigger for, and the notification method. SIM alerts tab Create a new alert by clicking the **Create alert** button. You'll be presented with a list of event types available to subscribe to. Then, you can configure the alert to send notifications via email or webhooks. # Explore SIM coverage and rates Source: https://docs.hologram.io/dashboard/sims/sim-details-coverage-tab Use Coverage Explorer in a SIM's **Coverage** tab to find the exact networks your SIM can connect to and the rates you can expect to pay per MB. A SIM's available coverage is determined by the SIM's active data plan, and the profiles installed on the SIM card. The enabled profile on a SIM determines networks it can connect to. ## Network coverage and rates card This card lists the networks your SIM can connect to, and the rates you can expect to pay per network. You can filter the list by profile, RAT, and country, or search for specific networks. SIM coverage tab Exporting the coverage list to XLSX or CSV will include detailed network metadata, including profile name, network name, rate per MB, country, UNC (Hologram's Universal Network Code for billing), TADIG, MCC, MNC, and available RATs. **Limited access:** Some functionality in your dashboard is restricted or unavailable if you are in a Manager, Editor, or Editor Limited role. ## Related guides # SIM Recent data usage tab Source: https://docs.hologram.io/dashboard/sims/sim-details-data-usage-recent-tab Detailed session-level data usage for a SIM is found in the **Data usage tab**. These reports display recent data usage for the SIM's current billing period, broken down by network, profile, day, and location, with limited historical session reporting. The data usage tab displays recent data usage for the last 90 days, broken down by day, network, and profile. This page displays the last 250 sessions for a SIM. Load more sessions by clicking the **Load 250 more sessions** button in the top-right of the Usage by day card. Recent data usage is available for the last 90 days and is reported in near-real-time. Single SIM recent data usage tab ## Data usage by day card Find a summary of data usage by day and profile for a SIM. SIMs that used data across multiple profiles in a single day will display multiple rows for that day. A SIM's 30-day billing periods are displayed as header rows in the table. If usage in a day spans multiple billing periods, usage is separated into multiple rows. Single SIM recent data usage tab by card ## Data usage by network card This card displays data usage grouped by network, country, profile, and cellular tower ID for a SIM. Single SIM recent data usage tab by network card ## Data usage by profile card This card displays data usage grouped by profile for a SIM. Single SIM recent data usage tab by profile card   **Limited access:** Recent data usage for the **last 90 days** is available to self-service organizations with under \$100 USD in monthly recurring charges and data usage. Contact our [Sales team](https://www.hologram.io/contact-sales?utm_source=docs\&utm_medium=website\&utm_content=recent_data_usage_tab) for access to [full historical reporting](/dashboard/sims/sim-details-data-usage-tab). # SIM data usage tab Source: https://docs.hologram.io/dashboard/sims/sim-details-data-usage-tab Detailed, historical session-level data usage for a SIM is found in the **Data usage tab** for qualifying organizaitons. These reports display historical data usage for the SIM's current billing period, broken down by network, profile, day, and location, with limited historical session reporting. **Limited access:** Historical data usage reporting is available to organizations with an active contract, or over \$100 USD in monthly recurring charges and data usage. All other organizations have access to 90 days of [recent data usage](/dashboard/sims/sim-details-data-usage-recent-tab). Historical data usage is available for at least 365 days and is updated every 60 minutes. ## Data usage details tab (default) Find summarized data usage within the selected date range for a SIM card by network, profile, or day to understand overall data usage behavior and connectivity changes, and to identify possible device configuration problems from zero-byte sessions. **Note:** Data within these reports **refreshes hourly**, and may not contain the most recent sessions for a SIM. * **Data usage by network** - Total data usage broken down by network and profile. * **Data usage by profile** - Total data usage by profile, especially useful for SIMs with multiple installed profiles and Outage Protection™. * **Data usage by day** - Total data usage broken down by day. Single SIM data usage details report #### Key metrics and terms Total data usage for the selected date range in a readable format. Total data usage for the selected date range in bytes. Total number of closed sessions in which data was passed through a network. Total number of sessions in which no data was passed through a network, indicating possible device configuration issues. Total number of device-originated SMS messages sent from the SIM that count toward a SIM's SMS limit.   ## Location history tab Detailed data usage broken down by location with a map of approximate device location. Data usage is categorized by region, country, network, tower, and latitude and longitude. **Limited access:** Some functionality in your dashboard is restricted or unavailable if you are in a Manager, Editor, or Editor Limited role.   ## Session history tab Detailed session-level historical data usage information for a SIM. Detailed data and filtering helps you identify exact issues and pinpoint exactly where and why problems occurred. Single SIM session history report #### Field descriptions Date/time in UTC the data session ended. Data usage reporting references this date as when data was “used” and billed. Date/time in UTC the data session started. Duration in seconds the session lasted. Total data usage for the session in a readable format. Total data usage for the session in bytes. Session or reporting windows if the carrier returns data in timed blocks. Name of the network used to pass data. Radio access technology used. Country the cellular tower was located within. Cellular tower ID as returned by the carrier, if provided. Crowdsourced tower location, if provided. ICCID of the connectivity profile used to connect. Name of the profile used to connect. ID of the SIM card. IMEI of the modem the SIM card connected through, if provided by the carrier and network. Data plan active on the SIM at the time the session closed, useful for identifying when a change in rates occurred. # SIM Events tab Source: https://docs.hologram.io/dashboard/sims/sim-details-events-tab Event history is a record of Hologram Cloud events tracked for a SIM, including messaging, IMEI changes, data limits reached, and more. Events are created when specific events occur in your fleet, and are tracked using event tags. Get notified when events occur by creating an [alert](/dashboard/event-monitoring/alerts-and-notifications). **Note:** The information in this page used to be displayed in the **Activity Console** drawer that opened from the bottom of your dashboard. The Events tab contains a list of Hologram Cloud events that occurred for apply to the current SIM. Each record shows whether the event was inbound to a SIM or outbound from it, the date and time of the event, the message passed through the event, and any event tags associated with the event that can be used with **Alerts** to trigger notifications. Any errors that occurred during the event are listed beneath the event tags. SIM events tab Pressing the **Details** button will open a modal with more information about the event, including raw message contents. The **Actions** menu provides a shortcut to send a SMS or TCP/UDP cloud message to the SIM. # SIM details page Source: https://docs.hologram.io/dashboard/sims/sim-details-overview Navigating to a SIM from search or the SIMs pages opens the **SIM details** page. Here you can find key identifiers, recent behavior, connectivity details, and all the actions you can take on that SIM. This page is also the first place to look when troubleshooting a SIM. SIM details page showing status tab with profile state information ## What information is available in the page header? Find the most commonly referenced details and IDs for a SIM, and all actions that can be taken on it, at the top of the page. Name of the SIM. Click to rename. Tags applied to this SIM. Click to manage tags. Opens all available actions that can be taken on this SIM through your dashboard. [Read more](/dashboard/sim-actions/single-sim-actions-overview) The name and ICCID of the connectivity profile that is enabled and currently able to use data on this SIM. Click profile name to visit the Profiles tab. Click ICCID to copy to clipboard. Total data usage for the SIM's current billing period. This is the unique 30-day billing period for prepaid organizations, month-to-date for postpaid organizations, and lifetime usage for SIMs in pre-deployment testing. The amount of data included in your chosen data plan, and the SIM's data usage limit if set. Hologram's unique ID for this SIM card. Click to copy to clipboard. IMEI of the last device this SIM connected through, if provided by the carrier and network. Click to copy to clipboard. ## What actions can I take on a SIM? All the actions you can take on a SIM are available in the **Manage SIM** dropdown menu in the right side of the page header. There you can pause/resume data usage, set data limits, change data plans, switch profiles, and more. Manage SIMs menu with actions available for a single SIM ## What information is available in each tab? # SIM pricing and data plan details Source: https://docs.hologram.io/dashboard/sims/sim-details-pricing-tab Find a summary of data plan pricing and rates for a SIM in the Pricing tab. This tab also lists monthly recurring charges, data limits, billing period details, and any add-ons associated with the SIM, like phone numbers. **Limited access:** Some functionality in your dashboard is restricted or unavailable if you are in a Manager, Editor, or Editor Limited role. ## Pricing card SIM pricing card This card provides a summary of data plan pricing and rates for a SIM, with links to plan details, coverage information, and other settings that impact SIM billing and pricing. The **Data usage** section lists data usage and SMS rates as well as any settings that impact data usage. The **SIM pricing** section lists monthly recurring charges and billing period details for your SIM. ## Add-ons card SIM add-ons card This card lists any add-ons associated with the SIM, like phone numbers. You can purchase or remove phone numbers from this card. # SIM Profiles tab Source: https://docs.hologram.io/dashboard/sims/sim-details-profiles-tab Find detailed information about connectivity profiles installed on a SIM. For multi-core Hyper SIMs, the Profiles tab details how Outage Protection™ will work for multi-core Hyper SIMs and provides details about past fallback events and profile installation history. ## Profiles card Lists the **profiles** currently installed on a SIM with primary identifiers, statuses, and their expected connectivity behavior. This card shows how network fallback will behave on a Hyper SIM with multiple installed connectivity profiles. SIM profiles card For fallback-enabled SIMs, explains how a SIM behaves when fallback is disabled. Labels that indicate which profile is enabled, and whether you can connect to other installed profiles. Hologram's name for the profile, which generally describes carrier partner coverage areas. Unique carrier-assigned identifier for the profile. Status of the current profile, which determines the current SIM status. Enabled/disabled status of the profile. The enabled profile is currently able to use data and connect to the internet. Unique Hologram identifier for a profile. APN required on your device to connect through this profile. If installed profiles have different APNs, additional warnings will display. Date the profile was installed onto this SIM. MSISDN of the profile. Fallback timer message describing behavior when the enabled profile loses connection, including timer details. This message also lists out ICCIDs manufactured on the SIM that are permanently associated with it and may be printed on the physical SIM card. Deactivated profiles are only displayed for a SIM if the SIM is also deactivated. ## Fallback history Lists a history of all fallback events for a SIM. Each fallback event represents a change in the enabled profile on a SIM, generally due to a carrier disconnection failover managed by Outage Protection or a profile configuration change. Detailed records of fallback events can also be found by reviewing session history and looking for changes in enabled profile ICCIDs or names. Sessions will list different ICCIDs when a fallback event occurs as the SIM has switched to a new profile. SIM fallback history card Profile that was changed to. When the SIM triggered a fallback. Profile that was disabled. Profile that was enabled. ## Profile history card Provides a full history of profile installations and removals from a SIM card. Profiles are listed oldest to the left, newest to the right. Each row represents a change to a single profile in the SIM's configuration. This card displays after expanding Show more details. SIM profile history card ## Related actions Learn how to switch to a different profile on a SIM with Outage Protection # SIM Recent sessions tab Source: https://docs.hologram.io/dashboard/sims/sim-details-recent-sessions-tab This view of a SIM provides near-real-time view of recent, closed data sessions within the last 90 days. SIM recent sessions tab with timeline chart of recent sessions **Caution:** This report provides information about closed sessions that occurred **within the last 90 days**. Organizations with over \$100 USD in monthly recurring charges and data usage gain access to full historical reporting in the **Data usage** tab. ## Recent sessions chart This chart provides a visual overview of the last 100 closed data sessions for a SIM and is useful for identifying patterns in session activity. Consecutive zero-byte sessions can be an indicator of device configuration issues. Hover over sessions for more details. ## Recent session details card Lists detailed information about recent data session for a SIM, including start and end times, duration, network, profile ICCID, IMEI (if available), and RAT. You can export the data to XLSX, CSV, or JSON formats using the **Export menu** in the top right of the Recent sessions card. Fallback events for SIMs with Outage Protection™ are indicated with a visual indicator and label. **Limited access:** Prevent unexpected outages with Outage Protection™ and get contractually guaranteed reliability by contacting our [sales team](https://www.hologram.io/contact-sales?utm_source=docs\&utm_medium=website\&utm_content=outage_protection_callout). Sessions that occurred during Test Mode are indicated with a Test Mode indicator and label. **Limited access:** Learn more about Test Mode and streamline your deployments by contacting our [sales team](https://www.hologram.io/contact-sales?utm_source=docs\&utm_medium=website\&utm_content=test_mode_callout). ## Related guides View session history and usage analytics for a single SIM Understand SIM-level plan rates and add-ons # SIM and device details tab Source: https://docs.hologram.io/dashboard/sims/sim-details-sim-and-device-tab The **SIM and device** for a single SIM provides detailed information about settings, IDs, and configuration information for a Hologram SIM, and any information we have about the device we last saw it in as provided by session records. Information provided in this tab is similar to device details returned through the REST API. ## SIM details card This card contains the primary identifying details for a SIM, configuration details, activation information, and SIM-level settings. SIM details card Displays only when the SIM is deactivating or deactivated. Includes when the SIM was deactivated (UTC). Coverage type (Dual-Core, Multi-Core, Single-Core, or Single-Core UICC), Outage Protection™ status, Installed profiles able to use data, and Required APN(s). SIM ID, Name, SKU, EID (eUICC ID), and MSISDN. Activation date/time (UTC), Entered testing (UTC), Testing duration, and Target activation date (if applicable). Outbound SMS limit and Phone number (if purchased and available). ## Last known device details card Details about the last known device the SIM was seen in. SIMs can move between physical devices, so these details are tracked separately. Device information is based on IMEI information provided through session data. Hologram generally does not manage information about your devices. Last known device details card Hologram-assigned ID for your device. Last known IMEI for the device, if available and provided by a network. TAC prefix for the IMEI, if available. Name of the modem, if it can be determined. Hardware model, if it can be determined. Device tunneling configuration using Spacebridge. ## Related actions Get device details GET /devices/ # SIM Status tab Source: https://docs.hologram.io/dashboard/sims/sim-details-status-tab This view of a single SIM provides an overview of the SIM's current connectivity, status, last known session details, last known location, and data usage for the SIM's current billing period. ## Status card An overview of the connectivity status of a SIM. It displays a path of connectivity to illustrate how a SIM connects to the internet and where communication for various status changes take place. Click to copy device, SIM, and enabled profile (link) IDs from this card. SIM connection status The SIM's current status and description. Displays the customer device ID. Click to copy to clipboard. Displays the Hologram SIM ID. Click to copy to clipboard. Displays the profile name of the mobile core operator. Hover to view and copy profile (link) ID for the profile. Represents the SIM's connection to the internet. ## Last connection card An overview of the last known session information for a SIM, as provided by the network and carrier. You can find open session details, location information, and information about reporting windows and the APN required for your device to connect. Note that not every network, carrier, or session provides information like IMEI, location, or ongoing data usage for open sessions. SIM last connection card Relative time since the SIM's last closed session or the start of its current open session. This matches the Last active column in the SIMs pages. For SIMs configured with pre-deployment testing, this session may have occurred during Test Mode. Summarizes total data usage for the last closed session. Displays only for reporting windows for carriers that return timed blocks of data usage rather than individual sessions. UTC timestamps of the last closed session, and how long it lasted. The cellular network the SIM last connected to in a data session. Radio Access Technology for the last closed session (e.g., 3G, 4G LTE). Country in which the last closed session occurred. Approximate crowdsourced latitude/longitude of the cell tower the SIM connected to, if available. ID of the network cell tower the SIM connected to, if provided by a network. Map of the latitude/longitude of the last known connection if known. Click to view in Google Maps. APN(s) required for device configuration, as determined by the SIM's installed profiles. The name and ICCID of the currently enabled connectivity profile a SIM can use data through. ## Usage this billing period card An overview of the data usage for the SIM's current billing period. If your account uses prepaid self-service billing, SIMs use data and are billed on a 30-day billing period beginning when the SIM was activated. If your account uses invoiced monthly billing, SIMs use data and are billed monthly. Data plan included data and data limits always apply to each SIM's unique 30-day billing period. SIM usage this billing period card Total data usage for this SIM's current billing period. The amount of data included in the SIM's current data plan, and the data usage limit if set. The SIM's current outbound SMS count and SMS limit. The SIM's current billing period. This is every 30 days for prepaid organizations, and monthly for postpaid organizations. SIMs in Test Mode configured for pre-deployment testing use data over their testing period and automatically activate after their testing period ends, using 100 KB of data, or sending 10 outbound SMS messages, whichever comes first. **Limited access:** Learn more about Test Mode and streamline your deployments by contacting our [sales team](https://www.hologram.io/contact-sales?utm_source=docs\&utm_medium=website\&utm_content=test_mode_callout). Lifetime test data usage for this SIM, and the threshold of data usage at which it will automatically activate. The SIM's current data usage against the free 100 KB it can use before activating. Total number of outbound SMS the SIM can use before activating. The date at which the SIM will automatically activate if it has not reached its data or outbound SMS limits. # Where to find SIM, device, and profile IDs Source: https://docs.hologram.io/dashboard/sims/sim-identifiers Learn about the primary identifiers for SIMs, devices, and profiles, and where to find them in your dashboard. The main identifiers for SIMs, devices, and profiles can be found in the first tab of the details page for a single SIM. SIM details Status tab with primary identifiers highlighted ## SIM identifiers ### SIM ID The **SIM ID** is Hologram's unique primary identifier for a SIM card. You can find this ID across dashboard and data usage records, but for a single SIM you can find it in the following locations: * SIMs pages tables * SIM details page header * SIM details page on the **Status** in the **Connectivity status** card * SIM details page on the **SIM and device** tab within the **SIM details** card ### SKU The **SKU** identifies the state of SIM hardware, as defined by its manfuactured or installed profiles. There are two versions of the SKU: * The SIM SKU is the contractually defined state of the SIM and its installed profiles, as defined by a contract or data plan. This SKU appears in contracts, purchase orders, and datasheets. * The Derived SKU is the current state of a SIM and its installed profiles. This SKU appears in the Change Plan workflow today. ### EID (eUICC ID) The EID (eUICC ID) for eUICC-enabled SIMs is a 32 digit identifier, and can be found on the **SIM and device** tab, in the **SIM details** card. EID (eUICC ID) location in SIM details page ### MSISDN The MSISDN is the unique phone number for a SIM card used for IoT communications and messaging. You can find it on the **SIM and device** tab, in the **SIM details** card. ## Profile identifiers ### ICCID The ICCID is the unique 18-22 digit identifier for a connectivity profile. Each SIM can have multiple profiles installed, and each profile has its own ICCID. We refer to the ICCID of the currently enabled profile able to use data as the "Enabled profile ICCID". You can find ICCIDs in the following locations: * SIMs pages tables (enabled profile ICCID) * SIM details page header (enabled profile ICCID) * SIM details page on the **Profiles** tab within the **Profiles** card (all installed ICCIDs) * SIM details page on the **Profile history** card (all historically installed ICCIDs) ICCID location in SIM details page ### Profile (Link) ID The Profile (Link) ID is Hologram's unique identifier the connection between a SIM and profile on a SIM card. This ID is commonly used in API calls. You can find it in the following locations: * SIM details page on the **Status** tab within the **Connectivity status** card. Hover over the profile name to reveal the Link ID. * SIM details page on the **Profiles** tab within the **Profiles** card. The link ID of each profile is displayed in the profile card. ## Device identifiers ### Device ID The **Device ID** is Hologram's unique primary identifier for your device. You can find this ID in the SIM details page, and it is often used in API calls. You can find it in the following locations: * SIM details page on the **SIM and device** tab within the **Device details** card * SIM details page on the **Status** in the **Connectivity status** card ### Last known IMEI IMEIs for devices are provided within session data by networks and carriers. We provide the last known IMEI for a device when able, but carriers and networks do not provide IMEI information for every session. You can find the last known IMEI in the following locations: * SIMs pages tables * SIM details page header * SIM details page on the **SIM and device** tab within the **Device details** card The IMEI TAC is the TAC prefix for the IMEI, if available. You can find it on the **SIM and device** tab within the **Device details** card. # SIM states and statuses Source: https://docs.hologram.io/dashboard/sims/sim-states-and-statuses Hologram SIMs in the dashboard and REST API can be in many different statuses or states based on how they are configured and whether they are able to transmit data. Learn what Ready, Connected, Paused by user, and Paused by system mean and how to move between them. A **SIM status** helps describe the current status of a SIM's configuration and its expected ability to transmit data. This status is based on the **network state** of the currently enabled profile on the SIM card. If you've used the Hologram REST API, this is the `state` or `networkState` field value. This is used to indicate the state of the SIM with regards to the network. SIMs in your dashboard are organized by these statuses within the **SIMs** pages in the main menu, and when viewing a single SIM's details page. Some important status terms to note: * A SIM that the system paused automatically (for a reached data limit, SMS limit, or low balance) shows as **Paused by system**. * A SIM your team paused manually and is still billed a Monthly Recurring Charge (MRC) shows as **Paused by user**. This is often known as a "suspended" SIM. * Permanently stopping a SIM and its charges is **deactivation**, a separate action. SIM statuses and states ## Where to find SIM statuses In your dashboard, SIM statuses are listed on the **SIMs page** views in the **SIM status column**. You can filter by SIM status using the **Filter** pane on the left-hand side of the page. Hover over any status in the table for a more detailed description of that status. SIM status column showing different status indicators with filter panel on left Find more detailed information about a SIM status by clicking on a SIM or searching for it to open the **SIM details** page. SIM status is shown in the page header. The **Status tab** status shows more detailed information about the status, and how we interpret that status. SIM statuses are based on the `networkState` of the enabled profile, if the SIM has connected through a device, and if a connection has been made to a network via a data session. The `networkState` field value is listed under the **Profile** section of the Status overview. SIM details page showing status tab with profile state information ## Connected SIMs **Connected** is an indicator that shows when a SIM has an open data session. It is not a distinct status or network state and can happen across most network states. A **Ready** SIM that is connected shows a single **Connected** status. Other statuses, such as **In testing**, show a separate Connected indicator next to the status. In some cases, profiles other than the enabled profile may be connected, for example if the SIM has fallback enabled and one profile sends reporting windows instead of data sessions. ## All SIM statuses and states ### Active SIM statuses SIMs in the following statuses are generally referred to as "Active SIMs" — SIMs that are connected to networks through our carrier partners, are able to use data, and are charged a monthly recurring charge. Please know that state changes do not interrupt active data sessions. This includes the "paused" SIM statuses. If a device is in a active data session, a request to pause a SIM in the Hologram portal will not interrupt that data session. | SIM status | Category | Network state (API) | Status description | | - | - | - | - | | **Ready** | Active | `LIVE` | This SIM is activated and able to connect to the Hologram network. | | **Pending** | Configuring | `LIVE-PENDING` | This SIM is being configured for use on the Hologram network.

*(Includes SIMs that are activating for the first time, and SIMs that are resuming data usage from a `PAUSED-...` state.)* | | **Pausing** | Configuring | `PAUSED-PENDING-USER` | This SIM is being paused by a member of your organization. Once paused, it will not be able to transmit data or SMS services. | | **Pausing** | Configuring | `PAUSED-PENDING-SYS` | This SIM is being paused due to an insufficient account balance, data usage limit, SMS usage, or another reason. Once paused, it will not be able to transmit data or SMS services. | | **Paused by user** | Paused | `PAUSED-USER` | This SIM has been manually paused by a member of your organization. While paused, your device will not be able to send or receive data or SMS messages. | | **Paused by system** | Paused | `PAUSED-SYS` | This SIM has been paused and cannot use data or SMS services. Once resolved, it may take up to 10 minutes to resume activity on the Hologram network. SIMs are often paused by reaching a data usage or SMS limit, or a lack of account balance. | **Note:** The **Connected** indicator displays if the SIM's current session is assumed to be "open," meaning the session has no end time. There is no Connected state in the REST API, as the status is derived from the `lastsession`'s `active` parameter. **Last active** times in dashboard and usage reports do not include open sessions. ### Pre-deployment SIM statuses | SIM status | Category | Network state (API) | Status description | | - | - | - | - | | **Available** | Inactive | `INACTIVE` | This SIM is assigned to your organization, but has not been activated. Activate it at any time to start using data on the Hologram network. | | **Entering testing** | Configuring | `TEST-ACTIVATE-PENDING` | This SIM is being configured for pre-deployment testing. Configuration can take up to 15 minutes. Timing varies based on network partner activity. | | **In testing** | In testing (test mode) | `TEST-ACTIVATE` | This SIM is in pre-deployment testing. The SIM will auto-activate when your testing period ends, it uses 100 KB of data, or sends 10 SMS messages. | **Note:** Legacy configuration states that are no longer used for new SIMs include `TEST-AUTOACTIVATE-PENDING`, `TEST-HIBERNATE-PENDING`, `TEST-AUTOACTIVATE`, `TEST-HIBERNATE`, and `INACTIVE-TESTED` These states may appear for in some organizations for some older SIMs. ### Deactivated SIM statuses | SIM status | Category | Network state (API) | Status description | | - | - | - | - | | **Deactivating** | Configuring | `DEAD-PENDING` | This SIM is being permanently deactivated. Once deactivated, it will no longer be able to transmit data or SMS services. | | **Deactivated** | Deactivated | `DEAD` | This device has been permanently deactivated from use on the Hologram network and cannot be reactivated. | # Active SIMs page Source: https://docs.hologram.io/dashboard/sims/sims-active The default view of your SIMs shows all Hologram SIMs that are able to connect to the internet, including all Paused and Ready SIMs. These SIMs have been activated are charged a per-SIM monthly recurring charge for access to our platform and network. ## Active SIMs overview The table lists recent data usage for each SIM, and provides a quick overview of each SIM's status and current configuration. Active SIMs are sorted by **Last closed session** date to help quickly identify SIMs with recent connections. Active SIMs page Active SIMs include all SIMs in a `LIVE...` or `PAUSED...` network state. Read more about [SIM statuses and states](/dashboard/sims/sim-states-and-statuses). ## Active SIMs fields Name given to this SIM card. The status of this SIM, which helps describe its ability to use data. Hover for a detailed description Date and time in UTC of the last closed session for the SIM. This is when data is billed and how we calculate data usage. Data usage for the SIM's current billing period. For prepaid/self-service billing, data usage is for the SIM's unique 30-day billing period. For postpaid invoiced billing, data usage is for the current calendar month. ICCID of the currently enabled profile able to use data. Click to view the SIM's installed profiles and fallback events. Name of the enabled profile, which generally describes available carrier coverage. The ICCID(s) installed on this SIM during manufacturing. These profiles are permanently associated with the SIM. The enabled manufactured profile is printed on triple-cut and embedded SIMs. IMEI of the last known device associated with the SIM, if known and provided by a carrier or network. Hologram's unique ID for a SIM card. Name of the currently active data plan which determine's a SIM's coverage and cost. *Not available to Editor Limited roles.* Date and time in UTC that this SIM was activated and was able to begin using ## Related guides # View user pause, resume, and activation history Source: https://docs.hologram.io/dashboard/sims/sims-activity-history The **Activity history** page allows you to find the history of all completed user-initiated activation, pause, and resume actions taken in the Hologram dashboard or REST API. ## How to find activity history Navigate to the **SIMs** section in the main menu and open the **Activity history** page. The Bulk actions card lists the date the action was completed, the type of action taken, how many SIMs were affected, and who took the action. The table is automatically sorted with the most recent activity at the top. Activity history page ## How to view activity history details Find the row with the record you want to review and press the **View details** button. This will take you to details pages with more information about the action taken, the user, and the SIMs affected. Activity history details page ## Where can I find other types of events? Additional event types can be found under the **Event monitoring** section of your dashboard, within the **Event history** page. These actions are system events tracked by Hologram, but do not yet have user-initiated information for auditing purposes. Event types include data limits reached, IMEI changes, IMEI TAC changes, first IMEI events, Conductor-initiated configuration changes, SMS/TCP/UDP messages, and more. # Deactivated SIMs page Source: https://docs.hologram.io/dashboard/sims/sims-deactivated Deactivated SIMs are **permanently disabled**, removed from Hologram's network, and are not able to be reactivated. SIMs are most often deactivated when they are no longer needed, a device is lost, destroyed, stolen, or on accident. You may still need to refer to past data usage or configuration information on these SIMs, and can find them here or by searching for them. ## Deactivated SIMs overview This page is a historical record of all SIMs that have been permanently deactivated from Hologram's network. Deactivated SIMs are sorted by the most recently deactivated first. Deactivated SIMs page Deactivated SIMs include all SIMs in a `DEAD...` network state. Read more about [SIM statuses and states](/dashboard/sims/sim-states-and-statuses). ## Deactivated SIM fields Name given to this SIM card. ICCID of the last enabled profile on the SIM. Name of the last enabled profile on the SIM. The ICCID(s) installed on this SIM during manufacturing. These profiles are permanently associated with the SIM. The enabled manufactured profile is printed on triple-cut and embedded SIMs. IMEI of the last known device associated with the SIM, if known and provided by a carrier or network. Hologram's unique ID for a SIM card. Name of the currently active data plan which determine's a SIM's coverage and cost. Date and time in UTC that this SIM was permanently deactivated from the Hologram Network. ## Related actions Deactivate devices (bulk) POST /devices/batch/state ## Related guides Read more about how to manage and optimize fleet data usage, including when to pause or deactivate SIMs. # Export SIMs data Source: https://docs.hologram.io/dashboard/sims/sims-export Hologram makes it simple to export your data. While your dashboard is helpful for looking into the behavior of your SIMs, most reporting on SIM and usage data happens by combining data in Excel or your own systems. ## How do I download a list of SIMs? You can export SIM details from the SIMs pages in Excel XLSX, CSV, or JSON formats. We recommend the XLSX format for spreadsheet work as it will not truncate long IDs like ICCIDs. Export SIMs data ## How to export SIM data Open the **SIMs** section of your dashboard from the main menu, then open the [Active](/dashboard/sims/sims-active), [Pre-deployment](/dashboard/sims/sims-predeployment), or [Deactivated](/dashboard/sims/sims-deactivated) pages. Select the specific SIMs you want to export, or select nothing to export data for all SIMs. Open the **Export** menu in the top-right corner of the page, and choose a file format. The exported file will be downloaded to your device. You can export additional SIM details and historical data by filtering and exporting [usage reports](/dashboard/usage/usage-overview). ## Exported fields Your organization's unique ID in the Hologram system. The name of your organization. Hologram's unique ID for a SIM card. Name given to this SIM card. Hologram's unique ID for the device associated with this SIM. IMEI of the last known device associated with the SIM, if known and provided by a carrier or network. The current network state of the SIM (e.g., LIVE, CONNECTED, PAUSED). The detailed status of this SIM, which helps describe its ability to use data. ICCID of the currently enabled profile able to use data. Name of the enabled profile, which generally describes available carrier coverage. ICCID(s) of the profile(s) installed on the SIM during manufacturing. These ICCIDs are printed on physical SIM cards. Unique ID of the enabled profile link. Date and time in UTC of the most recent closed session for the SIM. Unique ID of the currently active data plan. Name of the currently active data plan which determines a SIM's coverage and cost. Data usage for the SIM's current billing period in bytes. Names of tags associated with this SIM, separated by commas. IDs of tags associated with this SIM, separated by commas. Date and time in UTC that this SIM was activated and was able to begin using data. # Filtering the SIMs pages Source: https://docs.hologram.io/dashboard/sims/sims-filters Use filters in the SIMs pages to find exactly the SIMs you are looking for so that you can take action on them quickly or export them for reporting and analysis. Detailed filters are also available in data usage reports for more granular reporting. Filters panel The SIM counts above the table on the SIMs pages show how many SIMs match the active filters, and how many SIMs are selected. If you have selected multiple SIMs, your selections will remain even if the SIMs disappear from view after applying new filters. To select a range of SIMs, select a SIM's checkbox, then hold **Shift** and click another checkbox. Right-click any checkbox to open the selection menu to select 10, 1,000, or 10,000 SIMs. Right click the "Select all" checkbox to select the first set of SIMs in the table. Right click any other checkbox to select SIMs beginning from that row. Filters applied Clear individual or all filters using the buttons at the top of the filters pane or within individual filter sections. Filters you set are appended to the SIMs page URL so that you can link to and bookmark specific views of your SIMs. ## Available filters Filter by all tags created in your organization, even if no SIMs in the current view have that tag applied. Tags can be added, edited, or deleted using the **Manage SIMs** dropdown or by visiting the **Tags** page. Filter by specific SIM IDs within the current view (e.g. `/sims/active`, `/sims/predeployment`, `/sims/deactivated`). Filter by available SIM statuses for the current view, even if no SIMs currently have that status. | View | Statuses | | - | - | | **Pre-deployment** | Connected, In testing, Available, Entering testing, Ready to activate | | **Active** | Connected, Ready, Pending, Pausing, Paused by user, Paused by system | | **Deactivated** | Deactivating, Deactivated | Filter SIMs by the end of their last closed session. Enter a custom timeframe, or select a preset range to pre-fill the filter. * **Start date** selects midnight UTC for the selected date (e.g. `2024-12-01 00:00:00.000`) * **End date** selects 1ms before midnight UTC for the selected date (e.g. `2024-12-01 23:59:59.999`) Filter SIMs by ICCID of a SIM's currently enabled profile — the profile currently able to use data — and the initially installed manufactured profiles. The enabled manufactured profile is printed on triple cut (4FF size) and embedded (MFF2) SIM cards. The filter defaults to **Contains** but can be refined to: Contains, Equals, Starts with, or Ends with. "Contains" will always find full ICCIDs — there are no performance differences between the methods. Filter by SIM name, using a "contains" search. Filter by the last known device IMEI for a SIM, if provided by a carrier and network. The default "Contains" filter will show IMEIs that match the entered IMEI exactly and is exactly as fast as the "Is" filter. SIMs may not have an associated IMEI if they have not been activated and connected to a network. Certain networks do not return IMEI for every session. Filter by all data plans available to your organization. If you have a contracted account with Hologram, data plans with negotiated rates display at the top of the list. *Active and Deactivated SIMs views only.* Filter SIMs by the date they were activated and were able to begin using data. Enter a custom timeframe, or select a preset range to pre-fill the filter. * **Start date** selects midnight UTC for the selected date (e.g. `2024-12-01 00:00:00.000`) * **End date** selects 1ms before midnight UTC for the selected date (e.g. `2024-12-01 23:59:59.999`) *Pre-deployment SIMs view only.* Filter SIMs by the date they will automatically be activated if they don't use their test data. Enter a custom timeframe, or select a preset range to pre-fill the filter. * **Start date** selects midnight UTC for the selected date (e.g. `2024-12-01 00:00:00.000`) * **End date** selects 1ms before midnight UTC for the selected date (e.g. `2024-12-01 23:59:59.999`) ## URL filter parameters Filter parameters can be combined. For multiple values, use a comma-separated list. | Filter | URL parameter | Notes | | - | - | - | | **Views** | `/sims/active`, `/sims/predeployment`, `/sims/deactivated` | | | **SIM IDs** | `?hologramSimIds=SIMID,SIMID` | Filter is per view. A deactivated SIM will not be displayed in the active or pre-deployment views. | | **Tags** | `?tags=TAGID,TAGID` | There is currently no way to filter on SIMs with no tags. | | **SIM status** | `?simStatuses=Ready,Pending,Pausing,Paused_by_user,Paused_by_system` | Spaces in status names are replaced by underscores. | | **Connected** | `?connected=true` | Can be combined with `simStatuses`. Older links that use `simStatuses=Connected` still work. | | **ICCID** | `?iccid-condition=contains&iccid-value=VALUE` | Conditions: `contains`, `endswith`, `startswith`, `is` | | **Last active** | `?lastActive-timeframe=custom&lastActive-start=YYYY-MM-DD&lastActive-end=YYYY-MM-DD` | Start and end dates are required. If timeframe doesn't match start and end dates the filter will not be applied. Timeframes: `custom`, `thisMonth`, `P7D`, `P30D`, `P90D`, `P365D` | | **Name** | `?deviceName=NAME` | | | **Last known IMEI** | `?imei-condition=contains&imei-value=VALUE` | Conditions: `contains`, `endswith`, `startswith`, `is` | | **Data plans** | `?plan=DATAPLANID,DATAPLANID` | | | **Activation date** | `?activationDate-timeframe=custom&activationDate-start=YYYY-MM-DD&activationDate-end=YYYY-MM-DD` | Start and end dates are required. If timeframe doesn't match start and end dates the filter will not be applied. Timeframes: `custom`, `thisMonth`, `P7D`, `P30D`, `P90D`, `P365D` | | **Target activation date** | `?targetActivationDate-timeframe=custom&targetActivationDate-start=YYYY-MM-DD&targetActivationDate-end=YYYY-MM-DD` | Start and end dates are required. If timeframe doesn't match start and end dates the filter will not be applied. Timeframes: `custom`, `thisMonth`, `P7D`, `P30D`, `P90D`, `P365D` | # SIMs pages Source: https://docs.hologram.io/dashboard/sims/sims-overview Organize, manage, and take actions on all the SIMs in your fleet from the SIMs pages. SIMs pages ## SIMs pages Contains all "active" SIMs, which are SIMs that are activated, able to use data and connect to the internet, and are being billed for data usage and monthly recurring charges. Clicking into a single SIMs for detailed information, including status, recent connections, installed profiles, usage reports, coverage, pricing, webhooks, and routes. Contains all SIMs that have not yet been activated, including Test Mode SIMs configured for pre-deployment testing. *This page will only display if you have SIMs configured with Test Mode.* Contains a historical record of all SIMs that have been permanently deactivated from Hologram's network. Deactivated SIMs cannot be reactivated. ## Bulk actions Quickly take actions on multiple SIMs, such as pausing or resuming data usage, tagging, renaming, transferring, and deactivating SIMs. ## Filters Quickly find SIMs by various identifiers (ICCID, Device ID, SIM ID, etc.), status, data plan, tags, activation date, and more. ## Export Export SIM data in multiple formats for reporting, analysis, or testing API calls. # Pre-deployment SIMs page Source: https://docs.hologram.io/dashboard/sims/sims-predeployment The Pre-deployment SIMs page lists all SIMs that have not yet been activated, and are not being charged monthly recurring charges. This is the main page used to manage SIMs configured for pre-deployment testing using Test Mode. ## Pre-deployment SIMs overview **Limited access:** Learn more about Test Mode and streamline your deployments by contacting our [sales team](https://www.hologram.io/contact-sales?utm_source=docs\&utm_medium=website\&utm_content=test_mode_callout). The table shows the pre-deployment testing configuration of each SIM, its total data usage, and the target activation date at which the SIM will automatically activate if it has not yet used its available test data or SMS messages. Pre-deployment SIMs page showing SIMs in pre-deployment testing Pre-deployment SIMs include all SIMs in a `TEST...` or `INACTIVE...` network state. Read more about [SIM statuses and states](/dashboard/sims/sim-states-and-statuses). Pre-deployment SIMs can also be manually activated out of test mode if you need to avoid configuration downtime after a device is delivered to your customers for SIMs with a Global-1 profile. **Note:** SIMs in Test Mode will activate automatically after using free data, with **no downtime or action required** on your part.

The only exception is legacy SIMs with an active Global-1 (G1) profile, which will experience a brief disconnection when activating to update profile states. ## Pre-deployment SIM fields Name given to this SIM card. The status of this SIM, which helps describe its ability to use data. Hover for a detailed description The configured Test Mode free testing period for this SIM. Relative time in UTC of the last closed session for the SIM. This is when data is billed and how we calculate data usage. Lifetime data usage for this SIM. SIMs in pre-deployment testing automatically activate after a session closes in which the SIM used at least 100 KB of data. The date at which this SIM will automatically activate after its free test period ends. Name of the data plan which determine's this SIM's coverage, and will determine its cost after the SIM is activated and exits testing. Lifetime data usage for this SIM. SIMs in pre-deployment testing automatically activate after a session closes in which the SIM used at least 100 KB of data. The date at which this SIM will automatically activate after its free test period ends. Name of the data plan which determine's this SIM's coverage, and will determine its cost after the SIM is activated and exits testing. ICCID of the currently enabled profile able to use data. Click to view the SIM's installed profiles and fallback events. Name of the enabled profile, which generally describes available carrier coverage. The ICCID(s) installed on this SIM during manufacturing. These profiles are permanently associated with the SIM. The enabled manufactured profile is printed on triple-cut and embedded SIMs. IMEI of the last known device associated with the SIM, if known and provided by a carrier or network. Hologram's unique ID for a SIM card. Date and time in UTC that this SIM was activated and was able to begin using data. ## Related actions Activate SIMs out of Test Mode Force activate SIMs (bulk) POST /links/cellular/bulkclaim # Active SIMs data usage reports Source: https://docs.hologram.io/dashboard/usage/usage-active-sims Reporting to help you analyze and manage data usage across your fleet of active SIMs. Historical data usage reporting is provided by day, SIM, location, and session. **Limited access:** Historical data usage reporting is available to organizations with an active contract, or over \$100 USD in monthly recurring charges and data usage. All other organizations have access to 90 days of [recent data usage](/dashboard/sims/sim-details-data-usage-recent-tab). ## Data usage by day Summarize data usage across every SIM in your fleet using the Usage by Day report in the **Overview tab**. This report provides an overall count of SIMs, average data usage, and summarized data usage by day for the date range selected. This report is a useful way to get a sense of overall data usage, and for organizations with a single fleet or device type to view high-level data usage behavior. Active SIMs usage by day report (data visualization only) ## Data usage by SIM A series of reports that break down data usage by SIM in the most common ways that we find customers analyzing data usage **per SIM**: * **Overall data usage** Used for high-level reporting and overall data usage analysis. * **Data usage by day** Used for detailed troubleshooting of connectivity issues over time, analysis of carrier outages, or pinpointing SIM or network issues. * **Data usage by location** *(country and network with lat/long)* Used to analyze regional SIM usage, especially for organizations with global deployments. Used to analyze and optimize data plan selection and coverage areas. * **Data usage by network** Identifies SIM connectivity behavior and data usage across networks, especially useful for organizations with Outage Protection™. Active SIMs usage by network report Active SIMs usage by network report * **Data usage by connectivity profile** Identifies SIM connectivity behavior and data usage across connectivity profiles, especially useful for organizations with Outage Protection or large fleets. * **Outbound SMS** Situationally useful report for organizations that make heavy use of SMS messaging for device communication or configuration. ## Data usage by location A less used report, but is helpful for organizations with global deployments to understand regional data usage and network connectivity behavior, drill into regional usage, and identify opportunities for optimizing coverage areas. (It also shows well in sales conversations.) Active SIMs location details report ## Data usage by session This feed of organization-level session usage is a troubleshooting tool to get the most detailed level of data usage information for specific SIMs. Provides extremely granular usage information at the Session level and is meant for detailed troubleshooting or reporting in Excel after filtering down the data. Active SIMs session history report   Historical data usage is available for at least 365 days and is updated every 60 minutes. # Active SIMs recent data usage reports Source: https://docs.hologram.io/dashboard/usage/usage-active-sims-recent Reporting to help you analyze and manage data usage across your fleet of active SIMs. Recent data usage reporting is available by day, SIM, and location. ## Data usage by day Summarize data usage across every SIM in your fleet using the Usage by Day report in the **Overview tab**. This report provides an overall count of SIMs, average data usage, and summarized data usage by day for the date range selected. This report is a useful way to get a sense of overall data usage, and for organizations with a single fleet or device type to view high-level data usage behavior. Active SIMs usage by day report (data visualization only) ## Data usage by SIM Here, you can find a summary of data usage by SIM. SIMs with data usage across multiple profiles or data plans in a single day will show multiple rows for that SIM. Active SIMs usage by SIM report ## Data usage by location Here, you can find a summary of data usage by country, network, and cellular tower ID. SIMs with data usage across multiple locations or profiles will show multiple rows for that location. Active SIMs location details report   **Limited access:** Recent data usage for the **last 90 days** is available to self-service organizations with under \$100 USD in monthly recurring charges and data usage. Contact our [Sales team](https://www.hologram.io/contact-sales?utm_source=docs\&utm_medium=website\&utm_content=recent_data_usage_tab) for access to [full historical reporting](/dashboard/sims/sim-details-data-usage-tab). Recent data usage is available for the last 90 days and is reported in near-real-time. # View and track fleet data usage Source: https://docs.hologram.io/dashboard/usage/usage-overview We provide a wide range of data usage reports to help analyze and manage data usage across your fleet and optimize your IoT operations. This suite of reporting is built to answer the common questions encountered during configuration, deployment, field testing, and troubleshooting. The **Usage** section of your dashboard contains the main reports that will help you view and manage data usage across your fleet. Data visualization of data usage by day Each report has detailed filtering, reports session details to the second for at least a year of data, including productive and zero-byte session counts, SMS usage, SIM configuration, and location information. All reports feature visualizations or conditional formatting to help you understand the context around your SIMs' data usage and quickly identify problems and potential issues. All data usage summarizes data sessions at the time the session closed, to the second. We do not receive millisecond-level data usage information from our carrier partners. All data usage information provided by Hologram is displayed in UTC. ## Data usage reports Used for data usage reporting against all active SIMs in your fleet that are able to use and be billed for data. Reporting to manage SIMs in Test Mode, including data usage, SMS usage, remaining time in testing, and activation history. Reporting to help you troubleshoot specific SIM data usage behavior and device-level issues. ## Exporting data usage **Download records** using the the three-dot menu that appears when hovering over the any card within the report. Export usage reports ## Data availability Recent data usage reporting is available for the last 90 days and is reported in near-real-time. These reports are available to self-service accounts. Historical data usage is available for at least 365 days and is updated every 60 minutes. Historical data usage reporting is available to all contracted accounts, and self-service accounts with over \$100 USD in monthly recurring charges. Data usage reporting availability is separate from a SIM's [billing period](/guides/billing/how-billing-works). An invoice or statement of transactions covers a single calendar month, and for customers with monthly invoicing these totals are generally available *after* the 1st day of the following month. In addition, totals in usage reports may not match a single invoice precisely due to reconciliation, sub-cent-rounding, and other updates that happen at the time charges are finalized. Use usage reports to analyze consumption over time, and [statements and transactions](/guides/billing/statements-and-transactions) to reconcile charges for a billing period. # Pre-deployment SIMs data usage reports Source: https://docs.hologram.io/dashboard/usage/usage-predeployment-sims Reporting to help you analyze and manage data usage across your fleet of pre-deployment SIMs in Test Mode. Hologram's pre-deployment reporting helps customers with Test Mode understand the state of their full inventory of Test Mode SIMs, activation behavior, and historical analysis of Test Mode activations. **Limited access:** Learn more about Test Mode and streamline your deployments by contacting our [sales team](https://www.hologram.io/contact-sales?utm_source=docs\&utm_medium=website\&utm_content=test_mode_callout). ## SIMs in testing An overview of all SIMs currently in Test Mode, including data usage, SMS usage, and remaining time in testing. Test Mode SIMs in testing report ## Activation history Historical reporting of Test Mode SIMs to help understand activation behavior and reasons over time. ## Pre-deployment age analysis Detailed reporting of Test Mode inventory over time to help our largest customers understand how they are using (or not using) their full inventory of SIMs. This is both an internal and external report and helps customers that have had custom Test Mode durations understand exactly how, why, and when they are charged for their SIMs. Test Mode SIM age analysis report   Data in these reports is available for at least 365 days and is updated every 60 minutes. # Single SIM data usage reports Source: https://docs.hologram.io/dashboard/usage/usage-single-sim Data usage reporting at the SIM level across networks, locations, profiles, and sessions to help troubleshoot specific SIM data usage behavior and device-level issues. ## Where can I find data usage reports for a single SIM? Find your SIM from the **SIMs** pages or using **search**. The **Recent sessions** tab contains a live view of recent sessions. The **Data usage** tab contains a detailed historical reporting. ## Recent sessions For a live view of recent, closed sessions, find your SIM from the SIMs pages or using search, and open the **Recent sessions** tab. This page contains a data visualization of recent sessions over time, useful for understanding the connectivity behavior of your SIM. Recent sessions chart showing session activity over time **Export session data** in XLSX, CSV, or JSON formats using the **Export menu** in the top right of the Recent sessions card. JSON exports have additional fields not contained in spreadsheet formats. **Note:** For your security, Hologram only operates with session metadata. If you want to dive even deeper into your usage you'd need to use a device side network analyzer tool like [tshark](https://www.wireshark.org/dashboard/man-pages/tshark.html) or [bmon](https://www.linux.com/learn/bmon-powerful-network-bandwidth-monitoring-and-debugging-tool-linux). ## Data usage reports Detailed session-level data usage for a SIM is found in the **Data usage tab**. These reports default to displaying all data usage for the SIM's current billing period, and mirror the fleet-level data usage reporting available in the **[Usage](/dashboard/usage/usage-overview)** section of your dashboard. ### Data usage details Find summarized data usage within the selected date for a SIM card by network, profile, or day to understand overall data usage behavior and connectivity changes, and to identify possible device configuration problems from zero-byte sessions. **Note:** Data within our detailed data usage reports refresh hourly, and may not contain the most recent sessions for a SIM. * **Data usage by network** - Total data usage broken down by network and profile. * **Data usage by profile** - Total data usage by profile, especially useful for SIMs with multiple installed profiles and Outage Protection™. * **Data usage by day** - Total data usage broken down by day. Data usage details report #### Key metrics and terms Total data usage for the selected date range in a readable format. Total data usage for the selected date range in bytes. Total number of closed sessions in which data was passed through a network. Total number of sessions in which no data was passed through a network, indicating possible device configuration issues. Total number of device-originated SMS messages sent from the SIM that count toward a SIM's SMS limit. ### Location history report Detailed data usage broken down by location with a map of approximate device location. Data usage is categorized by region, country, network, tower, and latitude and longitude. ### Session history report Detailed session-level historical data usage information for a SIM. Detailed data and filtering helps you identify exact issues and pinpoint exactly where and why problems occurred. Session history report #### Field descriptions Date/time in UTC the data session ended. Data usage reporting references this date as when data was “used” and billed. Date/time in UTC the data session started. Duration in seconds the session lasted. Total data usage for the session in a readable format. Total data usage for the session in bytes. Session or reporting windows if the carrier returns data in timed blocks. Name of the network used to pass data. Radio access technology used. Country the cellular tower was located within. Cellular tower ID as returned by the carrier, if provided. Crowdsourced tower location, if provided. ICCID of the connectivity profile used to connect. Name of the profile used to connect. ID of the SIM card. IMEI of the modem the SIM card connected through, if provided by the carrier and network. Data plan active on the SIM at the time the session closed, useful for identifying when a change in rates occurred. ## Data availability Recent data usage is available for the last 90 days and is reported in near-real-time. Historical data usage is available for at least 365 days and is updated every 60 minutes. Historical data usage is available to all contracted accounts, and self-service accounts with over \$100 USD in monthly recurring charges. ## Data usage reporting using the REST API Limited data usage reporting is also available [through the REST API](/api/v1). The `/usage` endpoints retrieve usage per profile using the link ID found in the Profiles tab. List recent data sessions GET /usage/data List total usage for billing period GET /usage/data/monthly List outbound SMS usage GET /usage/sms ## Related guides Read more about the SIM details page and all the information you can find there. Learn more about the actions you can take on a single SIM. # How do I automatically refill my account balance? Source: https://docs.hologram.io/guides/billing/auto-refill Most Hologram organizations are prepaid and have an account balance that they will draw down from like a debit card or checking account. **Auto-refill** automatically adds funds to your account when your balance falls below a specified threshold, helping prevent service interruptions for your IoT devices. **Important:** We recommend that all organizations with prepaid billing enable auto-refill to help prevent service interruptions for your IoT devices. ## How does auto-refill work? Auto-refill works like a transit card. When set up, it monitors your account balance and triggers an automatic payment when your balance drops below the configured threshold. 1. The balance threshold is reached 2. The refill amount is charged to your selected payment method 3. Funds are added to your account balance 4. You will receive an emailed receipt of the transaction 5. A new auto-refill transaction is created and appears in your statements and transactions Account auto-refill does not apply to organizations with monthly invoicing. ## How do I set up auto-refill? # Breakdown of billing and SIM charges Source: https://docs.hologram.io/guides/billing/breakdown-of-billing-and-sim-charges Learn about the three types of charges for Hologram SIMs: monthly recurring charges, data usage rates, and outbound SMS costs — including why an active SIM is charged even when it isn't using data. Charges to a Hologram SIM usually come from one of three different areas: the **monthly recurring charge** (or "MRC," our monthly active SIM charge), **data usage**, and the **outbound SMS** rate. ## Monthly per SIM recurring charge The **monthly recurring charge**, or MRC, includes the monthly active per SIM charge required by our global carriers to maintain the network and access your devices, and your access to Hologram's services. This per SIM charge is billed on a 30-day cycle beginning on the day the SIM is activated. For **Included data** plans that included prepaid data usage per SIM, the MRC includes the plan's data cost. Only overage above the included data amount are charged at the specified data rate. MRC is charged to **all active SIMs**, regardless of whether they are using data or not. A SIM becomes "active" when it is activated and registered on the Hologram network. "Paused" SIMs are roughly equivalent to "suspended" SIMs, but Hologram's multi-core SIMs operate across carriers and do not stop incurring a MRC when paused. With an active contract, paused SIMs can qualify for lower zero-data rates if they use 0 B of data in a billing period. **Note:** **Paused SIMs still pay a monthly recurring charge** to maintain access to Hologram's network so that they can resume data usage in the future. A SIM must be [permanently deactivated](/dashboard/sim-actions/deactivate-sims) in order to stop monthly recurring charges. ## Data usage Data usage at Hologram is tracked, stored, and billed in decimal (base 10) units, not binary (base 2) units. 1 KB of data is always 1,000 bytes across all our systems, not 1,024 bytes. The **data usage rate** is what you pay for data usage on the network. Data is billed at a per megabyte rate by the kilobyte. This data rate applies to all data usage on a pay as you go basis for our **Pay as you go** data plans, and only to overages on **Included data** plans and **Data pools**. Charges for data usage are aggregated to a minimum charge threshold of \$0.25 per SIM, which means that smaller data sesssions are combined until they reach the minimum charge threshold. If a SIM uses more than \$0.00 worth of data but less than \$0.25 in a billing period, it will be charged for usage at the end of the billing period. Data usage is charged at the end of a closed session. If a session extends beyond a SIM's billing period, charges will carry over to the next billing period when the session closes. Data usage can also be limited by [setting data limits](/dashboard/sim-actions/set-usage-limits) on a SIM. **Note:** Network-level billing is available to organizations with an annual contract for the best rates on the networks you use most often. Reach out to our [sales team](https://www.hologram.io/contact-sales?utm_source=docs\&utm_medium=website\&utm_content=billing_and_sim_charges) today to learn more. ## Outbound SMS We only charge for **outbound SMS** messages originating from a device, at a flat rate per outbound SMS message. Please visit [https://www.hologram.io/pricing/](https://www.hologram.io/pricing/) for our current prices. Inbound SMS messages and messages sent via our Hologram Cloud API are always free. ## All SIM charges The breakdown of charge types that appear in transaction reports and invoices can be seen below: | Charge type | Description | Timing | | - | - | - | | SIM renewal | The MRC, or monthly recurring charge, for a SIM. This charge includes the base monthly active SIM cost to reserve access for a SIM on the network and provide platform access. | Every 30 days at the start of the SIM's billing period. | | Data usage | Cost to send internet data on our network from your device, billed per KB at session close.
For **Included data** and **Data pool** plans this is the *data overage* for any usage over data included in the SIM's data plan. | Real-time at the end of a closed data session, aggregated to a minimum charge threshold of \$0.25 per SIM for most organizations. | | Outbound SMS | Device-originated outbound SMS messages are charged. Inbound SMS and SMS via our Cloud API are free. | Time the message was sent. | | Plan change | Charges for changing a SIM's data plan to a more expensive plan. | Time the plan change occurred. | | Phone number activation | The first month's charge for activating a new phone number. | Time the phone number was first purchased. | | Phone number renewal | The monthly recurring charge for a phone number. | Time the renewal occurs. | | Order | Any charges made to your credit card. Receipts for these charges display in the **Credit card receipts** page. | Time the order was placed. | You can view specific plan information on our [pricing](https://www.hologram.io/pricing/) page and change plans [here](/dashboard/sim-actions/change-data-plans). ## Frequently asked questions The monthly recurring charge (MRC) applies to every **active SIM** — any SIM in a **Ready**, **Connected**, or **paused** state — regardless of whether it had any data sessions in the billing period. The MRC pays for your SIM's reserved access to the carrier network and the Hologram platform, not for data. Data usage is billed separately, on top of the MRC (or as overage on Included data plans). A SIM keeps incurring the MRC even while [paused](/dashboard/sim-actions/pause-resume-sims), because pausing preserves its network access so you can resume later. To stop the MRC entirely, [permanently deactivate the SIM](/dashboard/sim-actions/deactivate-sims). See [SIM states and statuses](/dashboard/sims/sim-states-and-statuses) for what counts as an active SIM. An **active SIM** is registered on the Hologram network and able to use data — this includes paused SIMs. It does *not* mean "a SIM that recently had a data session." A SIM that is idle but active still incurs the MRC. SIMs in a pre-deployment or Test Mode state are not active SIMs for MRC purposes. **Note:** SIMs that [subscribe to a phone number](/guides/communication/purchase-a-phone-number-to-send-sms-messages-to-a-sim) may incur separate charges for those services. # Set up your account for billing Source: https://docs.hologram.io/guides/billing/configure-billing-account Learn how to set up your account for billing, add a billing address, add a payment method, and enable auto-refill. ## Billing account setup All organizations must have a billing address and payment method to activate SIMs, make purchases, and refill account balances. Learn how to add a billing address for your organization. Learn how to add a payment method for your organization. ## If your organization pays for data as you use it (prepaid billing) Learn how to enable auto-refill for your organization. # What does it mean to have custom billing? Source: https://docs.hologram.io/guides/billing/custom/custom-billing-overview Custom billing solutions are used for some contracted organizations with unique billing requirements that don't fit standard prepaid or invoiced models. These solutions accommodate complex data plan structures, specialized pricing, and other unique billing requirements. **Caution:** Custom billing limitations only apply to contracted organizations that have been notified by their account team that they have a custom billing solution. ## How does custom billing work? If your organization is set up with custom billing, your account team will send you all billing documents, invoices, statements, and transaction directly. Billing information is not available in the dashboard for organizations with custom billing. This includes: * Invoices * Statements * Transactions * Account balance * Data plan pricing, including data usage rates and monthly recurring charges # What data plans does Hologram offer, and how do they work? Source: https://docs.hologram.io/guides/billing/data-plans-overview Data plans determine how your SIMs are charged for data usage. Understanding different plan types helps you choose the right plan for your needs. Hologram offers a variety of data plans to provide the best price per MB for your deployments, anywhere around the world. All organizations have access to our **Global G3 Standard Flat Rate** pay as you go data plan, with a single rate across 165+ countries and 310+ networks, flexible enough for any deployment. ## What types of data plans does Hologram offer? ### Pay as you go plans We've found **pay as you go** plans to be the most flexible and appropriate payment method for most use cases. Pay only for the data you use, as you use it. Data usage is charged by the kilobyte after each data session closes. ### Included data plans **Included data** plans are a great option for fleets with predictable usage patterns that don't often change, or if you have a fixed monthly budget for data usage. You pay a fixed monthly fee for a preset amount of data per SIM, included in your SIM's monthly recurring charge. Any usage beyond the included allowance is charged at an overage rate. Paired with data usage limits, included data plans can ensure your devices don't exceed your budget and stay within your control. **Limited access:** Included data plans are available to organizations with qualifying fleets or data usage. To learn more, contact our [sales team](https://www.hologram.io/contact-sales/). ### Data pools **Data pools** are a great option for fleets with mixed or unpredictable usage patterns. These plans create a pool of data that is shared across all SIMs in your fleet. Any usage beyond the included allowance is then charged at an overage rate. We see data pools as a great way to optimize your total cost and smooth out usage spikes. If your fleet size does not change often, **fixed size data pools**, sometimes known as static data pools, let you set a fixed amount of data for your fleet to use each month. This amount doesn't change and lets you budget your data usage. If your fleet size adjusts regularly, **dynamic data pools** let you set a fixed amount of data per SIM that is added to a shared pool across your entire fleet. This is the most flexible option and allows you to adjust your data usage as your fleet grows or shrinks. **Limited access:** Data pools are available to organizations with qualifying fleets or data usage. To learn more, contact our [sales team](https://www.hologram.io/contact-sales/). ## How can I pay for data usage? ### Data usage payment methods * **Pay as you go** for data you use, as you use it, billed by the kilobyte. * **Prepay for data** monthly with included data plans or data pools. Available to qualifying organizations. ### Data usage rates Data usage is charged per KB to your account balance after your SIM stops transmitting data, when a data session closes. Hologram offers two types of data usage rating: #### Flat rate Our standard data plans offer **Flat rate** pricing for data usage. This means you pay a fixed rate for all data usage on a data plan. #### Network-level billing **[Network-level billing](/guides/billing/network-level-billing-overview)** (NLB) is available to organizations with qualifying fleets or data usage. On these plans, data usage rates vary per network, per profile. Data usage is charged based on where your devices are located and the network they are connected to. NLB can offer better rates for usage on preferred networks. ## What are the monthly recurring charges for data plans? The **monthly recurring charge** (MRC) for a data plan includes the maintenance and support costs for your SIMs to continue to connect to the Hologram network, the cost of installed profiles, and the cost of prepaid data (if applicable). This charge is billed monthly on a 30-day cycle for self-service organizations and monthly on the 1st day of the month for organizations with invoiced billing. **Tiered pricing** for MRCs is available to qualifying organizations with large fleets. Qualifying organizations can also gain access to **zero-data rates**. These plans offer discounted monthly recurring charges for SIMs that don't use any data in a billing period. ## How is coverage determined? Coverage for a data plan is determined by the **profiles installed on the SIM**, and the **data plan** the SIM has been assigned to. You can look up coverage for a specific SIM or data plan using the [coverage explorer](/dashboard/billing/coverage-explorer). ## Related guides # How billing works at Hologram Source: https://docs.hologram.io/guides/billing/how-billing-works Learn how billing works at Hologram. ## Payment methods and account balance Hologram accounts are billed from a prepaid account balance that can be filled with a credit card on file. My account balance works like a debit card, and you can add funds to your account at any time or set up [auto-refill](/guides/billing/auto-refill) to automatically add funds when your balance is low. Contracted accounts can also work with our [sales team](https://www.hologram.io/contact-sales?utm_source=docs\&utm_medium=website\&utm_content=how_billing_works) to set up monthly invoicing and pay using a bank account. ## How do SIM billing periods work? The billing period for each SIM is 30 days, beginning from the time that SIM is activated. At the beginning of the SIM's billing period, Hologram renews the data plan and charges a **monthly recurring charge** (MRC) to the organization's account balance. As long as there is a remaining balance in your account, your device's service will automatically renew at the end of a billing period. **If your account balance cannot cover the cost of renewing a device's data plan, you will receive an email notification 24 hours before the end of the billing period.** ## How is data usage charged? Data usage for each SIM is is charged as you use it, based on the data plan selected for the SIM. Your account is charged at the end of each closed data session, and data usage is charged per kilobyte. Our minimum charge is \$0.25. Sessions with under \$0.25 of data usage will aggregate until they reach the minimum charge threshold. Organizations with monthly invoicing are charged for data usage at the end of each month. Organizations with network-level billing receive transactions summarized by SIM and network for the month, with no minimum charge amount. ### Pay as you go data plans For **pay as you go** data plans, all data usage in the plan is charged at the rates specified in the plan. **Caution:** If your account balance reaches zero, we may pause your SIMs without warning. To prevent this from happening, we suggest configuring [auto-refill](/guides/billing/auto-refill). ### Included data plans **Included data plans** have a set amount of included data that is prepaid at the beginning of a billing period. Prepaid data is included in the monthly recurring charge at the beginning of the SIM's unique 30-day billing period. After using all data included in the plan, data usage is charged at the overage rate in real time like pay as you go sessions. ### Data pools Fixed size (static) data pool plans do not draw from account balance and are billed directly on the 1st of the month from a credit card on file. You can read more about the breakdown of charges [here](/guides/billing/data-plans-overview). ### SMS charges We only charge for **outbound SMS** messages originating from a device, at a flat rate per outbound SMS message. Please visit [https://www.hologram.io/pricing/](https://www.hologram.io/pricing/) for our current prices. Inbound SMS messages and TCP/UDP messages sent via our Hologram Cloud API are always free. ## Related guides # What happens if I don't have enough money in my account? Source: https://docs.hologram.io/guides/billing/insufficient-balance If your account balance is zero or negative and you have a SIM that is due for renewal or you have an overage charge, we will pause the SIM and send you an email alert informing you of what happened. We will still charge your account for monthly recurring charges, which may bring your account into a negative balance. If you have a positive account balance, but it's not enough to pay for your monthly plan or a data charge, we will still renew the SIM for you to prevent a service interruption. This will result in a negative balance, so the next SIM that gets charged may get suspended if you don't add money to your account or enable auto-refill. When you add enough money to your account to get back into a positive balance, your SIM will automatically return to a [Ready status](/dashboard/sims/sim-states-and-statuses) and can use data again. **Note:** That there may be a short delay before the SIM's data usage is resumed. After your SIM is unpaused, the SIM's status will update to "Ready". **Warning:** If your account balance remains at or below zero for over 30 days, your SIMs will be permanently deactivated. ## Related guides We recommend enabling auto-refill to automatically add balance to your account when it's low and avoid any unnecessary service interruptions. Learn how to manually add balance to your account. # Where can I find and pay invoices? Source: https://docs.hologram.io/guides/billing/invoiced/invoices How to view and receive invoices for organizations with monthly invoicing If your organization receives monthly invoices, you can find invoices in your Dashboard and configure who receives them by email. **Limited access:** Monthly invoices are only available for accounts with an active contract. To learn more, contact our [sales team](https://www.hologram.io/contact-sales?utm_source=docs\&utm_medium=website\&utm_content=invoices). Some organizations may be set up with custom billing solutions. ## How to view and pay invoices View the invoices page in product documentation Invoices page Open the **Billing** section in the main menu, then open the **Invoices** page. You can download the invoice using the dropdown menu on each invoice. If the invoice is unpaid, you can pay it using the **Pay invoice** button, which will open a Stripe-hosted invoice payment page. ## Who receives invoice emails? Invoices are sent via your linked Stripe account and go to the recipients configured in your Stripe billing settings. * To change recipients, update them in Stripe: `https://support.stripe.com/questions/change-the-email-address-where-stripe-emails-are-sent`. * Credit card receipt notifications are controlled in the Dashboard under Billing → Account → Billing notifications. *** ## Related View the invoices page in product documentation Learn how postpaid billing works # Invoiced billing overview Source: https://docs.hologram.io/guides/billing/invoiced/postpaid-billing-overview Invoiced billing works like a credit card. Your organization accrues charges throughout a calendar month, then receives an invoice at the end of the month for all monthly recurring charges and data usage. **Limited access:** Invoiced billing is available only to qualifying organizations. To learn more, contact our [sales team](https://www.hologram.io/contact-sales/). ## How invoiced billing works ### Monthly billing cycle With invoiced billing your organization is billed on a monthly basis for all monthly recurring charges and data usage. Invoices are then generated on the 2nd day of the calendar month for all charges accrued during the previous month. Payment is due according to the net payment terms specified in your contract. With invoiced billing, data usage is reported on a monthly basis for each SIM. Data usage totals and usage reports also change to calculating on a monthly basis. ### What's included in invoices Each monthly invoice includes: * **Monthly recurring charges (MRCs)** for all SIMs active during the month. * **Data usage charges** for all usage during the calendar month. * **Additional monthly charges** such as phone numbers, SMS messaging, minimum commitments, and support packages, if applicable. **Note:** While invoicing occurs on a monthly basis, data limits are still enforced based on each SIM's individual 30-day billing cycle. This means a SIM's data limit may be reached mid-month even though your invoice covers the full calendar month. ## Payment methods Invoiced billing requires two payment methods: 1. **Primary payment method** — ACH bank transfer used for invoice payments. 2. **Backup payment method** — Credit card used only if ACH payment fails. **Important:** Both payment methods must be set up before your organization can be configured for invoiced billing. ## Invoice delivery Monthly invoices are automatically sent to all users with the **Admin** role in your organization. You can specify additional email addresses to receive invoices in the [Stripe](/dashboard/billing/billing-email-recipients#sharing-invoices). ## Related guides Overview of Hologram's billing system Understand how charges are calculated View and download invoices in Dashboard Learn what happens when your organization switches from prepaid to invoiced billing # How can I manage and limit my fleet's data usage? Source: https://docs.hologram.io/guides/billing/manage-fleet-data-usage Strategies for controlling and optimizing data consumption across your IoT deployment Managing data usage across fleets, device types, deployment locations, customers, and users can be challenging. Hologram's Dashboard gives you flexibility to set allowed data usage and configure your SIMs to only use data how and when you choose. Fleet data usage management overview in dashboard ## First, learn your devices' data usage behavior Use our detailed data usage reporting to keep tabs on exactly how much data your SIMs are using on a regular basis. You might track data usage across your entire organization, or have many fleets deployed across the world each with their own unique data usage behavior. Depending on how each fleet uses data, you may want to change some SIMs to a different data plan, set data usage limits, or pause and resume data usage for seasonal deployments. ## Choose the right data plan Hologram's standard global data plans let you deploy your devices anywhere in the world with a single flat rate. If you have more specific needs, you can [work with our sales team](https://www.hologram.io/contact-sales?utm_source=dashboard\&utm_medium=help_center\&utm_content=manage_and_limit_data_usage). Contracted accounts can set up custom data plans with costs optimized for coverage areas, included data, pools, or other solutions to help you get the best rate for your fleet makeup and deployment needs. ## Pause and resume data usage You can **pause or resume data usage** for your SIMs at any time using your dashboard or the REST API. Pausing data usage is a useful way to limit a device's data usage manually. We find it to be helpful when managing seasonal deployments, to limit data usage while troubleshooting a device, to limit customer access to data, and generally as a way to prevent unanticipated data usage when you don't want your devices to connect to the internet. ## Set data usage limits **Data usage limits** prevent a SIM from using more data than you expect. When paired with a data plan, this helps you limit your data usage to exact amounts to help you stick to budgets, limit usage in case of SIM theft, prevent unanticipated usage from device configuration errors or testing, or to have peace of mind that you won't run up unexpected bills if you don't yet know how your devices will use data. We recommend pausing SIMs at **10 GB**. You can also leave SIMs unlimited or set a custom amount. You cannot set a 0 B limit on data plans that do not include data. Once you have data limits created, you can set up notifications to be alerted when a SIM reaches a threshold or reaches its usage limit. After setting a data limit, you can then set up notifications using [Alerts](/dashboard/event-monitoring/alerts-and-notifications) in the **Event monitoring** section of your dashboard. ## Set data warning thresholds **Data warning thresholds** create an event when a SIM reaches an amount of usage you define. They do not pause the SIM. Combine them with data usage limits if you want a warning before a SIM is paused. You can set thresholds for any number of SIMs in bulk. ## Limit costs during manufacturing and pre-deployment testing Hologram **Test Mode** can help you limit SIMs' monthly recurring charges when working with manufacturing partners that only need to use small amounts of data for connectivity testing. Your SIMs can use 100 KB of free data or 10 outbound SMS messages before automatically activating once they're deployed. ## Deactivate SIMs you're no longer using You may find that you have SIMs you no longer need. Devices may fall out of use, or become stolen, discarded, or broken. Connectivity needs may have changed. Or, you might have SIMs that you want to otherwise permanently disable. After you identify the SIMs you can permanently deactivate those SIMs using your dashboard or the REST API. Deactivation is a **permanent and irreversible process**, but that SIM will no longer be able to use data and will no longer incur any charges. # How does network-level billing work? Source: https://docs.hologram.io/guides/billing/network-level-billing-overview **Network-level billing** (NLB) is a pay-as-you-go billing method where you're charged per megabyte based on the specific cellular network your SIM connects to. Instead of paying a single flat rate for all data usage, your rate varies depending on which carrier network handles your device's connection. **Limited access:** This billing method is available to contracted organizations with custom data plans and provides the flexibility to optimize costs based on your deployment's actual network usage patterns. To learn more, contact our [sales team](https://www.hologram.io/contact-sales/). ## How does network-level billing work? ### Variable rates based on network usage With network-level billing, each data session is billed at the rate for the specific network your SIM used. The network is identified using a **Universal Network Code** (UNC), which uniquely identifies each carrier network a SIM can connect to through its installed connectivity profiles. Your available data usage rates are determined by rate cards, which are defined in your Order Form. 1. **Custom negotiated rates** — Specific rates agreed upon in your contract for certain networks. 2. **Standard rates** — Hologram's standard rates that apply to networks not covered by your custom rates. When your SIM connects, we check your custom rate card(s) first. If the network doesn't have a custom rate, we fall back to our standard rates. ### Universal Network Codes (UNCs) A **Universal Network Code** (UNC) is Hologram's unique identifier for each cellular network available through Hologram. When your device connects and transmits data, the UNC determines which rate applies to that session. Each UNC maps to a specific network, determined by its profile, region, country, TADIG, MCC, and MNC. If we receive partial network information from a carrier partner, we use a generic UNC as a fallback to ensure your data session is always properly rated. ## How do data plans work with network-level billing? * **Data plans determine coverage areas** — Each data plan defines which networks are available to your SIMs based on its installed profiles. * **Rates are organization-wide** — All SIMs in your organization use the same rate card regardless of which data plan they're assigned to. * **Monthly recurring charge (MRC) are organization-wide** — All SIMs are billed using a single MRC per SIM per month. * **Pay-as-you-go only** — Network-level billing operates on a pay-as-you-go basis without included data bundles or data pools Assigning SIMs to different data plans changes which networks they can access, but doesn't change the rates you pay for data usage. **Note:** Organizations with custom billing solutions may have access to different pricing or rate card structures. ## How is network-level billing invoiced? Network-level billing customers are billed on a monthly postpaid basis: * **Invoices** are generated at the end of each month and include all data usage and monthly recurring charges. * **Data usage** is metered and charged based on the calendar month. * **Monthly recurring charges** are billed for all SIMs active at the end of the month * **Invoices and statements** are available in the Billing section of your dashboard. **Note:** Data usage limits are enforced based on each SIM's individual 30-day billing cycle, while invoicing occurs monthly. ## How can I view rates and coverage? The rates and coverage information for your SIMs is displayed when viewing a SIM or a data plan. ### For a single SIM * The **Pricing** tab shows "Rates vary by network" with a link to view detailed coverage * The **Coverage** tab displays all available networks and rates based on your SIM's installed profiles and assigned data plan in the [Coverage Explorer](/dashboard/billing/coverage-explorer). ### For a data plan **Note:** Data plan coverage is displayed for **all profiles** supported by the data plan. When checking coverage, make sure to select coverage for the profiles that apply to the specific SIMs you are referencing. * Data usage rates for a data plan show as "Rates vary by network" * The **Coverage** tab on data plan details pages shows all networks and rates available through that plan in [Coverage Explorer](/dashboard/billing/coverage-explorer). * When activating SIMs or changing data plans, you can view the coverage and rates for a data plan in [Coverage Explorer](/dashboard/billing/coverage-explorer). ### Rates displayed Dashboard always shows your custom rates first when available, then displays Hologram's standard rack rates for all other networks. ## Related guides Learn about different data plan types and options Understand how SIM charges are calculated View detailed network coverage and rates # How to interpret billing transactions Source: https://docs.hologram.io/guides/billing/statements-and-transactions Billing transactions are available in the **Billing** section of your dashboard. **Important:** The **Statements** page has been deprecated. Detailed transaction history is now available on the **Transactions** page and can be downloaded as an XLSX or CSV file. Hologram's Transactions page provies a granular, historical view of every billing transaction that occurred for your organization and devices. If you have questions about your invoice, or want to analyze the underlying data, transaction history is the best place to look. Downloading transactions allows you to easily manipulate and analyze billing transaction data in a format that is familiar and accessible to most finance and operations teams — a spreadsheet. The default download format is an `XLSX` file with each transaction split into its own row, but you can download transactions into `CSV` formats using the three-dot menu on the report table. These exports let you create more detailed pivot tables and summarizations to analyze and aggregate the data in the way that makes most sense for your business operations. ## How can I access billing transactions? Billing transactions can be found under the **Transactions** page of the **Billing** section of your dashboard. This page has two tabs. The **Transaction** tab lists out all transactions for your organization and devices. Transactions page listing out transactions by type for an organization billing period Once you navigate to the **Transactions** page, you will see a list of historical transactions that have been generated for your organization, filterable by billing period. The earliest transactions are available back to April 2020, to retrieve earlier transactions, please contact us at [support@hologram.io](mailto:support@hologram.io). The **Balance history** tab lists out your organization's balance history per calendar month (UTC), and links to the filtered view of transactions for that month. For organizations with monthly invoicing (postpaid billing), the monthly totals here match your monthly invoice totals. Balance history page listing out balance history by month for an organization Both pages display three totals: * **Charges** — This is a running total of all of the charges accrued during the billing period. * **Credits and adjustments** — If any balance was added to your account or adjusted throughout the month, you will see the total here. * **Total charges** — The total outstanding amount after accounting for charges and balance added throughout the month. Any charges are listed as negative transactions, and any balance additions or credits are positive transactions. ## What should I expect to see in my billing transactions? The transactions report contains one row for every transaction that occurred throughout the previous month. A transaction — and therefore each row — represents a billing event such as an SMS message, a SIM's monthly recurring charge, single or aggregated data usage for data session(s), monthly recurring charges for new SIM activations, data plan changes, and any other charge types. ### Charge types and explanations | Charge type | Description | | - | - | | MRC | The **monthly recurring charge** per SIM. This charge includes prepaid data for Included data plans. | | Data usage | Charge for **data usage** that is not included with any plan. This includes pay as you go or overage data usage. | | Outbound SMS | Charge for each **outbound SMS message** sent from a device. | | Activation | **Monthly recurring charges for new SIM activations** on a data plan. Per SIM monthly recurring charges are charged at the beginning of each billing cycle. This only applies for the first month in which a SIM is activated in subsequent months, the charge will be included as a SIM Renewal charge type. | | Bulk activation | Initial monthly recurring charges when bulk activating many SIMs on a data plan at once. | | Plan change | Charges to adjust for mid-month data plan changes. | | Phone number activation | First month's charge for activating a new phone number. | | Phone number renewal | Monthly recurring charge for renewing a phone number. | | Zero-data discount | Credit for SIMs on contracted plans that used 0 B of data in their current billing period. Contracted accounts only. | | APN service fee | Charge for custom APN services. Contracted accounts only. | | Overbilling correction | Corrects transactions that were overcharged for. | | Credit | Account credit adjustments. | ### Field names and descriptions Each transaction contains the following columns described below. In some cases, some of the columns may be blank if data for that column is not applicable or not available. #### Transaction columns | Column name | Description | | - | - | | Transaction ID | Unique ID for the transaction. This is helpful in case you have a question and want to ask the Hologram support team about a certain transaction, you can use this Transaction ID as a reference. | | Transaction type | Represents the type of charge for the given transaction. See the table above for each type and its description. | | Transaction time (UTC) | Date and time that the transaction occurred in UTC. Note: this is not the precise time of a data session or usage charge. The timestamp refers to the time the transaction took place, not the timing of any usage-based event. | | Transaction amount | The amount of the charge for the transaction. | | Bytes | The number of bytes billed in data usage transactions. To connvert from bytes to MB, divide by 1,000,000. | | Profile ICCID | The unique identifier of the profile that was billed for the transaction. If a transaction affects multiple SIMs, this field will be empty. | | SIM ID | The unique identifier of the SIM card that the transaction references, if applicable. | | Device ID | The unique identifier of the device that the transaction references, if applicable. | | Profile (Link) ID | The unique identifier of the profile that the transaction references, if applicable. | #### Additional columns for organizations with network-level billing or custom billing | Column name | Description | | - | - | | Rate | The rate used for the transaction. | | Quantity | The number of units billed for the transaction (e.g. the number of MB used in a session). | | Units | The type of units billed for the transaction (e.g MB, SMS). | | UNC | The "Universal Network Code" for the network that the transaction occurred on, used to identify network rates. | | Charge | The name of the network that the transaction occurred on. | | Amount | The amount of the transaction. | | TADIG | The TADIG for the transaction. | | Country ISO3 | The country ISO3 for the transaction. | | Network name | The name of the network for the transaction. | | Plan ID | The ID of the data plan the transaction was billed against, if applicable. | | Plan Name | The name of the data plan the transaction was billed against, if applicable. | | Included data (MB) | The amount of data included in the data plan for the transaction, used to identify data overage. | ## What is not included in billing transactions? * Any **data included in a data plan** is prepaid and included within the SIM's MRC. That amount is not charged as a separate transaction. However, any overage data above that amount would appear as a "data overage" charge. * **Data usage transactions are not session-level.** In complex deployments, session-level charges create an overwhelmingly large number of transactions. To handle this, Hologram aggregates data usage charges per SIM to a minimum charge amount of \$0.25. For contracted billing solutions, transactions are instead aggregated per SIM and network per month using a Universal Network Code (UNC). * Billing adjustments made directly to an invoice are not reflected in transaction or balance history. ## FAQs Hologram's transaction data is meant to be manipulated in a spreadsheet application such as Excel or Google Sheets. We recommend exporting the data, then creating a Pivot table to view the data so that you can get a summarized or aggregated view. No, transactions **only track data usage that incurred a charge** during the month. Some SIMs may be on plans that include data as part of the monthly recurring charge. Data usage for these SIMs would generate a unique transaction, unless the SIM usage exceeded the amount of data included in the plan and was charged **overage**. If no overage was charged, no additional transaction record is created for the SIM. If the SIM exceeded the allotted plan amount during the month, that usage (the number of bytes and the cost) would appear as a transaction. To get a full view of all SIM usage, we recommend using [data usage reports](/dashboard/usage/usage-active-sims). SIMs can also generate only zero-byte sessions, often due to device configuration issues, in which case no transactions would be generated for that SIM. No. We do not recommend using transactions to analyze data usage. Not all usage will appear in transactions. Any data usage that is included with a plan is not charged as a transaction, and would not be included. If you want to get a view of all data usage, we recommend using our session-level [data usage reports](/dashboard/usage/usage-active-sims). Some networks do not provide IMEIs for every data session. Some networks do not provide IMEI consistently between sessions. We provide the IMEI for all sessions and transactions where it is provided to us. In most cases, this number will be 1 which represents a single SIM. However, for certain charge types - such as for a Bulk Data Plan - many SIMs are activated at once, so this field would reflect the number of SIMs included in a given transactions. Negative transactions represent a **charge** to your account. Any balance additions or adjustments will be positive transactions. The transaction data provided is meant to be manipulated in a spreadsheet application like Excel or Google Sheets. We recommend creating a Pivot table to view the data so that you can get a summarized or aggregated view. For most customers, no. Transactions group data sessions by at least \$0.25 increments per SIM. So if a SIM had many very small data sessions — and the sum cost for all of them totaled less than \$0.25 — they would be processed in a transaction until the \$0.25 threshold was reached. Some \$0.25 transactions may represent 1 data session or it may represent many data sessions. The transactions report only provides a view into billing transactions of at least \$0.25. Detailed [data usage reporting](/dashboard/usage/usage-active-sims) is found in the Usage section of your dashboard. For contracted accounts with network-level billing or custom billing solutions, however, transactions are provided for each data session. Each session-level transaction includes the Universal Network Code (UNC) for the network that the session occurred on, the network name, TADIG, and country ISO3 code for the session. The **invoice** itself shows a summarized total, not a per-SIM line-item list. To break charges down by SIM, use the **transactions** export instead: transaction records include the SIM's ICCID, so you can filter or pivot by SIM in a spreadsheet. Hologram does not provide session-level transaction data. For most organizations, data usage transactions are aggregated per SIM to a minimum \$0.25 threshold, so a per-SIM total in transactions reflects billed charges but not every individual session. Contracted accounts with network-level billing receive transactions are summarized per SIM profile per network per month. These charges include a Universal Network Code (UNC), network, and TADIG/MNC/MCC. If you receive standard billing and need a per-network summary of transactions, [contact Support](/guides/get-started/contact-support) or ask your account team about [network-level billing](/guides/billing/network-level-billing-overview). For session-level usage (not billing) by SIM, use the [data usage reports](/dashboard/usage/usage-active-sims). Our billing system waits until there is a charge of at least \$0.25 when creating a new transaction. This means that we do not create a transaction row for every single session a device has. Some transactions may be a single session, and others could be any number of sessions aggregated together once the total cost for those sessions is equal to or exceeds \$0.25. Transactions should not be used to count the number or timing of data usage sessions. If you have monthly invoicing, transactions may close at the end of the month before aggregating up to \$0.25 so that they are included in the monthly invoice. To view data in aggregate by day, insert 2 blank columns next to the Timestamp column. Add a `SPLIT` function to the first new column using a space as the delimiter. The formula looks like this in Google Sheets: `=SPLIT(B2," ",FALSE,FALSE)` Splitting timestamp into date and time in Google Sheets XLSX files will not truncate long numbers. However, when importing transactions CSVs, applications like Microsoft Excel and Google Sheets will truncate the 18 to 22 digit ICCID into scientific notation. To prevent this from happening, format the ICCID column as 'Text' when importing the data into your spreadsheet tool. # Transfer balance to another organization Source: https://docs.hologram.io/guides/billing/transfer-balance Transfer any part of an organization's available balance to another organization by contacting support. Transfer any part of an organization's available balance to another organization by sending us an email to [support@hologram.io](mailto:support@hologram.io) **from the email account of the Owner of the organization sending the funds**. Please use the template below to request a transfer. ## Transfer request email template **Subject** ```text theme={null} Balance Transfer for Organization ``` **Body** ```text theme={null} Please complete the following Balance Transfer Transfer Amount From Organization To Organization Is your email listed as an owner or administrator on both accounts? If not, please copy the owner or administrator on this request. ``` ## Example transfer request email **Subject** ```text theme={null} Balance Transfer for Organization 12345 ``` **Body** ```text theme={null} Please complete the following Balance Transfer Transfer Amount $25.00 From Organization 12345 To Organization 23456 Is your email listed as an owner or administrator on both accounts? YES If not, please copy the owner or administrator on this request. ``` # What data plan should I choose? Source: https://docs.hologram.io/guides/billing/what-data-plan-should-i-choose Selecting the best data plan for your fleet(s) will vary based on your unique use case, deployment locations, and hardware. ## What are Hologram's default data plans? All organizations have access to our **Global G3 Standard Flat Rate** pay as you go data plan, with a single rate across 165+ countries and 310+ networks, flexible enough for any deployment. This is the most flexible and appropriate payment method for most of our customers. Pay only for the data you use, as you use it, at a fixed rate. Data usage is charged per KB to your account balance after your SIM stops transmitting data, when a data session closes. You can optionally limit data usage with [data usage limits](/guides/billing/manage-fleet-data-usage). Organizations with other SIMs or profiles may have access to our **Global Standard Flat Rate** data plan, which has a higher rate than the Global G3 Standard Flat Rate plan, but offers coverage to a wider range of SIMs and profiles. More information about other profiles can be found in the [SIM connectivity overview](/guides/get-started/sim-connectivity-overview). ## What other data plan options are available? If you need more flexibility, have specific coverage or data usage needs, or to learn more about our volume discounting, please reach out to our [sales team](https://www.hologram.io/contact-sales/). Other plan types we offer: * **Included data** plans that include a fixed amount of prepaid data at a discounted rate, the best choice for data usage you can predict or when you need a fixed monthly rate per SIM. * **Data pools** that let you share data across all the SIMs in your fleet. * **Network-level billing** with variable rates per network so that you're getting the lowest possible rates based on your deployment. ## Optimizing data plan selection Select a **Pay as you go** data plan and monitor data usage for the first month. Once you have a better idea of your usage modify your data plan accordingly. Select an **Included data** plan that most closely matches your usage and deployment area. Pair your plan with [data usage limits](/guides/billing/manage-fleet-data-usage) to avoid overage charges. If you use smaller amounts of data over your 30-day billing cycles, we generally recommend a **Pay as you go** data plan. Consider a **Included data** plan that most closely matches your usage and deployment area. Prepaying for data in advance can help you save on the cost of data. While the SIM is not being used, switch to a **Pay as you go** data plan or pause your devices to avoid prepaying for unused data. If your devices need to pause during predictable time frames, qualifying organizations working with our sales team can set up data plans with zero-data rates that are charged at a cheaper rate if they use 0 bytes of data in a month. You might qualify for scaled pricing with lower prices as your fleet grows. If your devices regularly travel between countries or you don't know where your devices will be deployed, our global **Global** data plans provide low rates with [broad global coverage](https://www.hologram.io/coverage/?utm_source=docs\&utm_medium=website\&utm_content=what_data_plan_should_i_choose). If you need a custom solution for more specific deployments, our [sales team](https://www.hologram.io/contact-sales/) can help. We recommend setting up multiple data plans to optimize your spending. Pay as you go plans with network-level billing can offer you the most flexibility for a variety of needs. Work with our [sales team](https://www.hologram.io/contact-sales/) to find the determine the best fit for your needs. # What happens when my organization's billing method changes? Source: https://docs.hologram.io/guides/billing/what-happens-when-billing-methods-change If your organization is switching billing methods, for example from prepaid billing to invoiced billing, several aspects of how you pay for and view your Hologram services will change. This guide explains what to expect during and after the transition. ## What happens if I change from prepaid billing to invoiced billing? Your organization will be billed differently beginning the next calendar month. Instead of paying as you go and paying down an account balance, you'll receive a monthly invoice for all charges accrued during the previous month. Payment is due according to the net payment terms specified in your contract. ### Data usage reporting With invoiced billing, data usage changes calculations change from a 30-day basis beginning on the date your SIMs were activated, to reporting on a monthly basis for each SIM. Data usage totals and usage reports also change to calculating on a monthly basis. ### Billing account details Your **saved credit card** information will no longer be available as your primary payment method. Instead, you'll need to enter ACH bank account information when you pay your invoices. Your saved credit card will be used as your backup payment method. You will no longer have an account balance to draw down from, and auto-refill will be disabled. Instead, you'll need to pay your invoices according to your contract's net payment terms. ### Invoices A new **[Invoices](/dashboard/billing/invoices)** page will appear in the Billing section of your dashboard for viewing and paying invoices. ## What changes if I switch from invoiced billing to prepaid billing? If you switch from invoiced billing to prepaid billing, your organization will once again pay for data usage and charges as they occur. You will need to maintain a positive account balance to avoid service interruptions, which you can refill using a credit card. You will also need to set auto-refill back up to automatically add funds to your account when it's low. ### Data usage reporting Beginning the next calendar month, data usage will once again be reported on a 30-day basis beginning on the date each SIM was activated. ### Billing account details Your saved credit card will once again be available as your primary payment method. My account balance will display in the **Account** page in the Billing section of your dashboard. You will also be able to [configure auto-refill](/dashboard/billing/auto-refill) to automatically add funds to your account when it's low. ## What happens if I switch from custom billing back to standard billing? Account balance, transactions, statements, and invoices while configured with custom billing are managed independently from standard billing. Depending on your configuration, your billing information from during this time may not be available or accurate in your dashboard. If you have questions about your data or need to access historical billing information, please [contact support](/guides/get-started/contact-support). Beginning the next calendar month, data usage will once again be tracked on a 30-day basis beginning on the date each SIM was activated, and monthly recurring charges will be billed on the same 30-day billing cycle. ## Related guides # What is event monitoring, and how do alerts work? Source: https://docs.hologram.io/guides/cloud-and-tools/event-monitoring-and-alerts-overview Alerts provide a way to send email or webhook notifications when specific events occur in your fleet, such as when a data limit is reached or an IMEI TAC change is detected for a device. **Beta:** Alerts functionality is in beta and replaces our legacy Routes functionality. Some Routes functionality is no longer available, and you may find issues during the beta period. Please send us your feedback using the **Support** menu in your dashboard. ## How alerts work An **event** is something that happens in your fleet — a SIM reaches a data limit, an IMEI changes, or a device sends a message. Hologram records each event on the **Event history** page and attaches **event tags** that identify what happened and which SIM it affected. An **alert** subscribes to the events you care about and sends a notification — by email or webhook — whenever a matching event occurs. To create an alert, you choose the event types to subscribe to, the SIMs or tags to target, and a notification method. Manage alerts from the **Event monitoring** section of the main menu under the **Alerts** tab, or manage them for a single SIM from that SIM's **Alerts** tab. ## Accessing data from an event Your notifications can include data from the event that triggered them — the message a device sent, the SIM's name, the time Hologram received it, and more. ### Event variables available to use in alerts You reference event data with **variables** such as `<>`, `<>`, and `<>` in your email subject, email body, or webhook payload. What each variable resolves to depends on the kind of event, and JSON payloads have specific quoting rules. See the dedicated guide for the full list of variables, the difference between device-message and system-generated events, and sample payloads for each event type. Reference event data in your notifications, with quoting rules and sample payloads for each event type. ## Supported notification methods ### Email notifications Sends an email with the specified subject and body to one or more recipients. Email notification example #### Parameters * **Recipients** - Comma-separated list of email addresses. * **Subject** - Subject line for the email. * **Message** - Template for the body of the message. ### Webhook notifications If you need to send messages to an app or service that Hologram doesn't natively support, you can send notifications using webhooks to send an HTTP `POST` request to any URL. This is useful for integrating with your own web apps, or services like Zapier, Make, or Slack. **Note:** To verify the contents and format of webhooks, it can be useful to send them to an HTTP request inspector such as **RequestBin**. Use your generated RequestBin URL as the destination URL in the alert, then refresh the RequestBin inspector page after you trigger the event that the alert is subscribed to. The message you receive will let you see the HTTP headers and content of the message that you can expect. You can also send template variables in the destination URL. This is useful for sending data as URL query string parameters. For example, the URL: ```text theme={null} https://example.com/webhook?device=<>&data=<> ``` Will send the `<>` and `<>` variables as query string parameters. #### Webhook configuration When configuring a webhook notification, you will need to specify the following fields: * **Destination URL** — The URL that receives the `POST` request. You can include [variables](/guides/cloud-and-tools/use-event-variables-in-alerts) in the URL to pass data as query string parameters. * **Message payload for POST** — The body of the request. Use variables to customize the message content. The default value is `<>`, which is the decoded payload of the event (either a string or JSON object). If your payload is JSON, the dashboard validates it (with variables substituted) before saving and offers a **Format JSON** button to pretty-print it. * **Headers for POST** — Add custom headers as key-value pairs. Click **Add basic auth header** to include an `Authorization` header for authenticated requests, or **Add JSON content-type header** to send the payload as JSON (`application/json`). The dashboard adds the JSON content-type header automatically when it detects a JSON payload. ## Why does my alert say "No longer supported"? Alerts with a "No longer supported" label use functionality that was part of our legacy Routes feature and has been deprecated. Some of these features may still work for a time, but will be removed in a future release. You can delete or disable these alerts to stop them from triggering, but they are not editable. * SMS notifications (deprecated in early 2023) * Slack legacy webhooks * IFTTT webhooks * Losant webhooks * Losant device send state * Amazon S3 routing * Heartbeat triggers ## Frequently asked questions No, alerts are processed after an event occurs, and could take anywhere from a few seconds to a few minutes to be processed and sent. No, notifications are sent as they happen. However, if this would be useful for your organization, please send us a request using the **Feedback** button in the **Support** menu in your dashboard. Yes, by creating multiple alerts, or subscribing to all events of a specific type. The best way is to tag your SIMs and subscribe to that SIM tag. The event tags checked by Alerts are inclusive, so if you add multiple tags to an alert it must match all of those tags for the alert to be triggered. If multiple `_DEVICE_ID_` tags were added to a data limit alert, for example, the alert could never trigger. ## Related guides # Event monitoring and alerting types and tags Source: https://docs.hologram.io/guides/cloud-and-tools/event-types-and-tags This guide outlines available event types and event tags for event monitoring and alerting. Event tags are used to identify the type of event that occurred, the SIM affected by the event, and any SIM tags that were attached to SIMs affected by the event. You can subscribe to events and receive notifications by creating an [alert](/guides/cloud-and-tools/event-monitoring-and-alerts-overview). ## Event types and tags Events are generated when specific actions happen in your fleet, and are tracked using **Event tags** that are attached to each event. Those event tags define what the event was, and which SIMs it happened for. System-generated event tags begin and end with underscores, for example `_DATALIMIT_` or `_DEVICE_123456_`, and are reserved for system use. The following event types can be monitored and alerted on: | Event name | Event tag | Description | | - | - | - | | Data limit reached | `_DATALIMIT_` | A SIM reached a data usage limit and was paused. | | Data warning threshold reached | `_DATAWARNING_` | A SIM reached a data warning threshold. | | IMEI change | `_IMEI_CHANGE_` | The last available IMEI for a SIM changed between data sessions, generally meaning the SIM has been moved to a new device. More information is in the message body. | | IMEI TAC change | `_IMEI_TAC_CHANGE_` | The last available IMEI TAC prefix for a SIM changed between data sessions, inferring that new modem hardware is being used. This event is always accompanied by an IMEI change event. | | First IMEI recognized | `_IMEI_FIRST_` | A SIM was first connected to the network and an IMEI was detected. More information is in the message body. | | SMS received | `_SMS_DT_` | An SMS message was received by a SIM. | | SMS sent | `_SMS_DO_` | An SMS message was sent from a SIM. | | SMS delivered | `_SMS_DT_DELIVERED_` | An SMS message was delivered to a SIM successfully. | | TCP/UDP message received | `_API_DT_` | A TCP/UDP message was received by a SIM. | | API responded to an event | `_API_RESP_` | When a device responds to a message sent using the cloud-to-device API or Dashboard features, the response contains this topic. | | Conductor configuration change | `_EUICC_CONFIGURE_SIM_` | Conductor completed orchestration of a SIM or profile configuration change. The message body contains the details of the configuration change including SIM information, configuration changes to make, and the status of the operation. | | Profile change (fallback) | `_PROFILE_CHANGE_FALLBACK_` | A SIM's enabled profile changed because [Outage Protection™](/guides/sims/outage-protection) fell back to another profile. | | Profile change (manual) | `_PROFILE_CHANGE_MANUAL_` | A SIM's enabled profile changed because a user [switched profiles](/dashboard/sim-actions/switch-profiles). | | Profile change (Conductor) | `_PROFILE_CHANGE_CONDUCTOR_` | A SIM's enabled profile changed as part of a Conductor configuration change. | | Profile change (system) | `_PROFILE_CHANGE_SYSTEM_` | A SIM's enabled profile changed because of a system-driven update. | Some legacy event tags may still be present in old events such as `_SOCKETAPI_`, `_JSONSTRING_`, `_SIMPLESTRING_`, `_SMS_`, `_SMSOVERIP_`, `_RESTAPI_`, but are no longer supported. ## Generic event tags Each event has tags applied that give additional context about which SIMs were affected by the event. These tags are used to identify which SIMs an event was created for. You can [create alerts](/dashboard/event-monitoring/create-alert) using these event tags to receive notifications for specific SIMs or groups of tagged SIMs that you want to monitor. Only one of these identifying tags can be added to an alert, however, so if you want to monitor multiple SIMs with one alert then you should tag those SIMs and create an alert that monitors that tag (e.g. `_TAG_123456_`). | Event tag | Description | | - | - | | `_DEVICE_XXX_` | The event was triggered for a specific SIM/device (for example, `_DEVICE_1234_`). | | `_TAG_XXX_` | Added for each tag that a SIM/device has at the time the event is created. | ## Event message fields Each event also has a default message that is sent with the event to notification recipients. The default message body and content includes the following default fields: ```json theme={null} { "received": "2016-09-27T18:53:09.302915", "authtype": "psk", "tags": ["TOPIC1", "_DEVICE_12345_"], "device": { "id": 5678, "name": "My Device" }, "errorcode": 0, "source": "abcd", "timestamp": "0", "data": "SGVsbG8sIHdvcmxkIQo=" } ``` ### Field reference * `received`: ISO8601-formatted UTC timestamp when the event was received by the Hologram Cloud. * `tags`: Array of topics that the message belongs to. * `device.name`: Human-readable name of the device, as specified in the Hologram Dashboard. * `device.id`: Integer device ID. * `data`: Base64-encoded representation of the data payload. * `authtype`: Method by which the message sender authenticated with the Hologram Cloud. * `errorcode`: `0` for messages processed successfully. * `source`: Source ID from the credentials used to send the event. Some data sources use a different authentication method so this field may not always be present. ### Referencing field contents You can reference the contents of the default message fields in your alert notification messages using variables, as outlined in the [Event variables in alerts](/guides/cloud-and-tools/use-event-variables-in-alerts) guide. The `data` field is base64-encoded. If the message body is a string or JSON object, the decoded content can be referenced using `<>`. # Send a circuit-switched SMS message to the Hologram Cloud Source: https://docs.hologram.io/guides/cloud-and-tools/send-a-circuit-switched-sms-message-to-the-hologram-cloud How to send circuit-switched SMS to the Cloud and view messages. SMS-capable devices on Hologram’s cellular network can send messages to the Cloud Services Router via standard circuit-switched SMS messages to Hologram’s SMS inbox. You don’t need to specify API credentials, as Hologram can authenticate devices by their SIM cards. **Note:** Each profile type (i.e. G1, G2, G3, etc) has a different Cloud number, which can be found in the table below: | Profile | Cloud number | | - | - | | Global-1 (G1) | +447937405250 | | Global-2 (G2) | +80112 | | Global-3 (G3) | +467190002980389 | ## How do I send an outbound circuit-switched SMS from a SIM? **Hologram Cloud's phone number:** ```text theme={null} +447937405250 ``` **Example SMS body** ```text theme={null} Hello, World! ``` The SMS message can be viewed in the **Event history** page in the **Event monitoring** section of your dashboard. Or you can find all events for a single SIM in the SIM's details page under the **Events** tab. The SMS event created will include the `_SMS_DO_` event tag and the `_DEVICE_[deviceid]_` event tag associated with the SIM. You can also view the list of events using the [List Data Engine Messages](/api/1/csr/data/get) REST API endpoint. **Note:** Sending SMS messages from your device on the Hologram network will incur fees at outbound SMS rates, which are typically more costly than data rates. You can find the current SMS rate for your SIM in the SIM's **Pricing** tab or in the Data plan's details page. **Limited functionality:** This feature not available for legacy Indigo SIMs, which do not have access to send circuit-switched SMS. # Send SMS to devices using the REST API Source: https://docs.hologram.io/guides/cloud-and-tools/send-sms-to-devices-using-the-rest-api Examples for sending SMS to devices using curl and Python requests. You can send SMS to devices programmatically using the REST API. ## Curl (Unix) ```bash theme={null} curl --location --request POST 'https://dashboard.hologram.io/api/1/sms/incoming' \ --header 'Content-Type: application/json' \ --header 'Authorization: Basic ' \ --data-raw '{"deviceid":"","fromnumber":"","body":""}' ``` ## Python (requests) ```python theme={null} import requests from requests.auth import HTTPBasicAuth usr = 'apikey' pwd = '' dev = '' num = '' sms = '' response = requests.post( 'https://dashboard.hologram.io/api/1/sms/incoming', data={ 'deviceid': dev, 'fromnumber': num, 'body': sms, }, auth=HTTPBasicAuth(usr, pwd) ) print(response.json()) ``` ## Related actions Send SMS messages, or TCP or UDP cloud messages to your SIMs # Use variables from events in alerts Source: https://docs.hologram.io/guides/cloud-and-tools/use-event-variables-in-alerts Use variables to reference event data and insert into Alert email and webhook notifications sent to your team or systems. When an event triggers an alert, the event's data is available as **variables** that you insert into the email or webhook you send. You don't create this data yourself — Hologram populates it from the event, and each variable is replaced with a real value at the moment the notification is sent. ## Accessing data from an event What a variable contains depends on which of two kinds of event fired: * **Events that carry a message from your device or network** — SMS, TCP/UDP, and socket API messages. Here `<>` is exactly what the device sent, which can be plain text or a JSON object. * **System-generated events** — Data warnings, data limits, IMEI changes, and similar. Your device sends nothing; Hologram builds a defined JSON payload, so `<>` is a predictable object whose fields you can reference individually (for example, `<>`). For the full list of events and their tags, see [Event types and tags](/guides/cloud-and-tools/event-types-and-tags). ### Where variable values come from Excepting the device payload in `<>`, you don't author any of the event data, you reference it. For a data warning event, for example: * `<>` → when Hologram received the event, such as `2026-07-16T17:51:47+00:00` * `<>` → the event's tags, such as `["_DEVICE_1234567_", "_DATAWARNING_"]` * `<>` and `<>` → the SIM's name and device ID * `<>` → the raw payload, base64-encoded; `<>` → that same payload, decoded to `{ "msg": "Device 1234567 has hit usage warning threshold.", … }` ### The full event versus its payload Those variables each read a specific part of the event — none of them returns the whole thing. When you view an event in [event history](/dashboard/event-monitoring/event-history) or through the events API, you see a wrapper of metadata around the message, and `<>` returns only the innermost, decoded payload. Here is a complete IMEI change event, decoded: ```json theme={null} { "id": 100000001, "logged": "2026-05-13 16:40:39", "expires": "2027-05-13 16:40:39", "orgid": 12345, "deviceid": 1234567, "record_id": "11111111-2222-3333-4444-555555555555", "device_metadata": "{}", "data": { "authtype": "deviceid", "source": 1234567, "tags": ["_IMEI_TAC_CHANGE_", "_DEVICE_1234567_", "_IMEI_CHANGE_"], "data": { "new_imei": "351111110000001", "prev_imei": "350000000000000", "msg": "Device 1234567 IMEI change from 350000000000000 to 351111110000001" }, "received": "2026-05-11T17:02:45+00:00", "record_id": "11111111-2222-3333-4444-555555555555", "device_id": 1234567, "device_name": "My Device" }, "matched_rules": [], "tags": ["_IMEI_TAC_CHANGE_", "_IMEI_CHANGE_", "_DEVICE_1234567_"], "simcardid": 7654321 } ``` From that event, the variables resolve like this: * `<>` returns **only** the innermost `data` — the decoded message payload, not the wrapper around it: ```json theme={null} { "new_imei": "351111110000001", "prev_imei": "350000000000000", "msg": "Device 1234567 IMEI change from 350000000000000 to 351111110000001" } ``` * `<>` returns that same payload *before* decoding, as a base64 string. * `<>`, `<>`, `<>`, and `<>` read the surrounding fields (`received`, `tags`, `device_name`, and `device_id`) — not the payload. ### Variables available in alerts Variables are replaced with literal text when the notification is sent. When you use a variable inside a JSON payload, whether to wrap it in quotes depends on the type of value it is replaced with: | Variable | Replaced with | In a JSON payload | | - | - | - | | `<>` | ISO 8601 UTC timestamp of when Hologram received the event | Wrap in quotes: `"<>"` | | `<>` | JSON array of the event's tags (e.g. `["_DEVICE_1234567_", "_DATAWARNING_"]`) | Do **not** wrap in quotes: `<>` | | `<>` | The name of the SIM | Wrap in quotes: `"<>"` | | `<>` | The integer device ID. *SIM IDs are not yet supported* | Either works: `<>` (number) or `"<>"` (string) | | `<>` | The raw payload, base64-encoded | Wrap in quotes: `"<>"` | | `<>` | The decoded payload — plain text or a JSON object, depending on the event | Quote it (`"<>"`) when the payload is plain text; leave it unquoted when the payload is JSON. See the two sections below. | | `<>` | A single field from the payload, when the payload is JSON (e.g. `<>`) | Match the field's type: unquoted for numbers, quoted for strings | **Important:** The `<>` variable is replaced with a JSON array (e.g. `["_DEVICE_12345_", "_SMS_DO_"]`). When using this variable in a JSON webhook body, do **not** wrap it in quotes. Writing `"<>"` produces an invalid JSON string, while `<>` (without quotes) produces a valid array. ## Events that carry a device or network message For these events, `<>` is the message your device or the network sent. Hologram doesn't change it — whatever was transmitted is what you receive. Events in this category include: * **Socket API messages** — the device sends data directly to the Hologram socket API, as plain text or JSON. * **SMS** — inbound and outbound messages. `<>` is the message text. * **TCP/UDP messages** — `<>` is the message the device sent. Because the content is whatever your device sends, whether to quote `<>` depends on what it transmits: * If your device sends **plain text**, wrap it in quotes so it forms a valid JSON string: `"<>"`. * If your device sends a **JSON object**, leave it unquoted so it nests as an object. ### Example: Forward a device reading to a webhook A device that reports `{ "temperature": 23.5 }` can be forwarded to a downstream service: * **URL** – `https://example.com/webhook` * **Body** ```json theme={null} { "temperature": <>, "source_device": "<>", "datetime": "<>" } ``` ...results in a `POST` request with the following body: ```json theme={null} { "temperature": 23.5, "source_device": "1234567", "datetime": "2026-07-16T17:53:09+00:00" } ``` ## System-generated event data For these events, your device sends nothing. Hologram generates the event and builds a defined JSON payload, so `<>` is a predictable object — and you can pull individual fields with `<>` (for example, `<>`). The following payloads show what `<>` contains for each system-generated event. Sent when a SIM crosses a data warning threshold. ```json theme={null} { "msg": "Device 1234567 has hit usage warning threshold.", "deviceid": "1234567", "data_warning_threshold_bytes": 1, "triggered_at_usage_bytes": 1200 } ``` Sent when a SIM reaches its data limit and is paused. ```json theme={null} { "deviceid": "1234567", "plan_amount": 1024, "overage_limit": 500, "planid": 123, "msg": "Device 1234567 paused due to data limit" } ``` Sent the first time an IMEI is detected for a SIM. ```json theme={null} { "new_imei": "350000000000018", "msg": "Device 1234567 first attach with 350000000000018" } ``` Sent when the IMEI for a SIM changes between sessions. When the TAC prefix also changes, the event additionally carries the `_IMEI_TAC_CHANGE_` tag. ```json theme={null} { "new_imei": "351111110000001", "prev_imei": "350000000000000", "msg": "Device 1234567 IMEI change from 350000000000000 to 351111110000001" } ``` Sent when an SMS is delivered to a SIM. This payload is plain text, not JSON, so wrap it in quotes when using it in a JSON body: `"<>"`. ```text theme={null} SMS delivered ``` Sent as Conductor applies an eSIM profile configuration change. The `configuration_plan` array lists one entry per action, each with its own `status` (such as `PLANNED`, `PENDING`, `COMPLETE`, or `ERROR`). ```json theme={null} { "event_type": "orchestration.euicc", "notification_kind": "configuration_run_updated", "occurred_at": "2026-05-11T20:16:41+00:00", "status": "PENDING", "device_context": { "device_id": 1234567, "sim_id": 7654321, "org_id": 12345, "last_known_imei": "350000000000000", "eid": "89000000000000000000000000000001" }, "request_id": "aaaaaaaa-1111-2222-3333-444444444444", "operation_id": "bbbbbbbb-1111-2222-3333-444444444444", "config_change": { "enabled_iccid": "8988000000000000001", "disabled_iccids": ["8988000000000000002", "8988000000000000003"] }, "configuration_plan": [ { "action": "AUDIT", "profile_iccid": null, "status": "COMPLETE", "metadata": { "last_updated_at": "2026-05-11T16:15:56.993645+00:00", "profiles": { "8988000000000000003": { "state": "Disabled", "fallback_attribute": false, "delete_restriction": true }, "8988000000000000002": { "state": "Enabled", "fallback_attribute": true, "delete_restriction": false }, "8988000000000000001": { "state": "Disabled", "fallback_attribute": false, "delete_restriction": false } } }, "sync_sim_to_audit": false }, { "action": "ENABLE", "profile_iccid": "8988000000000000001", "status": "PENDING", "metadata": { "last_updated_at": "2026-05-11T20:16:41.818236+00:00", "attempts": 1 } }, { "action": "AUDIT", "profile_iccid": null, "status": "PLANNED", "metadata": { "last_updated_at": "2026-05-11T16:15:40.208609+00:00" }, "sync_sim_to_audit": true } ] } ``` ### Example: Reference specific fields from a system event Because system payloads are structured, reference the fields you need instead of sending the whole object. Send a readable summary by email: * **Recipients** – `ops@example.com` * **Subject** – `Usage warning for <>` * **Message** – `<> (device <>)` Or forward selected fields to a webhook: * **URL** – `https://example.com/webhook` * **Body** ```json theme={null} { "device": "<>", "message": "<>", "usage_bytes": <>, "at": "<>" } ``` Note the field types: `usage_bytes` is a number, so it is unquoted, while the string fields are wrapped in quotes. ## Formatting and validating your payload **Important:** If you are sending a JSON payload, make sure your webhook includes a `content-type: application/json` header. Without it, the recipient may receive an empty or unparseable body. The dashboard adds this header automatically when it detects a JSON payload, and validates that the payload is valid JSON before saving. These payloads look similar to valid ones but are **invalid** and will fail to send: ```text theme={null} {'temperature': <>} ← single quotes are not valid JSON {"tags": "<>"} ← <> must not be wrapped in quotes {"datetime": <>} ← string variables must be wrapped in quotes ``` For help diagnosing failed alerts and webhooks, see [Troubleshooting alerts and webhooks](/guides/troubleshooting/troubleshooting-alerts-and-webhooks). # What is Hologram cloud messaging? Source: https://docs.hologram.io/guides/cloud-and-tools/what-is-hologram-cloud-messaging Hologram cloud messaging forwards data between your device and the internet using the device's cellular data connection. It supports both outbound (device to cloud) and inbound (cloud to device) messaging. ## Outbound (from device) Messages take the form of a binary payload (usually UTF8-encoded text), and an optional list of event tags that you can use for filtering events or for triggering alerts and sending notifications. By configuring an alert, you can forward messages to other internet services using webhooks. This lets you automatically forward your messages without deploying code updates to your cellular devices. Learn about how event monitoring works and how to send notifications when events occur Learn about available event types and tags ## Inbound (to device) Hologram has API endpoints and interface in your dashboard to send **TCP or UDP messages** to any port on your cellular device. This requires that your device run embedded Linux or otherwise implements a networking stack. We then translate the API requests — or messages sent using your dashboard — into raw TCP/UDP messages and send them to the desired SIM. Send TCP or UDP messages to any port on your device from your dashboard Send TCP or UDP messages to any port on your device using the REST API # Add device tunneling keys using the REST API Source: https://docs.hologram.io/guides/communication/add-device-tunneling-keys-using-the-rest-api Create Spacebridge tunneling keys via the REST API. Spacebridge allows secure inbound access to devices. Users can have up to 5 active tunneling keys. To add a key: ```http theme={null} POST https://dashboard.hologram.io/api/1/tunnelkeys&orgid=[YOUR_ORG_ID] ``` ## Related actions # Device tunneling for beginners Source: https://docs.hologram.io/guides/communication/device-tunneling-for-beginners Create an inbound Spacebridge tunnel to a device using a Hologram SIM. This guide shows how to create an inbound Spacebridge tunnel to a device (e.g., Raspberry Pi) connected with a Hologram SIM. We will be using a Raspberry Pi in this example, but you can securely tunnel into any device that gives you port level access. ## Create a secure device tunnel First, make sure your end device has an open data session. Using a Raspberry Pi, you have a variety of choices on how to do that, for example ModemManager + NetworkManager, ChatScript, or the tool of your preference. Follow the SSH tunneling instructions to establish the tunnel. If you've already uploaded your keys (required once), then only you will only need to create the tunnel. Once your tunnel is set up you can SSH into the device. In this case, it is a Raspberry Pi. ```bash theme={null} ssh pi@127.0.0.1 -p 5000 ``` Secure tunnel using Spacebridge example ## Related actions # Does the Hologram SIM support voice calling? Source: https://docs.hologram.io/guides/communication/does-the-hologram-sim-support-voice-calling Hologram IoT SIMs support VoIP communications using data. Hologram's SIMs are designed for the Internet of Things (IoT) and Machine to Machine (M2M) communications. They only support data usage and SMS messaging. However, data can be used for VoIP communications. **Note:** VoIP communications will consume data according to your device's codec and call duration. ## Related actions Send SMS, TCP, or UDP messages to your devices Review pricing information for your SIMs # Enable and disable device tunneling keys using the REST API Source: https://docs.hologram.io/guides/communication/enable-and-disable-device-tunneling-keys-using-the-rest-api Manage Spacebridge tunneling keys with enable/disable API calls. Hologram issues each user up to 5 tunneling keys. Keys are associated with clients (computers), not SIMs/devices. ## List keys ```http theme={null} GET https://dashboard.hologram.io/api/1/tunnelkeys?withdisabled=0&userid=[YOUR_USER_ID] ``` Example response: ```json theme={null} { "success": true, "data": [ { "id": 12345, "userid": 0, "disabled": 0, "public_key": "YOUR_PUBLIC_KEY" } ] } ``` ## Enable a key ```http theme={null} POST https://dashboard.hologram.io/api/1/tunnelkeys/YOUR_SPACEBRIDGE_KEY_ID/enable ``` ## Disable a key ```http theme={null} POST https://dashboard.hologram.io/api/1/tunnelkeys/YOUR_SPACEBRIDGE_KEY_ID/disable ``` ## Related actions # Establish a secure Spacebridge tunnel to a device using SSH Source: https://docs.hologram.io/guides/communication/establish-a-secure-spacebridge-tunnel-to-a-device-using-ssh Enable tunneling, upload an SSH key, and open a Spacebridge tunnel using port forwarding. Hologram Spacebridge lets you create authenticated SSH tunnels to devices on the Hologram cellular network. ## Enable secure device tunneling You can enable tunneling for a single SIM or for multiple SIMs from the Dashboard. **Note:** You must configure your device's network interface to support inbound connections. ## Generate an SSH key and upload to the API You only need to complete this section the first time you're setting up the tunnel on this computer. If you already have an SSH key-pair that you'd like to use, skip to step 2. Use `ssh-keygen` to generate a SSH key-pair: ```bash theme={null} ssh-keygen -f spacebridge.key -b 4096 -t rsa ``` Upload your public key to the Hologram API. In the code below, replace **`~APIKEY~`** with your Hologram API key. Your personal API can be found in your dashboard by clicking on the **Settings** section in the main menu, opening the **My account** tab, and scrolling to the **API** card. If you are using a key that you already generated, replace the filename in the export command. The filename ends in **`.pub`**, not `.key`. If you use the `.key` file this will upload your private key which you don't want to do. ```bash theme={null} PUBKEY=$(cat spacebridge.key.pub) curl -X POST \ -H "Content-Type: application/json" \ -u apikey:YOUR_HOLOGRAM_API_KEY \ -d '{"public_key":"'"$PUBKEY"'"}' \ "https://dashboard.hologram.io/api/1/tunnelkeys?apikey=~APIKEY~" ``` The same command can also be run with Powershell in Windows: ```powershell theme={null} $pub = (Get-Content .\spacebridge.key.pub -Raw).Trim(); Invoke-RestMethod -Uri "https://dashboard.hologram.io/api/1/tunnelkeys?apikey=YOUR_HOLOGRAM_API_KEY" -Method Post -ContentType "application/json" -Body (@{public_key = $pub} | ConvertTo-Json) ``` You should get a successful response back. Users can have up to 5 active device tunneling keys (to enable or disable keys follow these instructions). ## Open the tunnel with SSH port forwarding Look up the link (profile) ID for the SIM you are trying to tunnel into. In your dashboard you can find this number by navigating to the SIM's details page and opening the **Profiles** tab. The command below will open up the tunnel. You can see in this command where you would replace the link ID (999999) with your own ID. In this case, port `22` is the port on the device, and port `5000` is the local port being forwarded. Replace `spacebridge.key` with whatever private key you are using. This should be key file that goes with the `.pub` file that you uploaded to the Hologram API. ```bash theme={null} ssh -p 999 -L 5000:link999999:22 -N -i spacebridge.key htunnel@tunnel.hologram.io -v ``` You should now be able to connect to port `22` on your device from port `5000` on the local host (example here). ## Related actions # Purchase a phone number to send SMS messages to a SIM Source: https://docs.hologram.io/guides/communication/purchase-a-phone-number-to-send-sms-messages-to-a-sim All Hologram SIMs include a non-geographic phone number for inbound SMS from anywhere in the world. You can also purchase a localized country-specific number for inbound SMS if your use case requires it. ## Do I need to purchase a phone number to send SMS messages to a SIM? In most cases, no. All Hologram SIMs come with a preassigned non-geographic phone number known as the **MSISDN** that allows you to send an SMS to your device directly from another SMS capable device, like your cell phone as an example. A non-geographic number is a type of telephone number that is not linked to any specific country or location, allowing the SIM to be reachable anywhere in the world the SIM needs to connect. In addition to using a non-geographic phone number, SMS can also be sent via API calls or via your dashboard. There are some use cases where non-geographic based phone numbers do not support the desired use case, or customer experience, and a localized phone number is needed. This is relatively rare, but still important for certain application spaces. In those use cases, Hologram offers the ability to purchase and assign a country specific phone number to the SIM card. This allows users to use the country specific phone number to send an SMS to the device. The localized phone number does not change the actual MSISDN (phone number) of the SIM card and only provides a geographically based alias for that SIM card to receive SMS. It does not change or impact any SMS sent by the device. Phone number pricing depends on the country you select, and is charged at a monthly rate. A localized phone number is not required for SMS, and localized phone numbers do not enable voice calling. ## Requirements to purchase a phone number * To purchase a phone number you will need a billing address in that country (read about how to [add a billing address](/dashboard/billing/update-billing-address)). * You also need enough balance in your Hologram account to cover the first month's subscription for the phone number. ## Localized phone number limitations * Phone numbers are not available in every country, and are not available for every area code in the US. * Localized phone numbers do not enable voice calling. ## Purchase a localized phone number Find your SIM in the **SIMs** pages or using global search. In the **Add-ons** card, select **Purchase phone number**. Add-ons card showing Purchase phone number button In the modal that appears, choose the country and area code if applicable. The price of your phone number will be displayed if there is one available. Purchase phone number modal ## Related actions # Send and receive SMS via mmcli Source: https://docs.hologram.io/guides/communication/send-and-receive-sms-via-mmcli Learn how to test end-to-end SMS on a Linux device with a Hologram SIM using ModemManager (`mmcli`) on a Linux device such as a Raspberry Pi. Send a message to your device, confirm the device received it, send a reply, and verify delivery. ## Requirements * A Linux device with a cellular modem and an active Hologram SIM. * ModemManager installed, which provides the `mmcli` command. * Access to your [Hologram dashboard](https://dashboard.hologram.io) for the SIM you are testing. * Permission to run `sudo` on the device, which is required to create, send, and delete messages. ## Verify the modem is connected Before testing SMS, confirm the modem is attached and connected on LTE: ```bash theme={null} mmcli -m any ``` Check the following fields in the output: * **Status > state**: should be `connected` or `enabled` * **Status > access tech**: should be `lte` (in regions that still support 2G or 3G, `gsm-umts` or others may also work) * **3GPP > operator name**: should be `Hologram` or the actual mobile network operator * **3GPP > registration**: should be `roaming` or `home` * **3GPP EPS > ue mode of operation**: should be `csps-2` (combined CS/PS, which is required for SMS) * **3GPP > packet service state**: should be `attached` mmcli output showing modem status, access technology, and 3GPP registration fields If `ue mode of operation` is not `csps-2`, SMS may not work. Check your modem's UE mode configuration. ## Send an SMS message to the device from your dashboard In your dashboard, navigate to the SIM and use the **Manage SIM** menu to **[Send message to SIM](/dashboard/sim-actions/send-messages-to-sims)** and send a test message to the SIM. After sending, open the **[Events tab](/dashboard/sims/sim-details-events-tab)** for the SIM to view event history. You should see two events: 1. The message sent to the device, "**To SIM**". In the example below, the message body is `g2-sms-20260623` with an event type of **[Inbound SMS](/guides/cloud-and-tools/event-types-and-tags#outbound-sms)** (`_SMS_DT_` event tag). 2. A delivery confirmation sent back to Hologram, "**From SIM**". In the example below, the message body is `SMS` with an event type of **[Inbound SMS delivered](/guides/cloud-and-tools/event-types-and-tags#sms-delivered)** (`_SMS_DT_DELIVERED_` event tag). Dashboard Event History showing To SIM and From SIM events for the test message ## Verify the message was received by the device List the messages stored on the modem: ```bash theme={null} mmcli -m any --messaging-list-sms ``` Inspect a received message by its index: ```bash theme={null} mmcli -s 12 ``` Messages from Hologram arrive from the number assigned to the **Hologram short or long code**. The `text` field contains the message body you entered. mmcli output showing the contents of a received SMS, including number and text fields ## Create and send an SMS message from the device **Important:** The destination must be a valid Hologram short or long code, not an arbitrary number. **Use the number from the received SMS**, visible in the `number` field of `mmcli -s `. ```bash theme={null} sudo mmcli -m any --messaging-create-sms="number=+80112,text=g2-sms-reply-20260623" ``` Verify the message was created, send it, then confirm it was sent: ```bash theme={null} mmcli -s 13 sudo mmcli -s 13 --send mmcli -s 13 ``` After sending, `state` changes from `submit` to `sent` and a `message reference` number is present. mmcli output showing a created SMS transitioning from submit to sent state with a message reference ## Verify the message was received by the SIM In your dashboard, open the **[Events tab](/dashboard/sims/sim-details-events-tab)** for the SIM to view event history. You should see a new event tagged **[Outbound SMS](/guides/cloud-and-tools/event-types-and-tags#outbound-sms)** (`_SMS_DO_` event tag) with the message body matching what you sent. Dashboard Event History showing an Outbound SMS event with the message body sent from the device ## Delete messages to free up modem memory (optional) List the current messages: ```bash theme={null} mmcli -m any --messaging-list-sms ``` Delete a specific message by its index: ```bash theme={null} sudo mmcli -m any --messaging-delete-sms=7 ``` mmcli output confirming an SMS was deleted from modem memory by index To delete multiple messages in a loop: ```bash theme={null} for i in 7 8 9 10 11 12 13; do sudo mmcli -m any --messaging-delete-sms=$i done ``` **Danger:** Do not use `mmcli -s --delete`. This syntax is broken in newer versions of ModemManager and returns `error: no actions specified`. Always use `--messaging-delete-sms=` on the modem (`-m`) instead. # Troubleshooting device tunneling Source: https://docs.hologram.io/guides/communication/troubleshooting-device-tunneling Resolve common Spacebridge tunneling issues and key limitations. Spacebridge enables secure SSH tunnels to devices on the Hologram network. ## Troubleshooting Spacebridge 1. Ensure SSH is running on the target device. 2. Ensure the cellular interface is the default route. 3. Confirm the device is connected and passing data on the cellular interface. 4. Verify responses are not routed over Wi-Fi or Ethernet instead of the cellular link. ## "You are only allowed 5 tunnel keys" error Hologram issues each user a maximum of 5 tunnel keys. You can enable/disable keys via the REST API. **Note:** Tunnel keys are mapped to desktop clients (computers), not SIMs/devices. ## Related actions # View device tunneling keys using the REST API Source: https://docs.hologram.io/guides/communication/view-device-tunneling-keys-using-the-rest-api Retrieve Spacebridge tunneling keys via the REST API. Tunneling keys are the public keys used to authenticate [Spacebridge](/guides/communication/device-tunneling-for-beginners) tunnels to your devices. Use the REST API to list the existing keys for your organization. ```bash cURL theme={null} curl --request GET \ 'https://dashboard.hologram.io/api/1/tunnelkeys?withdisabled=0&orgid=YOUR_ORG_ID' \ -u apikey:YOUR_HOLOGRAM_API_KEY ``` Find your `orgid` in [your organization overview](/dashboard/orgs-and-users/organization-overview). Example response: ```json theme={null} { "success": true, "data": [ { "id": 12345, "userid": 12345, "disabled": 0, "public_key": "YOUR_PUBLIC_KEY_HERE" } ] } ``` ## Related actions # Activate SIMs in the Hologram Dashboard Source: https://docs.hologram.io/guides/get-started/activate-your-first-sims Activating SIM cards is easy with Hologram. Whether you are activating one or one thousand devices, you can quickly activate SIM cards in your [dashboard](https://dashboard.hologram.io/account/login) using this step-by-step guide. ## How activation works in your dashboard During the activation process, you will select a data plan for your new SIMs, review coverage and rates, set data usage limit preferences, organize your SIMs with tags or name prefixes, then finally pay and activate the SIMs so that they can connect for the first time. If you are activating SIMs for the first time, please note that you'll need to add **payment details and a billing address** to complete the activation process. [Learn more about adding a billing address](/dashboard/billing/billing-account-overview). **Limited access:** Learn more about Test Mode and streamline your deployments by contacting our [sales team](https://www.hologram.io/contact-sales?utm_source=docs\&utm_medium=website\&utm_content=test_mode_callout). You can navigate away from and return to the activation process at any time without losing your progress. Your progress is saved until you log out. First, enter the ICCIDs of the SIMs you want to activate. You can add SIMs individually, by entering a range, or by list upload using a CSV file. You can enter ICCIDs or EIDs when activating SIMs. Read about [how to find SIM ICCIDs](/guides/troubleshooting/how-to-find-sim-iccids-and-eids). If a SIM or profile cannot be added, you will see an error that distinguishes SIM-level issues from profile-level issues. #### Enter SIMs individually by ICCID Enter an ICCID by typing or copy/paste. You can add multiple ICCIDs separated by a comma, space, or line break. Barcode scanners can help quickly enter ICCIDs using the bardcode printed on each SIM card. Enter ICCIDs individually #### Enter a range of SIMs To choose a range of SIMs, enter the first and last ICCIDs in the range of SIMs to activate. You can find these ICCIDs printed on the box of SIMs you receive as the “ICCID Start” and “ICCID End”. #### Upload a CSV You can add a list of SIMs by uploading a list of ICCIDs in a `CSV` file using the template linked on the page. Click the **Download this template** link to download the CSV template, or use the format shown below this step. Upload CSV ##### CSV template format ```csv theme={null} ICCID YOUR_ICCID_1234567890 YOUR_ICCID_1234567891 YOUR_ICCID_1234567892 ``` Once the ICCIDs are successfully verified, they display in a table with the **SIM SKU**, **manufactured profile ICCIDs**, and the profiles installed on the SIM. Installed profiles determine the coverage and data plans available to the SIM. If there are any errors when verifying a SIM or profile, you will see a red or yellow notification callout with an explanation.   After entering SIMs, you can choose from data plans available to those SIMs. Data plans define the **coverage** and **pricing** available to a SIM, based on its installed connectivity profile(s). Activation step 2 - Choose coverage and rates, selecting a data plan The page only shows data plans that have coverage or favorable rates for the SIMs you have entered. However, you can **display all data plans** available to your account by toggling off the **Show only recommended plans** switch at the bottom of the page. If you have contracted rates available to your organization this reads **Show all data plans**. Any data plans without coverage or negotiated rates for the SIMs you've selected are marked in the list. Activation step 2 - Show all available data plans including those without coverage or negotiated rates   Next, you'll review all of the rates and coverage details for the data plan you've selected. Activation step 3 - Review coverage and rates, setting data usage limits *Optional.* Here you can also set **data usage limits** to pause SIMs automatically if they use over a certain amount of data. We recommend pausing at **10 GB** to protect against runaway usage from theft or device misconfiguration. You can also leave SIMs unlimited or set a custom amount, but the amount must be greater than the included data amount for plans with included data. You cannot set a 0 B limit on data plans that do not include data. Read more about [data usage limits](/guides/billing/manage-fleet-data-usage). Activation step 3 - Review coverage and rates, setting data usage limits *Optional.* You can also set a **data usage warning threshold** to create an event when a SIM reaches a certain amount of data usage. Create an [alert](/dashboard/event-monitoring/alerts-and-notifications) to be notified. A threshold of 0 B alerts at the first data usage of each billing period. Read more about [data warning thresholds](/dashboard/sim-actions/set-data-warning-threshold).   *Optional.* In this step you can **rename** your SIMs using a custom prefix, or add **tags** to help you better manage and organize your fleet. Tags are an especially useful way to organize and report on your fleet, and are useful to get notified of events for specific groups of SIMs when creating alerts. Activation step 4 - Configure SIMs with name prefixes and tags   You're almost there! In the final step, you have the chance to review all the selections you have made so far, confirm payment information and activate your device. Activation step 5 - Review charges, choose payment method, and activate SIMs If your account is prepaid and draws down from an account balance, you can set up account auto-refill to ensure that your devices never go offline due to insufficient funds. Read more about [auto-refill](/guides/billing/auto-refill). An auto-refill card appears in the page if you have not yet set up auto-refill for your organization After configuring auto-refill you'll see auto-refill configuration in the Payment method card   Once you click **Pay and activate**, you will see a final confirmation screen with a reminder to set the APN for your device before you are taken back to your dashboard. Read more about [setting the APN for your device](/guides/get-started/set-the-device-apn). After activation, you'll be prompted to set your device's APN based on the profiles installed on your SIMs   ## Activating SIMs out of Test Mode SIMs in Test Mode will automatically activate after their free testing period ends with **no downtime or action required** on your part. [Learn more about Test Mode](/guides/sims/test-mode). If your devices have limited connectivity windows or other constraints, you can [force activate](/dashboard/sim-actions/force-activate-from-test-mode) them out of Test Mode. This can also be used to activate SIMs with legacy Global-1 (G1) profiles, which experience a brief disconnection when activating to update profile states. ## Related guides ## Activating SIMs using the REST API Activate SIMs (bulk) POST /links/cellular/bulkclaim ## Related actions Force-activate SIMs that are in Test Mode Configure per-SIM data and SMS limits # Cat-M1 (LTE-M) and NB-IoT coverage Source: https://docs.hologram.io/guides/get-started/catm1-and-nbiot-coverage Cat-M (LTE-M) and NB-IoT are low-power cellular technologies designed specifically for IoT devices with reduced bandwidth needs and extended battery life. Hologram is actively expanding via new roaming agreements. Check our [Hologram coverage page](https://www.hologram.io/coverage/) for the most up-to-date availability of Cat-M1 and NB-IoT in your area. **Note:** Carriers typically prioritize standard mobile data (e.g., 4G/5G) over low-power IoT technologies (like Cat-M or NB-IoT). In congested areas, they manage network resources by giving higher scheduling priority to regular smartphone traffic, which can temporarily limit bandwidth or response times for IoT connections. This approach ensures mainstream user experiences remain smooth while still accommodating IoT data within each cell’s capacity. # Contact support Source: https://docs.hologram.io/guides/get-started/contact-support Get in touch with our support team for detailed troubleshooting or specific requests. Reach out to our support team by emailing [support@hologram.io](mailto:support@hologram.io). This will create a new ticket, and replies will update the same email thread. ## What should I expect when I open a new ticket? When you email support, you'll first receive an automated reply from our AI assistant, **Holly Graham**. This message will: * Acknowledge your request * Suggest initial troubleshooting steps * Outline what information helps us investigate efficiently If you need a human right away, simply reply and request an escalation. Holly will hand the ticket to a Solutions Engineer. ## SLA and prioritized support If your organization requires guaranteed response and resolution times, or faster escalation paths, you can explore our [premium IoT support packages](https://www.hologram.io/premium-support/). ## AI chatbot You can also access our AI support chatbot directly through our documentation site, using the button in the lower-right corner. The chatbot can: * Answer common questions * Guide you through troubleshooting * Open a support ticket on your behalf if needed Any ticket opened through the chatbot will be routed to our Solutions Engineering team for review. **Note:** Hologram's support is handled via email. We no longer support submitting tickets through an online form. # Country and network coverage Source: https://docs.hologram.io/guides/get-started/country-and-network-coverage Hologram provides global coverage across 550+ networks in 190+ countries to connect your devices anywhere your fleets are deployed. You can find detailed coverage information on our [coverage page](https://www.hologram.io/coverage/). ## How can I customize coverage or network availability? Access to some networks requires custom data plans. If you would like more information or have questions about our coverage after reviewing our [coverage page](https://www.hologram.io/coverage/), please [contact one of our IoT experts](https://www.hologram.io/contact-sales/) for more information. ## How is coverage determined for a SIM? Coverage for a Hologram SIM is determined by a combination of the SIM's **data plan** and **enabled profile**. Each profile installed on your SIM has access to a different set of global carrier networks. A data plan provides access to a predefined list of networks, RATs, and countries that the SIM can connect to that provide the best combination of coverage and price avilable to your SIM. The enabled profile determines which combination of those networks are available to your SIM when it connects to the internet. With Outage Protection™ enabled, the SIM can switch to a backup profile if the primary profile loses connectivity extending the coverage available to your SIM. With this combination you can prefer access to a Tier-1 high-performance network on one profile, while still having global coverage as a backup on the other profile. ## How is Hologram's total network count defined? Coverage totals are based on the available mobile network operators (MNOs) we provide access to globally across commonly recognized countries. A single MNO like T-Mobile in the USA, for example, consists of many networks across the country. We count that as a single "network" for coverage purposes rather than listing each TADIG + MNC + MCC combination individually. Similarly, we provide access to additional territories and provinces but for clarity we only label UN-recognized countries. # Data metering Source: https://docs.hologram.io/guides/get-started/data-metering Usage information posted on the Dashboard comes directly from our carrier partners, all of whom are members of the GSM Association. They all use standard protocols and interfaces, and provide us with the information as reported from the gateway. This guide reviews how data metering at Hologram works with data sessions. ## Networking overhead Due to networking overhead, the bandwidth used by a device will be higher than the sum of bytes your application sends and receives. Each TCP packet (and therefore each Hologram Cloud message) incurs an **overhead of about 500-700 bytes**. This means that to reduce data charges, you should prefer fewer large messages over more small messages. Messages larger than about 2kB may be split into multiple packets, so this optimization is mainly relevant for very small messages. Also, keep in mind that higher-level protocols such as HTTP have their own headers which may inflate the per-message overhead. ## Inbound and outbound data Usage data includes both inbound and outbound traffic for a device. ## Data measurements Data usage at Hologram is tracked, stored, and billed in decimal (base 10) units, not in binary (base 2) units. 1 KB of data is always 1,000 bytes across all our systems, not 1,024 bytes. ## Data sessions Data usage is reported via **data sessions**, which are the periods of time when a device is connected to a network and transmitting data. Data usage is calculated at the **end of each closed data session**, at which time checks are made for data usage limits and transaction charges and sessions populate in data usage reports. Some checks like usage warnings are checked live during mid-session updates, but most are made at the end of the session. Information about data sessions is provided in **near-real-time**, as frequently as we receive it from carriers. Some carriers and networks provide intra-session data usage updates, some provide updates only at the end of the session, while others provide updates at the end of a block of time which we call a "reporting window". * **API data usage** is provided in near-real-time. * **Recent data usage** reports and last connection details in your dashboard are provided in near-real-time. * **Historical data usage** reports available to contracted accounts and larger organizations are updated every 60 minutes. * **USA-2** and **USA-1** profile data usage is reported only in reporting windows, every 120 minutes for US2 and every 6 hours for US1. ## Network activity monitoring tools Measure device traffic using standard tools: * `tshark`: [Wireshark tshark](https://www.wireshark.org/dashboard/man-pages/tshark.html) * `bmon`: [Bandwidth Monitor](https://github.com/tgraf/bmon) * `tcpdump`: [tcpdump](https://www.tcpdump.org/) If your device is using odd or unexpected amounts of data, please refer to our [guide on unexpected data usage](/guides/troubleshooting/unexpected-data-usage). ## Manage data usage in the Dashboard # Device certifications Source: https://docs.hologram.io/guides/get-started/device-certifications The device certification process ensures compliance with cellular network standards. Hologram requires your devices have at least a PTCRB or GCF certification. Hologram requires devices on our network to have at least a **[PTCRB](https://en.wikipedia.org/wiki/PTCRB)** or **[GCF](https://en.wikipedia.org/wiki/GCF)** certification. If a device is 4G, or Cat-M1 and will be deployed in the United States and plans to use Verizon's network it requires a **Verizon** certification. Hologram also highly recommends getting additional certifications, where applicable, for the carriers you plan on using while on our network. Common examples of these are **AT\&T's** certification. Having these certifications will ensure the best performance possible. **Note:** If you have any certification specific question please contact your local test house as they are best equipped to provide the most up to date and accurate answers. # Get started with Hologram and connect your devices Source: https://docs.hologram.io/guides/get-started/get-started-with-hologram The Hologram platform was designed to be hardware and device agnostic. As a general rule, all cellular products will work with Hologram SIMs unless they were specifically designed to only work with one carrier. Order some Hologram SIMs from our [store](https://store.hologram.io/) using the code **`FREEPILOTSIM`** to help you get connected.   If you have specific coverage or network availability requirements, please review our coverage guides. Reach out to our [sales team](https://www.hologram.io/contact-sales/) to discuss custom solutions.   Before you get connected for the first time, you'll need to activate your SIMs in your dashboard or using the REST API.   Follow a more detailed guide to configuring your device to use a Hologram SIM.   # Glossary of Hologram temininology Source: https://docs.hologram.io/guides/get-started/glossary Plain-language definitions of the terms you'll see across Hologram, including organizations, active SIMs, pre-deployment, monthly recurring charge (MRC), billing types, and the difference between a paused and a suspended SIM. ## Platform and account terms #### Hologram app and dashboard Hologram's IoT management portal at [dashboard.hologram.io](https://dashboard.hologram.io) where you manage SIMs, usage, billing, and users. When support refers to "your dashboard," this is the whole app — not a single page. The dashboard is divided into **sections** in the main menu, such as **SIMs**, **Usage**, **Billing**, and **Settings**. See the [dashboard overview](/dashboard/get-started). #### Organization The shared account for your company or team, and the single entity that owns SIMs and is billed. An organization is not a "workspace," "team," or "profile" — those aren't Hologram terms. One login can belong to more than one organization, and every user also has a personal organization by default. See [organization details](/dashboard/orgs-and-users/organization-overview). #### Account Your business "account" is represented by an **organization**. Billing, SIM management, data usage, and user management is performed at the organization level. Your **user account** is your personal login (name, email, password) managed in **Settings → My account**. API keys are associated with a user account. Your user account can be associated with multiple organizations. #### Owner The user who owns an organization and is its primary billing contact. Billing notifications are sent to the Owner's email address. See [billing email recipients](/dashboard/billing/billing-email-recipients). ## SIM state terms #### Active SIM Any SIM that able to use data and is registered on the Hologram network, including SIMs in a **Ready**, **Connected**, or **Paused** status. Active SIMs are charged a [monthly recurring charge (MRC)](/guides/billing/breakdown-of-billing-and-sim-charges) whether or not they used data in the current billing period. A SIM becomes active once it is activated. A SIM configured with **Test Mode** is not an active SIM until it exits testing. See [SIM states and statuses](/dashboard/sims/sim-states-and-statuses). #### Pre-deployment SIMs This is a blanket term for **all SIMs that have not yet been activated** and are not charged a monthly recurring charge (MRC) or for data usage. This includes Test Mode SIMs **In testing**, **Inactive**, and other SIMs that are in your inventory but are not yet Active. See [SIM states and statuses](/dashboard/sims/sim-states-and-statuses). #### Paused by user A SIM that a member of your organization manually paused. It cannot send or receive data or SMS until someone resumes it. This is reversible by your team at any time. See [pause or resume SIMs](/dashboard/sim-actions/pause-resume-sims). Paused SIMs are still charged a monthly recurring charge (MRC) until they are resumed to retain access to the Hologram network. For organizations with an active contract, these SIMs can qualify for zero-data rates if they use 0 B of data in a billing period. #### Paused by system A SIM the system paused automatically because of an insufficient account balance, reaching a data usage limit, reaching an SMS limit, or missing contractual payments. These SIMs resume automatically once the underlying cause is resolved. See [what causes the "Paused by system" status](/guides/troubleshooting/paused-by-system-sim-status). #### Suspended SIM The industry term for a "suspended" SIM isn't an exact match for how Hologram's billing works, as Hologram SIMs can operate across multiple mobile cores and profiles. When paused, SIMs are still charged a monthly recurring charge (MRC) unless it was due to missing account balances. Talk with our Sales team to see if you qualify for zero-data rates ("suspended rates") for SIMs that use 0 bytes of data in a billing period. #### Deactivated **Deactivation at Hologram is permanent and cannot be undone**. Deactivated SIMs are not charged a monthly recurring charge, unlike a paused SIM. This is different from how some other providers handle deactivation, which may be reversible. See [deactivate SIMs](/dashboard/sim-actions/deactivate-sims) for how to deactivate a SIM. #### In testing (Test Mode) Test Mode gives you free data and SMS usage to validate that a SIM can connect to a network before it activates and begins charging you. A SIM in testing auto-activates when the testing period ends, it uses 100 KB of data, or it sends 10 SMS messages. See [Test Mode](/guides/sims/test-mode). ## Billing terms #### Monthly recurring charge (MRC) The fixed monthly per-SIM charge that reserves your SIM's access to the network and the Hologram platform. It is billed on a 30-day cycle starting the day the SIM activates, and applies to every active SIM regardless of data usage — including paused SIMs. For **Included data** plans, the MRC also covers the plan's included data. For organizations with monthly invoicing, this charge is billied at the beginning of each calendar month instad. See [breakdown of billing and SIM charges](/guides/billing/breakdown-of-billing-and-sim-charges). #### Data usage rate The per-megabyte cost for data, billed by the kilobyte at the close of each session. On **Pay as you go** plans it applies to all usage; on **Included data** plans and **Data pools** it applies only to overage above the included amount. See [breakdown of billing and SIM charges](/guides/billing/breakdown-of-billing-and-sim-charges). #### Data usage limit A cap on the data a SIM can use in a billing period. When the SIM reaches it, data usage is paused (the SIM moves to **Paused by system**). Limits are checked at the *close of each data session*, not in real time, so a SIM can pause slightly before or after the exact number. Data usage limits are checked against the SIM's 30-day billing period that began on the day it was activated (making it an Active SIM), which may not align to billing periods for organizations with monthly invoicing. We recommend setting a **10 GB** limit for all SIMs. See [set data usage limits](/dashboard/sim-actions/set-usage-limits). #### Data warning threshold A per-SIM usage amount that creates an event when the SIM crosses it. Unlike a data usage limit, a warning threshold does **not** pause the SIM. A threshold of 0 B alerts at the first data usage of each billing period. Subscribe to the event with [alerts](/dashboard/event-monitoring/alerts-and-notifications). See [set data warning thresholds](/dashboard/sim-actions/set-data-warning-threshold). #### Billing period The 30-day cycle for a SIM's charges, beginning at the time and day that SIM was activated. This is per-SIM and is separate from the reporting windows in the **Usage** section. See [how billing works](/guides/billing/how-billing-works). #### Prepaid vs. postpaid billing Most organizations pay-as-you-go (**prepaid**) for all charges, and draw down from an account balance like a transit card, debit, or checking account. Contracted organizations can instead receive monthly invoices (**postpaid**). See [billing overview](/dashboard/billing/billing-overview). ## Reporting terms #### Recent vs. historical usage **Recent** data usage covers the last 90 days in near-real-time. **Historical** usage covers at least 365 days, updates every 60 minutes, and is available to contracted accounts and self-service accounts with over \$100 USD in monthly recurring charges. Data usage reporting is independent from a SIM's billing period. See [view and track fleet data usage](/dashboard/usage/usage-overview). #### Event A record of something that happened for a SIM. Events include messaging, IMEI changes, data limits reached, Conductor configuration changes, and more. Each event is tracked with event tags you can subscribe to with [alerts](/dashboard/event-monitoring/alerts-and-notifications) to receive **webhook or email notifications**. Per-SIM events appear on the [Events tab](/dashboard/sims/sim-details-events-tab); fleet-wide events appear in [event history](/dashboard/event-monitoring/event-history). Events are different from and do not include state changes like activation, deactivations, data plan changes, and SIM or profile state changes.   **Note:** Can't find a term? Is something in your dashboard not clear? [Contact our Support team](/guides/get-started/contact-support) and we'll point you in the direction. You can also send our Product team direct feedback in your dashboard using the **Support menu** at the top right of the page. # Network selection Source: https://docs.hologram.io/guides/get-started/network-selection Hologram SIMs are provisioned for permanent roaming and hold credentials for **550+ networks** across **190+ countries** ([read more](/guides/get-started/country-and-network-coverage)). Modem firmware scans and selects networks based on supported bands, signal conditions, and device logic. Traditionally, a modem connects to the strongest viable network. Availability varies by device bands, geography, tower traffic, and firmware. For firmware-specific behavior, consult your device manufacturer's documentation. Hologram Hyper SIMs with Outage Protection™ add resiliency by providing two independent connectivity profiles spanning 330+ global networks each. During an outage, your SIM can transition cores to minimize downtime. [Learn more about Outage Protection™](/guides/sims/outage-protection). ## Can I customize network selection using a Hologram SIM? Coverage on a SIM can be limited to specific networks via custom data plans and the profiles installed on your SIM. With Outage Protection enabled, the SIM can switch to a backup profile if the primary profile loses connectivity extending the coverage available to your SIM. With this combination you can prefer access to a Tier-1 high-performance network on one profile, while still having global coverage as a backup on the other profile. Hologram recommends steering connectivity to specific networks on your device, and using Forbidden Public Land Mobile Network (FPLMN) lists to avoid networks, and Operator Preferred Public Land Mobile Network (OPLMN) lists to prefer networks, updated on your SIM via AT terminal commands. # Set the device APN Source: https://docs.hologram.io/guides/get-started/set-the-device-apn Hologram SIMs are hardware-agnostic, and should work with any hardware that is not locked to a carrier. To use a Hologram SIM, set your device's APN to `hologram`. The APN allows your device to properly set up a connection to the gateway between Hologram and the Internet. ## How to set my device's APN To use a Hologram SIM for data, set your device's Access Point Name (APN) to `hologram`. The APN directs your connection through Hologram's gateway. With your device powered off, insert the Hologram SIM card into your device and power your device back on. Then, configure your device to use Hologram's Access Point Name (APN) to load the proper configuration. Most devices set APNs via SMS, firmware, a web UI, or code. Check your device documentation for exact steps. #### Hologram APN settings * **APN:** `hologram` * **APN username:** *none* * **APN password:** *none* * **IP address:** `Dynamic (using DHCP)` * **Data roaming:** `Enabled` Your specific device might not ask for all of this information and **no PIN is required**. **Important:** Setting the APN can vary drastically from device to device. These are generic guidelines, and it is best to reference your device's documentation or contact your device manufacturer for more specific instructions. ## Troubleshooting device APN configuration If you have any issues, please refer to your device's manual. In general, we see some regular methods for setting the APN: * **USB modems and routers** have their APN set via a web portal or an app that is pre-loaded into the device. * **Micro Controller Units** the APN is set via software or firmware. * **GPS devices (asset trackers)** need APN settings to be sent via SMS messages. * **Phones and tablets** are usually automatically set but can be manually set in the settings menu. ## Does Hologram offer custom APNs? Yes, custom APNs are available to contracted accounts. The `hologram` APN is already **private**, and typically this is of the time this is only done for a vanity APN to mask the `hologram` name from your customers. **Limited access:** You can request a custom APN by [contacting support](/guides/get-started/contact-support). ## Could a SIM require multiple APNs? Some connectivity profiles on Hologram SIMs may require APNs other than the default `hologram`. Additionally, some Multi-Core SIMs may require different APNs per profile. If the enabled profile changes through Outage Protection™ or manual profile changes, the device's APN may also need to change. In these cases, your device will need to be able to support automatic APN changes based on the enabled profile. ## Related guides # Set up your device to use a Hologram SIM Source: https://docs.hologram.io/guides/get-started/set-up-your-device-to-use-a-hologram-sim ## Is my device compatible with Hologram SIMs? **Yes!** The Hologram platform was designed to be hardware and device agnostic. As a general rule, all cellular products will work with Hologram SIMs unless they were specifically designed to only work with one carrier. With that in mind, there are some common factors you should consider. [This post outlines a few questions you should ask](https://www.hologram.io/blog/iot-device-hardware/) to ensure you make the right selection for your deployment. Consumer devices like phones are generally not supported by IoT SIMs without workarounds. Some Tier 1 carriers may require additional device certification. ## How can I check that my device is ready to connect? Even a widely accessible network requires getting third party devices hooked in and transmitting properly. This guide covers the basic steps needed to get your device working and some of the common pitfalls we have seen in the process. Before you insert a SIM card into your device, you'll need to activate it. You can activate SIMs in your Hologram dashboard, and [read more about the process here](/dashboard/activation/activation-overview). Activation can take up to 15 minutes, as information has to propagate across all our network, but is often much faster. If you find your SIM isn't active after 1 hour, contact [support@hologram.io](/guides/get-started/contact-support). Once your SIM is active, you will see it enter a Ready or Connected status in your dashboard. This means that your SIM is *live* on our global network!   This sounds straightforward, but is a common issue we hear when helping customers remotely and in person. First and foremost, look at your device's documentation and make sure you are using the correct SIM size. If not, start with the largest SIM size and work your way down. #### Additional tips * **SIM orientation matters!** Most devices will have a diagram showing you where the SIM's notch needs to go. Placing it differently will not work. * If your device doesn't have a diagram for SIM orientation, there may be a notch in the SIM holder. * If your device doesn't have either, make sure the SIM slot/holder's contacts are touching the SIM's contacts. * In rare cases, hardware may only support certain SIM thicknesses. Exact Hologram SIM hardware measurements are available [in our datasheets](/guides/sims/hologram-iot-sim-datasheets). Once your SIM has been inserted correctly, your device is ready to connect.   With an activated SIM card inserted, your device should be able to send and receive SMS messages without any additional setup. To send and receive data, however, you need to set the [APN](https://en.wikipedia.org/wiki/Access_Point_Name). This can be done in one of four ways: #### Automatically This usually occurs on mobile phones like iPhones and Android Phones. On larger embedded devices and more advanced modems, the manufacturers store large carrier APNs in memory. SIMs from larger carriers may already be included and Hologram is now included on many newer devices. #### Via SMS This usually applies to devices with no external input ports. We have seen this in cellular asset trackers, such as pet trackers. You can send SMS messages to your device using Hologram's Dashboard, information on that can be found [here](https://hologram.io/docs/guide/cloud/message-to-device/#send-a-message). #### Via software This usually applies to USB Modems and Routers. We have seen this in Huawei USB Modems like the MS2372 and Cradle Point's COR Series Routers. #### Via code This is common for development boards like Adafruit's Fona boards, Arduino's MKR, and PyComm boards. ### Hologram APN settings * **APN:** `hologram` * **APN username:** *none* * **APN password:** *none* * **IP address:** `Dynamic (using DHCP)` * **Data roaming:** `Enabled` Your specific device might not ask for all of this information and **no PIN is required**. **Important:** Setting the APN can vary drastically from device to device. These are generic guidelines, and it is best to reference your device's documentation or contact your device manufacturer for more specific instructions.   **Important:** Without the correct APN added and data roaming enabled, your device will not be able to establish a network connection.   ## Troubleshooting configuration issues Since most devices work with Hologram SIMs it's best you refer to your device manual or device manufacturer for specific information such as AT commands, settings, or other configuration information. # SIM connectivity overview Source: https://docs.hologram.io/guides/get-started/sim-connectivity-overview ## How does my device connect using a Hologram SIM? **Your device** connects to the internet through a **Hologram SIM** using the device's modem. Each Hologram SIM supports **multiple mobile cores**, which we display as connectivity **profiles**. A profile lets your device connect to the internet through a specific set of networks and countries as defined by the SIM's **data plan**. SIM connectivity overview SIM connectivity overview ## SIM status lifecycle Hologram SIMs move through three categories of statuses and states: **Pre-deployment SIMs**, **Active SIMs**, and **Deactivated SIMs**. See [SIM states and statuses](/dashboard/sims/sim-states-and-statuses) for a full list of statuses and states. **Pre-deployment SIMs** is our term for SIMs that have **not activated** and are **not charged a monthly recurring charge (MRC)**. This includes Test Mode SIMs and statuses like "In testing" and "Inactive". **Active SIMs** are the SIMs that **can use and are billed for data usage** and are charged a [monthly recurring charge (MRC)](/guides/billing/breakdown-of-billing-and-sim-charges). A SIM becomes "Active" as soon as it is activated and is registered on the Hologram network. This includes SIMs in **Ready**, **Connected**, or **Paused** statuses. Active SIMs are charged a MRC whether or not they used data in the current billing period. A SIM configured with Test Mode is *not an active SIM* until it exits testing. **Deactivated SIMs** are SIMs that have been **permanently deactivated** and **cannot be reactivated**. ## Device information Hologram stores minimal information about your device, which we identify using the **device ID**. However, we don't store device information and this is effectively 1:1 with a SIM. We receive basic information from networks about your device during data sessions. This includes the IMEI used to connect to a data session, which also lets us identify the the modem model when we have it using the IMEI TAC prefix. **IMEI data is not sent by networks or carriers in every data session**, so we default to showing the **last known IMEI** for your device. Your device must have the [correct APN set](/guides/get-started/set-the-device-apn) to connect to the internet. Hologram's default APN is **`hologram`**. ## SIM information Hologram Hyper IoT SIMs are identified by the **SIM ID**, which is Hologram's unique identifier for a SIM card. Each SIM card connects to the internet through a connectivity **profile**. Most of our SIMs have a single installed profile. SIMs can have multiple profiles installed, and SIMs can switch between profiles on-demand using Outage Protection™ (if enabled) to prevent downtime and outages for your devices. However, only one profile can be active at a time, and the **enabled profile ICCID** is the ICCID of the profile currently active and able to use data. We call these SIMs "Multi-Core Hyper SIMs". This provides more resilience and redundancy than a multi-IMSI solution, which operates within a single profile / mobile core. Hologram primarily stores and reports on information at the SIM level, not at the device level. ## Profile information A connectivity **profile** is a carrier-defined mobile core, with its own network settings that define how a SIM card connects to the internet. The enabled profile determines the network connectivity available to your device through a SIM when it connects to the internet. The data plan added to your SIM defines which countries and networks each profile can connect to, defining the coverage available to your device. Each profile is identified by the **ICCID** as well as Hologram's unique **profile ID** (also known as the **link ID** in our v1 API). Each profile also has a unique MSISDN and IMSI. Profiles can be installed on a SIM using over-the-air (OTA) eUICC updates. If a SIM has multiple installed profiles, which we refer to as "Multi-Core SIMs", they can switch automatically through fallback events if the primary profile loses connectivity through our Outage Protection functionality, or can be switched manually. ### Profile names Each profile has a name, which can be used to identify the profile in your dashboard and identify expected connectivity behavior. | Profile name | Profile short name | Description | | - | - | - | | **Global-3** | G3 | **Our default global profile.** SIMs purchased from the [Hologram Store](https://www.hologram.io/store) come with this profile installed by default. | | **Global-2**
**Global-1** | G2
G1 | Additional global profiles available to customers with an active contract that work with our Sales team. | | **USA-2** | US2 | Tier-1 USA-only performance profile available to customers with an active contract that work with our Sales team. These profiles are either Cat 1+ or Cat M1 capable, identified based on your modem type. | | **USA-1** | US1 | USA-only profile. | | **Canada-1** | CA1 | Tier-1 Canada-only performance profile available to customers with an active contract that work with our Sales team. | ## Hologram connectivity identifiers and terminology ### Profile identifiers and terminology | Term | Definition | | - | - | | **Profile (Link) ID** | Hologram's unique identifier for a profile. | | **APN** | The Access Point Name identifies Hologram as the service provider when a profile connects to the internet. APNs are per-profile, and in rare cases can vary between profiles. | | **ICCID** | The Integrated Circuit Card Identifier is the unique identifier for a profile on a SIM card. | | **Enabled profile ICCID** | The ICCID of the profile that is currently active and able to use data. The enabled ICCID changes when profiles switch on multi-core SIMs. | | **Manufactured profile ICCID** | The ICCID of a profile installed on a SIM at the time of manufacture. The enabled manufactured profile ICCID is printed on Hologram triple-cut 1FF and 4FF SIM cards and embedded MFF2 SIM cards. These were formerly labeled as "bootstrap" and "operational" profiles. | | **IMSI** | The International Mobile Subscriber Identity is a unique identifier for a profile. IMSIs can be retrieved using our REST API. | | **MSISDN** | The Mobile Subscriber ISDN Number is a unique identifier for a profile which acts as the SIM's phone number. The enabled profile MSISDN changes when profiles switch on multi-core SIMs. | ### SIM identifiers and terminology | Term | Definition | | - | - | | **SIM ID** | Hologram's unique, primary identifier for a SIM card. | | **SKU** | The product SKU for the SIM hardware. Displayed on the SIM and device tab, and in the Activation and Change Plan workflows. | | **EID** | The eUICC Identifier is a unique identifier for a SIM card. | | **Coverage** | The list of networks, RATs, and countries that a SIM can connect to through a specific profile. Coverage is determined by the SIM's enabled profile, and is defined by a data plan. | | **Data Plan** | A data plan defines the rates and coverage available to a SIM through its installed profiles. | ### Device identifiers and terminology | Term | Definition | | - | - | | **Device ID** | Hologram's unique identifier for a customer device. | | **IMEI** | The International Mobile Equipment Identity is a 15-digit unique identifier for a device. | | **IMEI TAC** | The Type Allocation Code (TAC) is the prefix of the IMEI, which represents the type of modem. | | **Last known IMEI** | The last known IMEI Hologram has received for a device from a data session. | ### Outage Protection™ terminology | Term | Definition | | - | - | | **Outage Protection** | Outage Protection allows a multi-core Hyper SIM to switch to a backup profile if the primary profile loses connectivity. | | **Fallback event** | A network disconnection event that causes a SIM to switch to a backup profile if the enabled profile loses connectivity. Available on multi-core SIMs with Outage Protection enabled. | | **Fallback timer** | The amount of time a SIM will wait before switching to a backup profile if the enabled profile loses connectivity. Default is 15 minutes. Available on multi-core SIMs with Outage Protection enabled. | ## Related guides # The ultimate guide to IoT security Source: https://docs.hologram.io/guides/get-started/the-ultimate-guide-to-iot-security This article will provide an overview to all things IoT security and provide a jumping off point for further discovery. For any and all security-related questions, reach out to the Hologram support team! ## What is IoT security? By its nature, [IoT](https://www.hologram.io/blog/the-ultimate-guide-to-the-internet-of-things/) opens up networks to the possibility of hacking. That's because it involves connecting many objects or “things” to the internet that did not previously link to a network. For example, manufacturing companies connect IoT sensors to machinery on the factory floor, while homeowners purchase smart home devices such as thermostats, doorbell cameras, and light switches. With the innovation comes new [vulnerability](https://www.hologram.io/blog/iot-security-vulnerabilities/). Each connected thing, whether it's a temperature sensor buried underground or a fitness watch, adds a doorway through which hackers could enter—and potentially bring down entire networks. IoT security seeks to protect devices and networks, addressing the specific issues inherent to IoT deployments. ## Why is IoT security essential? Security is a point of pain for many IoT leaders. It's complicated and overwhelming to secure so many devices and interconnected systems—and the statistics aren't very encouraging. [IoT attacks grew by 600 percent between 2016 and 2017, and 48 percent of businesses can't detect if their IoT devices suffered a breach.](https://behrtech.com/blog/infographic-10-must-know-iot-cybersecurity-stats/) Yet IoT security is essential if organizations want to safely realize the power of a connected world. Here's why: ### Data is very valuable—and worth protecting. In many ways, data is the currency of our day. Organizations collect, store, and analyze tremendous amounts of information, using it to keep daily operations running smoothly and harvesting insights to make decisions. With so much at stake, cyberattacks can be devastating. For example, if a hacker penetrates a manufacturing company's system and erases their predictive maintenance and productivity data, the company may be forced to halt production and struggle to find their way forward. ### IoT security vulnerabilities undermine its success. If IoT devices and networks are vulnerable to attack, they are of little use to an organization. Once the data is compromised or a hacker shuts down the network, the advantages are negated. Imagine if an agricultural grower sets up an IoT deployment to monitor plant growth, soil temperature and moisture, only to have the system crash when hackers discover and exploit a vulnerability. The grower has come to rely on IoT data to make decisions—and now that data has disappeared. ### Cyberattacks on IoT devices can lead to compromised privacy and even physical injury. Because IoT devices track many kinds of information, access to that width and breadth of data can give hackers unprecedented power. For example, if bad actors break into a network of connected cars, they could take control of the vehicles while passengers are inside—resulting in their injury or death. Cyberthreats against health IoT devices such as pacemakers are another example of serious security risks. The more personal information is collected and stored on digital devices, the more risk there is for organizations and consumers alike. ## How should we approach IoT security? Here's some good news about IoT security risks: history repeats itself. While the details of cybersecurity attacks change from day to day, they're often rehashes of the same incidents that have been occurring since the birth of the internet in the 1990s. ‍ The most effective approach to IoT security starts with taking a close look at the history of cyberattacks and security vulnerabilities across the computer network landscape, identifying the recurring themes, and creating a built-in IoT security plan for your deployment that addresses each common area of vulnerability. Let's start by taking a closer look at a few IoT security breaches and hacks. ### Examples of IoT security breaches and hacks Because IoT hacks can happen to any type of connected thing, instances of security breaches include the unexpected and the bizarre. #### **BABY MONITORS** Baby monitors have gone from being simple radio transmitters to sophisticated video devices connected to the internet via WiFi. These features enable parents to keep watch over a sleeping child from their smartphone, but they also create an open door for hackers. In 2018, parents of a four-month-old baby in Texas heard [a stranger's voice over their video monitor, threatening to kidnap their baby](https://sanfrancisco.cbslocal.com/2018/12/18/man-hacks-wifi-camera-network-threatens-to-kidnap-baby/). Once they realized it was a hacker and not someone in their home, they disconnected the device and called the police. These types of hacks are not difficult for bad actors to instigate if device users rely on default passwords. #### ![A smart baby monitor camera sits on a table next to a child's toy](https://assets-global.website-files.com/5d08fdb5b1cfe22ec38a91d8/5fac4c1f16ae5243e6172034_iStock-1147302636%20\(1\).jpg) #### **CONNECTED CARS** In 2015, [two hackers remotely took control of a Jeep Cherokee](https://www.wired.com/2015/07/hackers-remotely-kill-jeep-highway/) using vulnerabilities in the car's entertainment system to access its dashboard functions. The two hacker-researchers commandeered the car while a journalist was behind the wheel, initiating a series of unexpected disturbances and finally disabling the brakes, causing the driver to swerve into a ditch. The experiment demonstrates just how serious IoT security vulnerabilities can be. #### **POINT OF SALE (POS) SYSTEMS** In 2014, hackers used [login information from an HVAC company to break into Target's POS system](https://www.computerworld.com/article/2487425/target-breach-happened-because-of-a-basic-network-segmentation-error.html). The HVAC company had login credentials with the retailer to carry out remote monitoring tasks, evaluating and adjusting energy consumption at retail stores. Once the hackers were into Target's network, they uploaded malware to the POS systems and stole data from 40 million debit and credit cards in the U.S., Brazil, and Russia. #### **THERMOSTATS** There have been a number of hacks to connected thermostats over the past few years, typically due to weak or compromised passwords. In 2016, [hackers broke into the heating system](https://www.ibtimes.co.uk/hackers-leave-finnish-residents-cold-after-ddos-attack-knocks-out-heating-systems-1590639) at a pair of apartment buildings in southeast Finland, introducing a denial of service (DDoS) attack that disabled the heating system for nearly a week. And in 2019,[a hacker broke into a Wisconsin couple's smart home](https://www.newsweek.com/google-nest-hack-milwaukee-1460806), turned the thermostat up to 90 degrees, and spoke to them through a camera in their kitchen. A woman changes the temperature on her smart thermostat ## How does your IoT security program measure up? An IoT cyberattack can happen anywhere, to any kind of connected device. It's essential to look at every network element and every piece of hardware as a potential entry point—and act aggressively to protect those doorways. ‍ Every successful IoT security program must address four basic areas. Before you do anything else, take a moment to assess the state of your organization's IoT security protocol using this checklist. ### How does your IoT security program address: #### **INTERNAL THREATS?** (How do you ensure vendor alignment? What measures are in place to detect hidden malware and monitor logging practices? How do you detect internal bad actors?) #### **EXTERNAL THREATS?** (How does your organization safeguard against external hackers who may spread malware and perpetrate ransomware attacks?) #### **PRIVACY?** (Is encryption effective? Is your network private?) #### COMPLIANCE? (Which regulations are you subject to? How do you ensure compliance?) ### If your responses were vague or incomplete, you're not alone. Cybersecurity is one of the major thorns in the side of IoT at the moment. As more devices, vendors, and networks become involved, ensuring security becomes increasingly complicated. But if you think critically and make sure you're paying attention to each major area of concern, IoT security is quite achievable. ## What are the biggest concerns for IoT security? Let's take a closer look at these four main areas of concern for IoT security. A man and woman ### Internal threats The phrase “internal cyber threats” conjures up images of malicious employees who intentionally leak sensitive information. But while it's important to safeguard against bad actors, the vast majority of internal threats in IoT networks come from ignorance or negligence about best practices. Here are a few essential areas to focus on when you're creating or refining IoT security policies: #### **VENDOR ALIGNMENT** One weakness of IoT security occurs when organizations unite hardware and software elements from different vendors who may not be working together to achieve optimum security. For example, a connected car manufacturer may have a vendor deep inside their system who's not worrying about security because they make a vehicle part that's normally not connected to the internet. When connected, that part becomes a security risk. Ultimately, the weakest link in your chain of vendors becomes a potential entry point for hackers. To offset that risk, work toward vendor alignment: look for vendors who share your security standards and ensure that every connection point in your hardware and software chain is secured. #### **INTRUSION DETECTION SYSTEMS** A software application or device that monitors your network for suspicious activity, an intrusion detection system is an essential step toward safeguarding against internal (and external) cyber threats. Intrusion detection systems may use signature-based detection to find malware or other bad patterns, or anomaly-based detection to highlight diversions from normal activity. #### **EMPLOYEE ADHERENCE TO CYBERSECURITY BEST PRACTICES** Making sure employees are well-versed in cybersecurity best practices should be an ongoing effort in any organization, especially those utilizing or designing IoT devices. Because the threat landscape is always changing, it's important to schedule frequent check-ins to keep teams in the loop. #### **CHANGE MANAGEMENT** A good change management system requires approval and record-keeping to prevent unauthorized changes from occurring. Change management reduces the risk caused by the human element, which can include errors as well as social engineering. It creates a standard process that all personnel must follow strictly for any changes to network access control or device management. #### **PRINCIPLE OF LEAST PRIVILEGE** An IoT device on your network shouldn't have access to other devices on your network by default, because those unnecessary links create additional attack surfaces. Enforcing the Principle of Least Privilege helps to restrict access between devices. Role-based control, a tool within some [IoT platforms](https://www.hologram.io/blog/iot-platform-overview/) that allows you to restrict network and account access depending on the person's role, is another helpful security precaution for any company developing or deploying IoT. ### External threats Threats from outside your immediate IoT network can come from anywhere, in any number of forms. There's no way to anticipate every possible threat, but there are things you can do to ensure network security and make it very difficult for a bad actor to break in. #### **SECURING BACKDOORS AND OPEN PORTS** Oversights such as backdoors and open ports can lead to serious cyberthreats. To the best of your organization's ability, eliminate these open doors and utilize network monitoring, anti-malware solutions, and/or multiple firewalls as added layers of protection. #### **FIREWALLS** In IoT security, firewalls are essential—and should come in several layers. Network operators should implement multiple firewalls to detect and log anomalous traffic and unexpected port access attempts. Set up your system to trigger alerts so you'll be notified immediately if something is amiss. #### **PASSWORD MANAGEMENT** Everyone knows it's important to use strong passwords and change them regularly—but many organizations still struggle to stay up-to-date on this key element of security. Some IoT devices come pre-loaded with default passwords set by the manufacturer, creating an open door for hackers to penetrate the network. If your devices operate with traditional passwords, change them often or consider using an automated password management system. Today's cellular IoT devices may also use authentication as an additional layer of security, such as Hologram's [multi-factor authentication for connected devices.](https://www.hologram.io/blog/announcing-multi-factor-authentication-for-iot-and-global-dash-cellular-board/) #### **DISASTER RECOVERY PLAN AND DATA BACKUP** Backing up your systems is a given, but with the amount of data gathered in today's organizations, it can be an overwhelming task. Even if data is backed up, you need to make sure you can restore it quickly—so you can avoid costly network downtime. These details should be worked out in a disaster recovery plan (DRP), an essential roadmap to the policies and procedures your organization will use to cope with a physical disaster or large-scale cyberattack. Laptop with memo sticks on the screen. ### Privacy Whether your IoT devices measure moisture levels in the soil or the heart rates of cardiac patients, the data they gather must be kept within prescribed boundaries of privacy. Data privacy means safeguarding information on its entire path from creation to processing—in the case of IoT, from the edge to the cloud and beyond—to ensure that third parties cannot gain access to it without authorization. #### **DATA PRIVACY POLICY** If your organization handles client or consumer information, it's important to establish a data privacy policy to set the groundwork for how you will handle regulatory compliance and safeguard the data that passes through your network of IoT devices. Based on the policy, you can create a data privacy statement to share with clients. #### **PRIVATE IPs** A private IP is part of a private network, meaning that an internet destination cannot send traffic to it directly. The firewall intercepts the traffic and makes decisions on whether it goes through or not. Using private IP addresses (made possible when firewalls are in place) provides another layer of protection for your IoT devices. #### **SECURE TUNNELING** Secure tunneling solutions (such as [Hologram Spacebridge](/guides/communication/establish-a-secure-spacebridge-tunnel-to-a-device-using-ssh)) allow you to tunnel into the security domain associated with your own devices. By creating a secure, authenticated tunnel, you can send inbound traffic to any port on an IoT device. Essentially, a tunnel is a closely guarded gate that lets you in to where you need to go.\` #### **ENCRYPTION** Encrypting data is a given for cybersecurity, but in the world of IoT, it's not always end-to-end. That's because IoT data often passes through different systems and software as it traverses the path from edge to cloud—making it harder to ensure constant encryption. Some companies are working toward [open-source solutions that are compatible across platforms](https://www.wired.com/story/e4-iot-encryption/), but they're still in development. With this awareness, work toward a solution that guarantees encryption for your IoT data, both in transit and at rest. ### Compliance Depending on your industry and location, IoT devices and computer networks will need to comply with a checklist of regulations created by a governing body. But while essential, regulatory compliance does not always add up to IoT security. They are different goals, and need to be approached differently. #### **COMPLIANCE DOES NOT EQUATE SECURITY** Depending on your industry and location, IoT devices and computer networks will need to comply with a checklist of regulations created by a governing body. But while essential, regulatory compliance does not always add up to IoT security. They are different goals, and need to be approached differently. #### **KNOW THE REQUIREMENTS AND DEMONSTRATE COMPLIANCE** While there's no single federal law governing data privacy in the U.S., [many states have passed their own.](https://www.varonis.com/blog/us-privacy-laws/#:~:text=EU%20vs.-,US%20Privacy%20Laws,alone%20a%20data%20security%20law.\&text=In%20brief%2C%20both%20the%20CCPA,of%20processing%20at%20any%20time.) Ensure that you're familiar with the government regulations and industry standards that apply to your organization, and have systems in place that can detect and demonstrate compliance. (For example, data protection services often generate periodic reports on regulatory compliance.) #### **KEEP UP WITH CHANGES AND UPDATES** Local, state, and federal laws are always being added, along with additional requirements from governing bodies within industries. It's essential to stay ahead of new regulations, so set up a system and regular meetings to review and plan for approaching changes. ## How do you test IoT security? Once you've evaluated your IoT security program and made changes to strengthen it, how can you ensure that your approach is working? Using standard cybersecurity testing methods, your team or a third party can evaluate the strength of your IoT security. Here's how: ### Penetration testing Commonly used to test traditional computer networks, penetration testing can also identify vulnerabilities in an IoT network—but the process may be complicated. IoT devices and networks use a wide variety of architectures (SuperH, MIPS, or ARM, for example) and communication protocols (such as BLE, Zigbee, SDR, and Sigfox), which penetration testers must be familiar with. There are many moving parts in an IoT deployment, and it's easy to miss potential points of vulnerability, so you might consider hiring a third party that specializes in IoT security testing. ### Device hardware analysis Analyzing and testing device hardware is another essential component to evaluating your IoT security. These penetration tests look at internal communications protocols such as UART, 12C, and SPI; check for open ports; experiment with the results of tampering; and carry out JTAG debugging. ### Threat modeling Threat models analyze applications to identify vulnerabilities and call attention to them. For IoT devices and networks, threat modeling provides a clear evaluation of the whole picture and highlights the possibility for specific incidents such as WiFi jamming, device hijacking, or the introduction of targeted malware. ## The future of IoT security The future of IoT depends on its security. As device and networking technology evolves, so will security safeguards and standards. Several organizations, [including the IoT Security Foundation and GSMA](https://www.ncipher.com/faq/internet-things-iot/are-there-security-guidelines-for-the-iot), have already developed sets of security best practices and guidelines for IoT. Until there are overarching standards for IoT security, organizations and developers need to be extra vigilant about building security into devices and networks, staying up-to-date on the latest threats, and continuing to test and evaluate their approach to security. # The ultimate guide to the Internet of Things Source: https://docs.hologram.io/guides/get-started/ultimate-guide-to-iot A comprehensive introduction to IoT technology, applications, and best practices An autonomous delivery vehicle in California encounters an unfamiliar obstacle and can't proceed. An alarm goes off in the delivery company's Nevada office, where a human takes over the remote controls and steers it to safety. A temperature sensor on a truck transporting refrigerated foods sends an alert that it's getting too warm inside the trailer. At the company's headquarters, a fleet manager receives the alert, notifies the driver, and arranges for a maintenance stop. A farmer looks at a wristwatch and sees that the moisture level in the soybean field has dipped too low — so she opens an app and taps a button to turn on the irrigation equipment. These scenarios might sound like science fiction, but they're becoming reality thanks to a growing global network called the Internet of Things (IoT). The value of IoT lies in its ability to make tasks easier and extract valuable data. While the flashy IoT applications get attention, some of the simplest data exchanges yield the most value to businesses. And as wireless infrastructure continues to expand and more connected devices come online, companies in all sectors will benefit from incorporating IoT. ## What is IoT? While the details get complicated, the overall concept of IoT is pretty straightforward: it's technology in the environment around us interacting with other technology and with us, creating a "smart" environment. The elements of the IoT ecosystem fall into three categories or layers: ### Hardware These are the physical devices and products in the home or field that sense, collect, route, and actuate upon the data they receive. IoT hardware includes sensors and other endpoint devices, along with traffic and data management hardware like gateways, routers, and servers. ### Firmware The software that comes on an IoT device and allows it to send, receive, and process data. Firmware can also control the physical device or direct it to do something. Just about every connected device includes firmware, from endpoint sensors to gateways and servers. ### Connectivity This final layer of IoT is essential—it's how the "things" talk to each other and stream data to a server or the cloud. Connectivity encompasses a variety of networking options such as Wi-Fi, Bluetooth, and cellular, each suited to particular use cases. Now that we've established a big picture view of IoT, let's zoom in on some examples that illustrate how it looks in action. ## The History of IoT The term "Internet of Things" emerged in 1999, but the idea it describes stretches back much further in time. When telegraphs and landline telephones were invented in the mid-1800s, some forward-thinking inventors envisioned a world where machines could talk to each other. The evolution of the internet created an environment where those visions could become reality. In the early 1980s, computer programmers at Carnegie Mellon University connected a Coca-Cola machine to the internet, allowing them to check its inventory online before heading down to buy a drink. It would be years before such applications of machine-to-machine (M2M) connectivity became common, but the idea had taken root. By the 2010s, IoT had grown to embrace multiple technologies and communication protocols, and to serve many needs of industries and consumers alike. ## The Benefits of IoT Sure, IoT technology is cool, but what are the benefits—specifically for businesses? Let's take a look at some of the advantages of incorporating IoT devices. ### Cost savings IoT applications allow businesses to keep a closer eye on their assets and processes, leading to significant increases in efficiency and cost savings. One example is predictive maintenance—when IoT sensors are attached to machinery, businesses can use the gathered data to predict when the equipment will need to be serviced. Intervening with repairs before the machine breaks down can help to limit downtime and extend the overall lifecycle of the equipment. ### Improved customer experience Until recently, most companies used IoT for internal process and asset monitoring, but now many are finding ways to relay the advantages of IoT to consumers. For example, IoT sensors in retail stores can help ensure that shelves remain fully stocked. Connected security cameras monitor happenings in the store and notify managers immediately if there's an incident such as a customer slipping and falling. Some stores are incorporating [robots](https://hbr.org/2020/10/what-robots-can-do-for-retail) for customer service, while many others are using IoT to improve remote customer experiences with smartphone apps, chatbots, and other tools. ### Increased efficiency and productivity IoT sensors allow companies to gather data about their operations, workflows, personnel, and equipment. When this big data is analyzed, it helps to paint a clearer picture of what's working and what's not, enabling business leaders to make better decisions and increase operating efficiencies. IoT technology also provides tools to enable automation of repetitive tasks, meaning that personnel are freed up to focus on big-picture goals. For example, a project manager might spend five hours a week entering data in a spreadsheet. If that task can be automated through the use of IoT sensors, the manager will gain back that time for more productive work. ### Better supply chain management Incorporating IoT sensors in the supply chain is yielding greater visibility and control, allowing companies to see where their assets are, the conditions they are stored in, and how soon they can be expected to progress along a transportation route. Sensors used in supply chain management typically incorporate GPS technology and may take the form of RFID chips or more complex mobile devices. ## Companies Investing in IoT Many high-profile companies are investing in IoT. Whether they provide IoT-related products or use the technology to optimize their own operations (or often, both), these leaders in IoT are worth keeping an eye on. ### Amazon Amazon has been a leader in using IoT to optimize its own activities and offer smart home products to consumers. The company's Dash Buttons are small devices emblazoned with logos of frequently ordered products (such as laundry soap) that consumer can place around their home. When they push the button on the device, an order is placed for that product. Smart speakers have become the most ubiquitous smart home IoT device, and Amazon's Echo and Alexa are both leaders in the field. Beyond its IoT-based consumer products, Amazon also uses IoT devices to streamline its operations, from shipping to warehouse management. The company's popular subsidiary, Amazon Web Services (AWS), provides cloud computing platforms for businesses, governments, and individuals using an on-demand, pay-as-you-go model. ### Microsoft Personal computing giant Microsoft introduced its popular cloud computing platform, Azure, in 2008. Since then, it's moved toward enabling IoT, investing \$5 billion in the technology in 2018 and working with customers to develop IoT and cloud solutions. Azure now offers many IoT management services and a number of large companies (Starbucks, Walmart, and Volkswagen, to name a few) are using it to power their IoT deployments. ### General Electric (GE) GE has long been an innovator in IoT technologies, creating digital solutions for power plants, hospitals, and factories. Now a leader in Industrial IoT (IIoT), GE has its own IIoT platform, Predix, and analytics services to help industrial clients leverage IoT in manufacturing facilities. ### Cisco Cisco is a strong leader in IoT innovation, with a focus on IIoT solutions. Cisco Systems provides hardware to build the networking infrastructure that supports IoT. The behemoth company has acquired a number of IoT and SaaS companies over the past several years, widening the breadth of their IoT services and capabilities to include connectivity management, edge computing, network connectivity, and data control and exchange. ### Google Google has also invested significant funding and energy in IoT solutions. Its fully managed Cloud IoT Core platform lets customers connect, manage, and aggregate data from fleets of IoT devices around the globe. Google's IoT platform integrates easily with its other services, such as Google Cloud data analytics and its data science and machine learning platform. ## IoT Examples When the subject of IoT comes up, many people envision sentient robots smart enough to hold intelligent conversations, solve complex problems, and perhaps even take over the world. In reality, most IoT applications are far from sensational—yet still extremely useful. "For many businesses, there can be untold value in simply measuring how full a tank is without having to send someone to check. The ability to access just one new data point can be a game-changer." — Ryan Lee, director of product management at Hologram While many IoT applications are simple, there's still a place for more complex use cases. The massive field of connected objects includes a wide spectrum of what is considered IoT and which data speeds are required. At the simpler end of that spectrum, some IoT devices are sensors that only measure one thing—like how full a tank is—and send back small amounts of data. At their most complex, IoT devices stream video and other high-bandwidth content and may include edge analytics and AI capabilities. ### IoT Devices Endpoint devices are the lifeblood of IoT. They're the multitude of data gatherers on the ground, collecting information that's sent back to a central location for review and analysis. While devices serve a similar overarching purpose of providing some type of insight, they can take a wide range of forms: ### Consumer devices Smart home devices include connected refrigerators, thermostats, lights, and even lawnmowers. Smart toys have emerged as another IoT subcategory, and wearables such as wristband fitness monitors remain widely popular. ### Healthcare monitors [Connected monitors](https://www.hologram.io/blog/healthcare-iot) are becoming a key component of telehealth services. Connected sensors can be installed in monitors to keep track of a patient's blood pressure, blood sugar, heart rate and oxygen levels at home. Physicians receive the data and can make recommendations based on what it reveals. ### Agricultural sensors [Smart farming](https://www.hologram.io/blog/smart-farming-6-ways-to-use-iot-in-agriculture) is revolutionizing business models for agriculture operations around the world. Farmers use sensors to track livestock, monitor weather conditions, and keep track of moisture in the soil. ### Automotive IoT [Autonomous vehicles](https://www.hologram.io/blog/what-are-self-driving-cars) might come to mind, but this category also includes connected cars. Nearly all-new automobiles now include an onboard computer with navigation, predictive maintenance, and safety capabilities. ### Micromobility Fleets of connected, rentable, short-range vehicles such as scooters or bicycles are ideal for navigating urban areas. [Micromobility](https://www.hologram.io/blog/what-is-micromobility) is a great example of IoT creating new business opportunities—managing rented vehicles remotely saves businesses both time and costs. ### Autonomous robots Blending the task-oriented nature of robotics with the data-gathering power of IoT, [robots](https://www.hologram.io/stories/bossa-nova) are complex devices that can interact with the connected objects around them and make decisions based on artificial intelligence. ### Logistics and fleet management Many companies around the world are [installing connected sensors](https://www.hologram.io/blog-category/case-study) in their vehicles and shipping containers to track their progress and stay informed about maintenance issues or emergencies. ### Industrial IoT When enterprises incorporate IoT devices in their factories, machinery, and supply chains, they take the power of connectivity to a new level called the [industrial IoT (IIoT)](https://www.hologram.io/blog/what-is-iiot), also known as Industry 4.0. Real-time sensor data offers [many benefits](https://www.hologram.io/blog/6-ways-industrial-iot-can-benefit-modern-operations) to modern operations, including insights to make better decisions. IIoT covers a range of technological advancements in addition to sensors, including artificial intelligence, machine-to-machine communications, and cloud technology. Taken together, modernized operations can: **Increase safety and efficiency** on the factory floor, in mines and offshore rigs. As companies monitor their operations more closely, they're able to make better management decisions. **Detect supply chain problems** such as over and under-supply using [asset tracking](https://www.hologram.io/blog/what-is-cellular-asset-tracking) and notify management teams so they can cope with the issue before it becomes widespread. **Monitor the technical health of machines,** sending out alerts to managers when a machine malfunctions or is in need of preventive maintenance. ## IoT in Action Let's consider some applications of IoT technology across sectors—and the connectivity that enables it to succeed. ### IIoT Amper provides hardware and software for end-to-end machine monitoring in industrial use cases. Polymer manufacturer SNF worked with Amper to completely transform their maintenance processes. The technology enables SNF to track production hours and energy usage to ensure that machines operate at peak efficiency. "We have reduced our maintenance costs and improved the overall efficiency of our machines. Amper has given us greater transparency in our maintenance data, allowing us to spread around talent and do more with less." — Jim Organ, SNF Plant Manager ### Smart Agriculture [Arable](https://www.arable.com/)'s smart agricultural sensors gather real-time data on climate, weather, crop health, and yields. The company wanted to launch in 14 different countries and expand to many others, but Wi-Fi in rural areas is nonexistent, and there were too many cell contracts to negotiate to cover all the areas they needed their devices to work in. With Hologram, Arable was able to launch their agricultural monitoring device across a multi-country region with one SIM model and contract. "The tools that Hologram gives you to keep track of data and fleets are amazing. It was especially useful for devices when they're outside of the U.S." — Jove, head of Latin American partnerships at Arable ### Retail IoT [CloudWalk](https://www.cloudwalk.io/) brings credit card processing to businesses throughout Brazil by lowering costs and introducing a new and affordable cloud-based point of sale (POS) system. With Hologram, CloudWalk's POS device is able to instantly connect to multiple cellular carriers across Brazil affordably and reliably, with just one SIM. "I can see if a customer's having a problem without them telling me. It's awesome." — Gabriel Bernal, head of integrations at CloudWalk ### Mobility IoT [Cowboy](https://cowboy.com/)'s founders wanted to make an impact on [urban mobility](https://www.hologram.io/blog/what-is-micromobility) with an electric bike. With a battery and electric motor that assists while you're pedaling, the Cowboy bike is geared toward urban Millennials who want the freedom to move around the city quickly. The Cowboy team started evaluating connectivity providers once the first prototype was completed. The team discovered Hologram when they evaluated cellular technologies, from embedded SIMs to cellular networks. The team ultimately chose Hologram because of the API. "It felt like Hologram was the Stripe of the SIM management." — Bob Eck, head of marketing at Cowboy ### Smart Buildings [Zen Ecosystems](https://zenecosystems.com/) cloud connected devices help make commercial and retail buildings more energy-efficient. But Wi-Fi is hard to access for new devices, and managing dozens of cellular contracts and hundreds of different SIMs would take too many resources for Zen. With Hologram, Zen Ecosystems smart thermostats and lighting systems have 24/7 connection around the globe with just one contract and one type of SIM—so all their devices are easily managed from one place. ### Fleet Management Cloud-based [fleet management](https://www.hologram.io/industries/fleet-management) is a category of transportation software that gives fleet owners the ability to monitor vehicles and drivers with fine-tuned precision, gathering data that's useful for everything from meeting maintenance schedules to detecting driver fatigue. [Fleetsu](http://www.fleetsu.com/)'s vision is to create a world-class, innovative, fleet management software platform that is user-driven and scalable, enabling their customers to hit efficiency targets, grow their businesses and achieve outcomes they haven't even thought of yet. Fleetsu leverages the Amazon AWS IoT Cloud for analytics and uses Hologram's Dashboard to coordinate connectivity management among a team of people scattered across the Asia-Pacific region. "We're very much an agile business, able to move a lot quicker than many of our larger competitors." — Adam Ricketts, head of product for customer success at Fleetsu ## IoT Technology Now that we've seen examples of IoT applications, let's consider the IoT technology components that enable projects to get off the ground. To illustrate, let's look at [a device](https://www.hologram.io/blog/how-to-save-sheep-with-cellular-iot) created by South African engineer Danie Conradie. Livestock theft is a major problem in Conradie's area, so he decided to build an IoT tracking device that reports location and behavior to the farmer via a computer or mobile device. Here's how he did it. ### IoT Development First, Conradie asked local farmers about the problem and their needs. "Before you start building anything, you need to make sure that you understand the problem you are trying to solve," Conradie says. "This usually means talking to prospective clients. Skipping this step can lead to throwing a lot of time and money down the drain." Conradie's project is limited in scope, so he tackles it himself. In contrast, larger scale IoT solutions typically need to build out a cross-functional team with experts in hardware, embedded firmware, networking, backend, and frontend development. Everyone on the team contributes different aspects of the needed skill set as they work to develop an in-depth product plan (sometimes called a Proof of Concept). Whether small or large, IoT projects typically follow these three steps: #### Building a prototype Creating a prototype for an IoT device can be challenging and often involves a lot of trial and error. For the livestock-tracking project, Conradie identifies off-the-shelf hardware components because they're easy and quick to obtain. (Building a prototype with off-the-shelf hardware doesn't mean committing to use the same components in the final product—you just need similar enough hardware to be sure the final version will work properly.) Conradie chooses a Sodaq cellular development board with a Hologram SIM as hardware components, connected with AWS IoT Core using a Node-RED instance. At the customer end, he uses a ThingsBoard PE Dashboard, which processes and displays data to the user. Once the prototype is complete, it's time to get it into the hands of farmers to see how it works. #### Launching a pilot project After developing a functioning prototype, Conradie sets up a pilot project with limited scope but sufficient infrastructure to provide a good sense of how the product will function in the real world. He attaches a device to a sheep at a local farm and tracks its movements for a few days. After the pilot project, Conradie gathers user feedback and suggestions for improvement, making tweaks as necessary until the mini-deployment is running smoothly. #### Manufacture and deployment While Conradie isn't interested in bringing his tracker to market, a larger commercial project would be ready for mass manufacture and the official launch at this point. They would identify and engage with hardware, software and connectivity partners and prepare to market their finished product. Well before product launch, they would work to develop technical support materials and resources for future customers. *** While depth of expertise and a cross-functional team are needed to develop an enterprise-level solution, the world of IoT device and application development is becoming more accessible to all (as we've seen with Conradie's sheep tracker) thanks to an emerging market of hardware that's inexpensive and easy to use. For example, [Raspberry Pi](https://www.raspberrypi.org/) is a small, low-cost computer created to engage young people in computing. While it's great for kids, it's also a game-changer for the IoT maker community, allowing people to get involved through virtual and live events. Online communities for do-it-yourself IoT projects abound, and there's an emerging creative culture growing up around [IoT projects](https://projects.hologram.io/). ### IoT Sensors [IoT sensors](https://www.hologram.io/blog/how-wireless-iot-sensors-transform-industry-and-daily-life) play a pivotal role in many use cases. These components take environmental inputs and output an electrical signal that can be read, captured and transmitted back to a server. Depending on the use case, IoT devices might contain a number of different types of sensors, including: #### Temperature Temperature sensors monitor and report ambient or object temperature. They're used in everything from HVAC systems to refrigerated transport monitoring. #### Level These sensors can detect the fullness of a tank, a silo, or even a dumpster. They're useful in agriculture, IIoT, waste management, healthcare, and more. #### Pressure Typically tiny, pressure sensors are key components of many IoT devices (including smartphones). Air pressure sensors can be used for weather tracking as well as device tracking. #### Humidity Sensors that track humidity have a number of practical use cases, including weather monitoring and indoor climate control. Many HVAC systems include these sensors. #### Proximity The most obvious application of proximity sensors is in a car's telematics system (when you get too close to the wall of the parking garage, the sensor triggers a noisy alert). But proximity sensors have a host of other creative uses. In retail stores, they can be used to notify customers of special offers when they move close to a particular product. They're also useful in IIoT for regulating production, and in smart city applications for detecting available parking spaces. #### Gas These sensors can detect the levels of certain gases in the air, and are particularly useful in mining operations and chemical production. #### GPS locator Global positioning system sensors are critical to asset tracking, drones, micromobility, and a host of other IoT applications. #### Health Health sensors can monitor blood sugar, oxygen levels, heart rate, and more. #### Image This broad category includes everything from digital cameras to thermal imaging systems and video surveillance. ### IoT Hardware [IoT hardware](https://www.hologram.io/supported-hardware) falls into three basic groups: **servers, gateways,** and **sensors/devices**. Servers for IoT are typically cloud-based, and they provide the computing power to manage the incoming data from sensors and other edge devices. Physically located closer to the network edge, the gateway provides a connection point for the devices and sends out the data to the server. (For example, an IoT gateway might be located on a factory floor, near a fleet of smaller sensors installed in the machinery.) Sensors or devices typically contain several important hardware components: * Battery or another power source * Sensing equipment * Connectivity module * SIM card or embedded SIM ### IoT Software Software is needed at every level of hardware. This includes software on the device itself (firmware and any other apps, depending on the complexity of the device), firmware, and sometimes analytics software at the gateway level, and software used on remote machines to collect and analyze data. Here's a quick run-down on the common types of IoT software: #### Endpoint detection and response (EDR) This type of software monitors end device activity and looks for abnormalities that might indicate a security breach. #### Data integration Organizations often have data flowing in from multiple sources: different types of sensors and devices, in various formats. Data integration software helps streamline the process of combining those different elements in a single platform. #### Middleware A necessity for IoT, middleware acts as a digital translator, allowing disparate devices to communicate with each other. #### Data analytics Typically found at the cloud or platform level (although it's becoming more common in gateways and edge devices), data analytics software allows managers to examine information, create visual reports, and ultimately glean valuable insights. #### Artificial intelligence (AI) and machine learning Both emerging technologies, AI and machine learning are built around the idea that computers can learn via experience and improve their task performance. ## IoT Connectivity Without connectivity, the IoT would just be "things"—not connected things. Choosing the right type of connectivity for your IoT project depends on multiple factors. "IoT connectivity is not a decision where one size fits all. There are several potential toolkits and paths to the internet for your device, depending on your use case." — Ryan Lee, director of product management at Hologram The main factors to consider are **cost, reliability, power consumption, setup experience and pairing, ease of deployment, bandwidth, range,** and **customer/end product experience.** Let's break down the avenues of connectivity and illustrate the pros and cons of each. ### Wi-Fi While Wi-Fi wasn't designed for IoT, it works well for use cases where broadband network access is fairly dependable, such as smart home, smart building, and some smart city applications. #### Pros Wi-Fi modules typically cost less than cellular modules, and connectivity is technically free if there's existing broadband access in the deployment area. Data bandwidth is usually high, permitting large file transfers at a rapid rate. #### Cons Logistically, Wi-Fi for IoT deployments can be complicated. If the device isn't stationary, you have to enter a new password and configure network settings everywhere it goes or build in some sort of pairing capability. And when devices transmit large files, they use a lot of energy, quickly draining battery-powered devices. ### Bluetooth A popular choice for consumer devices, Bluetooth has also developed a low-energy connectivity option (Bluetooth Low Energy or BLE) that's specifically geared toward IoT applications. #### Pros For devices that need to stream large amounts of data, Bluetooth is a viable solution. And BLE is perfect for IoT sensors that spend most of their time in sleep mode and transmit data in short bursts. #### Cons Bluetooth's range is quite short, making it impractical for deployments spread across wide areas. Power consumption is also high with Bluetooth (although BLE is far more battery-efficient). ### Cellular IoT Designed for consumer mobile telephones, [cellular connectivity](https://www.hologram.io/products/connectivity) has recently expanded to embrace IoT applications. Under its umbrella are a wide variety of protocols and standards. Some were designed for consumer applications but are adaptable to IoT projects (2G, for example), while others are targeted to IoT (Cat-M1, Cat-1, and NB-IoT). Cellular devices rely on a module and [IoT SIM card](https://www.hologram.io/products/iot-sim-card) for connectivity. #### Pros Range of coverage can be very good, depending on the carrier you choose. Some IoT SIM card providers (such as Hologram) offer global coverage through an aggregation of network carriers. Because it's encrypted by default and providers ensure security updates, cellular data is typically more secure. #### Cons Until recently, cellular bandwidth lagged behind Wi-Fi's capabilities. While similar bandwidth is now possible with newer cellular technology, transferring large data sets can be expensive. ## IoT Architecture and Environments The IoT is a complex ecosystem of interacting elements, including sensors, gateways, servers, and platforms for accessing information. Aside from the device layer already discussed, this environment includes connectivity standards, platforms, and gateways. Let's take a closer look at some of these puzzle pieces. ### IoT Standards and Protocols There are dozens of IoT standards and protocols governing various functions, including infrastructure, device management, and discovery. We've already discussed the pros and cons of the major categories of communication standards (Wi-Fi, Bluetooth, and cellular), so let's take a closer look at some of the cellular [LTE standards](https://www.hologram.io/blog/nb-iot-vs-cat-m1-vs-cat-1) specifically designed for IoT. #### Cat-M1 Also known as LTE-M, Cat-M1 is a low-cost, low-power, wide-area network (LPWAN) technology developed by the Third Generation Partnership Project (3GPP). It's fast, with upload and download speeds of 1Mbps along with low latency (10–15 milliseconds). Cat-M1 is fast enough to replace many 2G and 3G applications, and it supports cellular tower handoffs, making it compatible with mobile applications such as asset tracking and fleet management. It also supports IoT voice features in applications such as medical alert devices and home alarm systems. Cat-M1 uses 1.4MHz of bandwidth and can transfer firmware, software, and other security updates out to devices. It's a perfect choice for asset tracking, health monitors, and alarms. #### Cat-1 Designed for IoT devices with low and medium bandwidth needs, Cat-1 is an older technology that's still applicable today. It's been widely adopted by carriers around the world and offers bandwidth speeds of 5Mbps for uploads and 10Mbps for downloads. Latency is low, at 50 to 100 milliseconds, and Cat-1 supports tower handoff, making it a viable option for asset tracking deployments. Cat-1 offers flexibility, with the ability to manage low-power applications as well as support higher bandwidth needs. However, it consumes more power and its signal range is a bit shorter than NB-IoT and Cat-M1. Cat-1 is well-suited to use cases such as wearables, point-of-sale (POS) terminals, video surveillance, consumer electronic devices, digital signage, and micromobility. #### Narrowband IoT (NB-IoT) Created by 3GPP, NB-IoT is another LPWAN technology that operates on the licensed spectrum and is designed for IoT devices with low-bandwidth needs. It's a low-cost solution with strong signal penetration, making it a good solution for long-distance and underground usage. Because it consumes less power than other options, it has a long battery life. NB-IoT has uplink speeds of 66kbps and download speeds of 26kpbs in half-duplex mode, meaning that data goes in one direction at a time. Latency ranges from 1.6 to 10 seconds. Ultimately, NB-IoT is best for simple IoT sensors that require small, intermittent data transmissions. ### IoT Platform The term "IoT platform" can be tricky to define. Essentially, it's a software as a service (SaaS) product that can oversee a fleet of connected things. It performs multiple tasks and different platforms offer different types of features. Choosing the [IoT platform](https://www.hologram.io/why-hologram) that's right for your project requires an evaluation of your needs—some platforms focus primarily on device management, while others include a full suite of analytics software. A high-quality IoT platform will empower you to: #### Manage device connectivity Connectivity management is a staple feature for most IoT platforms. Through the platform, you can check the connection status of individual devices in your fleet and troubleshoot any problems that arise. Many IoT platforms are now compatible with over-the-air (OTA) provisioning and software updates to support [eUICC/eSIM](https://www.hologram.io/blog/what-is-an-esim-and-how-is-it-used) equipped devices. #### Receive, store, or route data Data management capabilities are also part of many IoT platforms. The platform acts as a receiving point for data generated by end devices and may store that data in the platform or route it to third-party applications for analysis. #### Visualize device data Some IoT platforms initiate visual alerts when they detect anomalous usage or when a device is compromised, allowing you to take immediate action against security breaches. Using geospatial visualization (and the GPS sensors in your devices), these platforms can show you the physical location of the suspicious device. #### Access 24/7 support Even if you don't expect to need constant hand-holding from an IoT provider, it's wise to find a platform that includes 24/7 support. It's important to know that humans are monitoring the network and keeping things running, and let's face it—at one time or another, something will go wrong and you'll need help to fix it. ### Gateways An [IoT gateway](https://www.hologram.io/blog/what-is-an-iot-gateway) connects edge devices with the cloud. It can be either a software program or hardware and acts as a doorway for data headed in either direction. One of the main benefits of an IoT gateway is the ability to preprocess at the edge. Mass IoT deployments may involve hundreds or thousands of devices, generating a collective mountain of data. The gateway can sort and process that incoming data, take initial cleansing action to reduce redundancy and errors, and only send out necessary (or "clean") data to the server. This reduces costs associated with cellular connectivity and can give operators a better real-time picture of the data. Gateways also add data security with features like encryption and tamper detection, helping to safeguard information that's being sent on to the cloud. ## IoT Security [IoT security](https://www.hologram.io/iot-security) is a serious concern, but it's not an impossible feat. Many emerging processes and policies around privacy are affecting IoT. "There are a lot of standardizations around privacy regulation that can impact IoT for the better. That's because security often comes as a consequence of privacy." — Pat Wilbur, chief technology officer at Hologram However, there aren't official standards to govern IoT security (yet), so it's important to become familiar with potential vulnerabilities and best practices for avoiding a data breach. ### Vulnerabilities The [vulnerabilities of IoT](https://www.hologram.io/blog/iot-security-vulnerabilities) are many and varied, fueled by the unregulated "wild west" atmosphere of hardware and software development. The more connection points you have, the more opportunity hackers have to break in. These possible points of entry are called attack surfaces, and their weaknesses typically originate from engineering design and update processes. The layers of possible vulnerabilities in the IoT stack include the **SIM/eSIM, module, firmware, OEM wired and wireless interfaces**, and **server**. At each level, IoT project managers must ensure that their hardware and software is secured and monitored. ### Best Practices In the absence of universal standards, best practices for IoT security are your strongest defense against cyberattacks. These best practices include: * Disabling default passwords * Using encryption properly * Closing unnecessarily open ports * Eliminating trusted interfaces that are not needed * Enforcing the Principle of Least Privilege (restricting access between devices) * Using three layers of firewalls ## IoT Analytics The IoT greatly increases the flow of data around the world. The main advantage of having access to this data is the ability to extract insights from it—and that's where analytics comes in. The process involves aggregating data from multiple sources (in the case of IoT, from hundreds or thousands of connected devices), cleansing it of errors and redundancy, creating visual reports, and using statistical processes to extract insights such as trends and predictive models. ### Data Analytics Analyzing enormous data sets requires powerful tools based on statistical methodologies. Some of the best tools, such as Python and R, are open source. [IoT data analytics](https://www.hologram.io/blog/whats-the-relationship-between-iot-and-big-data) provides companies or individuals with reports, charts, and models they need to help with decision-making. With the tools available today, it's become relatively simple to get insights across thousands of devices—but statistical experts may be needed to interpret or create more complex models and reports. ### Machine Learning Machine learning, a type of artificial intelligence, allows computers to learn and improve through experience. For most purposes, data analytics is sufficient, but machine learning can be useful when you're compiling massive amounts of data. ## The Future of IoT The IoT will continue to transform society and impact almost every industry, from transportation to entertainment. With the advent of 5G, the newest and fastest cellular networking technology, IoT connectivity will become more ubiquitous and we'll see new modes of transportation, conveniences, and ways to gather insights from data. Processes that were once centralized will be distributed, pushing experiences, such as healthcare, toward the edge with a combination of home health monitors and telehealth services. Ultimately, IoT technology will continue to change the way we do business—and the way we live. > Software is eating the world. With IoT, software is now "eating" the physical world, creating enormous opportunities for companies to build exciting new products and generate huge efficiencies through automation. Hologram is doing our part by turning connectivity into software. > > — *Ben Forgan, CEO at Hologram* # Migrate from 1NCE to Hologram Source: https://docs.hologram.io/guides/migrations/1nce-to-hologram This guide helps you migrate from 1NCE's Management API to Hologram's REST API. It covers authentication, endpoint paths, parameter names, identifier schemes, status values, and features that differ between the two platforms. ## Core terminology differences **Clarification:** Both Hologram and 1NCE APIs return SIM-level information, even for device endpoints. For purposes of this guide, we will use the term "SIM" in all cases, even for device endpoints. One of the most important difference between 1NCE and Hologram is SIM structure. Both platforms have the concept of a SIM wrapped by a "device", and the device effectively is a 1:1 with the SIM in API endpoints. 1NCE identifies the SIM by its ICCID and offers single-profile SIMs only. Hologram SIMs can have multiple installed profiles and are identified by the SIM ID, Device ID, or the EID (eUICCID). ICCIDs are profile-level identifiers and can change if profiles are added, removed, or fall back on a SIM. In the Hologram v1 API, profiles are represented by `link` objects in the `links.cellular[]` array. If you use Conductor or over-the-air eUICC updates, you may run into cases where the ICCID printed on a physical SIM card is no longer present on the SIM. | 1NCE ID | Hologram equivalent | Notes | | - | - | - | | SIM / Device | SIM / Device | Hologram's primary entity in the v1 API is a customer "device", which wraps the SIM but is effectively a 1:1 with the SIM in API endpoints | | ICCID | ICCID, the `sim` field inside `links.cellular[]` | Hologram SIMs are addressed by integer device IDs, not ICCIDs. ICCID is a profile-level value, and SIMs can have multiple installed profiles | | | | | | Label | Name (`name`) | The human-readable name for a SIM/device | | Status | Status and network state (`state`) | Different values; see [SIM/device states](#simdevice-states) below | | Data quota | Data limit (`overagelimit`) | 1NCE has a bucket that decrements; Hologram sets a cap in bytes | | Top up | *Not applicable* | Hologram uses usage-based billing, | | Account | Organization (`orgid`) | Hologram supports multiple orgs per account | ## API overview ### Endpoint paths All Hologram API endpoints in this guide are relative to the base URL `https://dashboard.hologram.io/api/1`. Full reference documentation is at [docs.hologram.io/api/v1](/api/v1). An MCP reference of the Hologram API is available at [https://docs.hologram.io/mcp](https://docs.hologram.io/mcp). The 1NCE paths shown (e.g. `/v1/sims`) are relative to `https://api.1nce.com/management-api`; 1NCE OS paths (e.g. `/v1/integrate/...`, `/v1/locate/...`) live under the same base. These are provided for orientation — always confirm against [1NCE's API reference](https://help.1nce.com/api/), as 1NCE controls and may change them. ### Authentication 1NCE uses OAuth 2.0 client credentials. You first exchange your credentials for a Bearer token, then pass that token on every subsequent request. The token request itself is authenticated with HTTP Basic — the base64 of `client_id:client_secret` — so it's easy to omit that header and get a 401. ```bash theme={null} # Step 1: Get a token (Basic auth = base64(client_id:client_secret)) curl -X POST https://api.1nce.com/management-api/oauth/token \ -H "Authorization: Basic BASE64_CLIENT_ID_AND_SECRET" \ -H "Content-Type: application/json" \ -d '{ "grant_type": "client_credentials" }' # Step 2: Use the returned access_token Authorization: Bearer YOUR_ACCESS_TOKEN ``` Tokens expire (the response includes `expires_in`, currently 3600 seconds). Monitor it and refresh proactively. Hologram uses HTTP Basic Auth with a static API key — no token exchange, no expiry. You can also base64 encode `apikey:YOUR_API_KEY` and include it in the Authorization header. ```bash Using authorization header theme={null} curl --verbose GET \ 'https://dashboard.hologram.io/api/1/users/me' \ --header "Authorization: Basic BASE64_ENCODED_CREDENTIALS" ``` ```bash Using cURL theme={null} curl --verbose GET \ 'https://dashboard.hologram.io/api/1/users/me' \ -u apikey:YOUR_API_KEY ``` Your API key is available in the Hologram Dashboard under **Settings → [My account](/dashboard/account/rest-api-key)**.   *** ## SIM states 1NCE and Hologram use different status and state terminology. Read a full breakdown of [Hologram SIM statuses and states](/dashboard/sims/sim-states-and-statuses). The two platforms model this differently: 1NCE's SIM `status` field has only **two values** (`Enabled` and `Disabled`); everything else (expiry, deletion) is a lifecycle outcome, not a status. Hologram exposes a richer set of statuses and states, and does not have the concept of a SIM "lifetime." Once SIMs are activated they remain active until you choose to deactivate them. | 1NCE | Hologram status and state | Notes | | - | - | - | | `Enabled` (status) | **Ready**
`LIVE` | SIM is active and can pass data | | `Disabled` (status) | **Paused by user**
`PAUSED-USER` | Manually disabled. SIM is billed monthly but cannot use data | | *no equivalent* | **Paused by system**
`PAUSED-SYS` | Paused by Hologram (e.g., balance issue); cannot be resumed by the API | | *no equivalent* | **In testing**
`TEST-ACTIVATE` | SIM is configured with Test Mode and free data, not yet active | | Expired / deleted SIM (lifecycle, irreversible) | **Deactivated**
`DEAD` | Permanent, irreversible — SIM is off the network | 1NCE's `status` field returns only `Enabled` or `Disabled`. A 1NCE SIM does not become permanently "deleted" through a status change — deletion is what happens once a SIM's activation period (10-year IoT Lifetime Flat) ends. You can extend a SIM's lifetime before it expires with `POST /v1/sims/{iccid}/extend`. **Caution:** Hologram's **Deactivated** (`DEAD`) status is permanent and irreversible, but is an action you take manually. Do not deactivate SIMs unless you intend to retire them permanently. 1NCE SIMs have a set lifecycle with an expiration date that you can extend, but are automatically deactivated at the end of the lifecycle. *** ## List all SIMs 1NCE identifies each SIM in the path by its ICCID. ```bash theme={null} GET /v1/sims?page=1&pageSize=100 ``` Pagination uses `page` and `pageSize` query params (max `pageSize` is 100). Response headers `X-Total-Count`, `X-Total-Pages`, `X-Count-Per-Page`, and `X-Current-Page` describe the result set. Each SIM object returns fields including: `iccid`, `imsi`, `msisdn`, `status`, `label`, `ip_address`, `quota_status`, and `activation_date`. (Quota expiry is returned by the quota endpoint, not on the SIM object — see [Get data usage / quota](#get-data-usage--quota).) ```bash theme={null} GET /devices?orgid=YOUR_ORG_ID&limit=100 ``` Pagination is cursor-based. Use `limit` and `startafter` (the `lastid` from the previous response). The response body includes a `links.next` URL for the next page. Each device object returns: `id`, `name`, `orgid`, `imei`, `phonenumber`, `is_hyper`, and a `links.cellular[]` array where each entry has `sim` (ICCID), `imsi`, `msisdn`, `state`, `overagelimit`, `whencreated`. **Filtering:** use `states`, `sim`, `imsi`, `imei`, `tagid`, or `tagname` query params. Hologram returns an integer `id` (the device ID), and identifies SIMs by the device ID and the SIM ID since Hologram SIMs can have multiple installed profiles, returned within the `links` object on a `device` object. To find a Hologram device by ICCID: ```bash theme={null} GET /devices?sim=8988280666000012345 ``` *** ## Get a single SIM ```bash theme={null} GET /v1/sims/:iccid ``` Returns SIM detail including status, label, quota information, IP address, activation/expiry dates. ```bash theme={null} GET /devices/:deviceId ``` Returns device detail including all `links.cellular[]` profiles. The ICCID is at `links.cellular[0].sim`. **To look up by ICCID instead of device ID:** ```bash theme={null} GET /devices?sim=89882806660000123456 ``` This returns the matching device(s) — use `data[0].id` as your device ID going forward. **Key difference:** 1NCE's SIM status, quota, and connectivity are available on the single-SIM endpoint. In Hologram, the device object includes state and link info. Data quota/usage requires a separate call to `/usage/data/`. *** ## Check SIM status and connectivity ```bash theme={null} GET /v1/sims/:iccid/status GET /v1/sims/:iccid/connectivity_info ``` Two separate endpoints: `status` for the administrative status, and `connectivity_info` for the current network attachment (network, IP, last seen). ```bash theme={null} GET /devices/:deviceId ``` Both administrative state and last-known session are in the `device` object: * `links.cellular[0].state` — administrative state (`LIVE`, `PAUSED-USER`, etc.) * The `device` object also includes `imei`, last session carrier, and the device's last known state For active session detail and approximate location, use: ```bash theme={null} GET /usage/data/?linkid=LINK_ID&limit=1 ``` The `linkid` is `links.cellular[0].id` from the device object. *** ## Pause (disable) or resume (enable) a SIM ```bash theme={null} # Disable (single) PUT /v1/sims/:iccid { "status": "Disabled" } # Enable (single) PUT /v1/sims/:iccid { "status": "Enabled" } # Bulk POST /v1/sims [ { "iccid": "...", "status": "Enabled" }, ... ] ``` ```bash theme={null} POST /devices/batch/state { "state": "pause", # or "live" to resume "deviceids": [123, 456] } ``` The `state` field accepts `pause`, `live`, or `deactivate`. This always operates as a batch — pass one or many device IDs. The response returns a `jobid`; use `GET /devices/batch/state?orgid=YOUR_ORG_ID` to check job status for large batches. **Key difference:** 1NCE has per-SIM PUT endpoints and a bulk POST. Hologram uses a single bulk endpoint for all state changes. Always pass `deviceids`, even for a single device. *** ## Activate SIMs SIMs ship pre-associated with your account on the IoT Lifetime Flat plan. Activation is managed through the portal or the order flow — there is no "activate by ICCID" endpoint in the management API. ```bash theme={null} POST /links/cellular/bulkclaim { "sims": ["8988280666000012345", "8988280666000012346"], "plan": YOUR_PLAN_ID, "zone": "global", "overage_limit": -1 } ``` Or activate a range: ```bash theme={null} { "simrange": "89330123456789012345-89330123456789012365", "plan": YOUR_PLAN_ID, "zone": "global" } ``` Also accepts `eidrange` for eUICC SIMs. Maximum 2,500 SIMs per request. `plan` and `zone` are required for live activations. **Key difference:** Hologram requires explicit activation via the API or Dashboard, and requires a data plan and zone. You can pre-stage SIMs in [Test Mode](/guides/sims/test-mode) (preflight) without activating them, which is the equivalent of 1NCE's unactivated inventory. *** ## Get data usage / quota ```bash theme={null} # Remaining quota (1NCE's flat-rate bucket model) GET /v1/sims/:iccid/quota/data ``` Returns a `volume` field (remaining data in the lifetime quota, **in MB**), `total_volume`, and `expiry_date`. 1NCE reports quota `volume` in **megabytes**, while Hologram's `overagelimit` and all usage figures are in **bytes**. Convert when you port quota logic — multiply 1NCE MB values by 1,048,576 to get the Hologram byte equivalent. ```bash theme={null} # Historical usage GET /v1/sims/:iccid/usage ``` Hologram does not have a pre-paid quota bucket. Instead, you query actual session data: ```bash theme={null} # Recent data sessions (last 3 months) GET /usage/data/?linkid=LINK_ID # Daily rollup GET /usage/data/daily?linkid=LINK_ID # Monthly rollup GET /usage/data/monthly # Per-SIM totals by billing period GET /usage/data/billing?linkid=LINK_ID # Org-level aggregate GET /usage/data/total?orgid=YOUR_ORG_ID ``` `linkid` is `links.cellular[0].id` from the device object. **To see the current data limit** (the cap, not remaining): it's in `links.cellular[0].overagelimit` on the device object. `-1` means unlimited. **Key difference:** 1NCE's quota model has a finite bucket that counts down. Hologram charges per-session with a configurable overage cap. There is no "remaining quota" concept — instead you check usage against the cap you set. *** ## Set data limits ```bash theme={null} # Get account-wide limits GET /v1/sims/limits # Set account-wide limits POST /v1/sims/limits # Get the selectable limits for a service (e.g. data, sms) GET /v1/sims/:service/limits ``` ```bash theme={null} POST /devices/batch/usagelimit { "deviceids": [123, 456], "overagelimit": 10485760, # bytes; -1 for unlimited "smslimit": -1 } ``` Limits are set in bytes. `-1` disables the limit. Updates apply to all profiles on the SIM. *** ## Get SMS quota ```bash theme={null} GET /v1/sims/:iccid/quota/sms ``` Returns remaining SMS count from the lifetime flat allocation. The SMS limit is on the device: `links.cellular[0].smslimit` in the device object. Outbound SMS usage history: ```bash theme={null} GET /usage/sms/?orgid=YOUR_ORG_ID ``` *** ## Send an SMS to a SIM (cloud → device) ```bash theme={null} POST /v1/sims/:iccid/sms { "payload": "Hello device", "dcs": 0 } ``` The message text is `payload`. Encoding is controlled by `dcs` (Data Coding Scheme): `0` for 7-bit GSM (default), `8` for UCS-2. Optional fields include `source_address`, `udh`, and `expiry_date`. There is no `payload_encoding` field. ```bash theme={null} POST /sms/incoming { "deviceid": 123456, "body": "Hello device" } ``` Or send to multiple SIMs at once: ```bash theme={null} { "deviceids": [123456, 789012], "body": "Hello fleet" } ``` You can also target by phone number using the `phonenumber` field. **Terminology difference:** 1NCE calls the message a `payload`. Hologram calls it `body`. Both accept plain text; Hologram also accepts `base64body` for binary content. *** ## Get SMS history (MO/MT messages) ```bash theme={null} GET /v1/sims/:iccid/sms # list MT and MO messages GET /v1/sims/:iccid/sms/:sms_id # single message detail DELETE /v1/sims/:iccid/sms/:sms_id # cancel pending SMS ``` Inbound SMS messages from devices are delivered as cloud messaging events. There is no dedicated SMS history endpoint; messages appear in the event stream. See [cloud messaging](/guides/cloud-and-tools/what-is-hologram-cloud-messaging). ```bash theme={null} # Cloud/data messages from devices GET /csr/data/?orgid=YOUR_ORG_ID ``` *** ## Send a data / cloud message to a SIM 1NCE's core SIM Management API does not support sending arbitrary data to devices. Device-directed action requests are available in **1NCE OS** via: ```bash theme={null} POST /os/v1/devices/:iccid/actions/udp POST /os/v1/devices/:iccid/actions/coap POST /os/v1/devices/:iccid/actions/lwm2m ``` Hologram supports two-way data messaging at the connectivity layer without requiring a separate platform tier: ```bash theme={null} POST /devices/messages { "deviceids": [123456], "base64data": "SGVsbG8gZGV2aWNlCg==", # base64-encoded payload "port": 4010, "protocol": "UDP" } ``` Use `base64data` for binary/base64-encoded content, or `data` for plain text — send one, not both. `protocol` accepts `TCP` or `UDP`, `port` must be 1–65535, and the maximum payload is 10 KB. Messages are delivered over the device's active cellular session. **Key difference:** Hologram's cloud messaging is a first-class feature of the base connectivity API. 1NCE's equivalent is part of the separate 1NCE OS add-on and is protocol-specific (CoAP, LwM2M, UDP). *** ## Rename a SIM ```bash theme={null} PUT /v1/sims/:iccid { "label": "sensor-unit-42" } ``` To rename a single device, `PUT` the device and set `name`: ```bash theme={null} PUT /devices/123456 { "name": "sensor-unit-42" } ``` To rename many devices at once, use `POST /devices/names`. This endpoint is **prefix-based** — `prefix` is required, and Hologram appends the last 5 digits of each device's ICCID in parentheses (e.g. `sensor-unit-(12345)`) unless you pass `"skipPostfix": true`: ```bash theme={null} POST /devices/names { "deviceids": [123456, 789012], "prefix": "sensor-unit-" } ``` `POST /devices/names` does not accept a single fixed `name`; it always builds names from `prefix`. Use `PUT /devices/{deviceId}` when you need to set an exact, unique name. *** ## Reset connectivity ```bash theme={null} POST /v1/sims/:iccid/reset_connectivity ``` Forces the SIM to drop its current network attachment and re-register. ```bash theme={null} POST /links/cellular/updatelocation { "linkids": [123456] } ``` Sends a network refresh (update location) to the carrier for each profile, using its cellular link ID. This ends the SIM's current data session and has it reconnect to the first available network. Up to 10 link IDs per request. Not every carrier supports update location. Add `?preview=1` to check eligibility without sending the refresh. You can also run a [network refresh from the dashboard](/dashboard/sim-actions/network-refresh). *** ## Data top-up ```bash theme={null} # Single SIM POST /v1/sims/:iccid/topup # Multiple SIMs POST /v1/sims/topup [{ "iccid": "...", "volume": 500 }, ...] # Auto top-up POST /v1/sims/:iccid/topup/auto ``` Adds data volume to the lifetime flat quota. **No equivalent.** Hologram does not use a prepaid quota model. Your SIMs draw from your account balance on a pay as you go basis for data usage at per MB rates. You can optionally set an overage limit to prevent your SIMs from exceeding a certain amount of data usage by setting it in the UI or using the `overagelimit` parameter in the API. ```bash theme={null} POST /devices/batch/usagelimit { "deviceids": [123456], "overagelimit": 104857600 # 100 MB in bytes } ``` Account balance is managed separately in the Dashboard or billed via invoice. *** ## SIM transfer ```bash theme={null} POST /v1/sims/transfer ``` Transfer SIMs to another 1NCE account. ```bash theme={null} POST /devices/transfer { "deviceids": [123456], "orgid": TARGET_ORG_ID } ``` The `orgid` field is the **target** organization that will receive the devices. Transfers devices between organizations within Hologram; the target organization must exist in your account. All devices in a single request must share the same source org, and a maximum of 3,000 devices can be transferred per request. *** ## Device location Location is available through **1NCE OS** (separate add-on): ```bash theme={null} GET /os/v1/devices/:iccid/positions GET /os/v1/devices/positions/latest ``` Uses cell tower triangulation and resolution. ```bash theme={null} GET /devices/locations?orgid=YOUR_ORG_ID ``` Returns the most recent approximate location for each device based on cell tower data — no add-on required. Location is also embedded in usage records when `getlocationinfo=true`: ```bash theme={null} GET /usage/data/?linkid=LINK_ID&getlocationinfo=true ``` *** ## Pagination comparison | | 1NCE | Hologram | | - | - | - | | Style | Page-based | Cursor-based | | Page param | `page` | `startafter` (last record ID) | | Size param | `pageSize` (max 100) | `limit` (max 5000) | | Total count | `X-Total-Count` header | Not returned | | Total pages | `X-Total-Pages` header | Not returned | | Next page | Increment `page` | Use `links.next` URL or pass `lastid` as `startafter` | *** ## API feature comparison | Feature | Hologram | 1NCE | | - | - | - | | List SIMs / devices | ✅ | ✅ | | Get single SIM / device | ✅ | ✅ | | SIM state (enable/disable/deactivate) | ✅ | ✅ | | Bulk state changes | ✅ | ✅ | | Activate SIMs by ICCID | ✅ | ✅ (portal/order flow) | | Activate by ICCID range | ✅ | — | | Activate by EID range (eUICC) | ✅ | — | | Set data / SMS usage limits | ✅ | ✅ | | Data usage history (sessions) | ✅ | ✅ | | Daily / monthly usage rollups | ✅ | ✅ | | Per-billing-period usage | ✅ | — | | Data top-up / quota refill | — | ✅ | | Send SMS to device | ✅ | ✅ | | Receive SMS / MO history | — (event stream) | ✅ | | Send data / cloud message | ✅ | ✅ (1NCE OS) | | Connectivity reset | ✅ (network refresh) | ✅ | | Get device location | ✅ (cell tower, built-in) | ✅ (1NCE OS) | | Geofencing | — | ✅ (1NCE OS) | | Location update / network refresh | ✅ | ✅ | | Alerts / event notifications | ✅ | — | | Webhook integration | ✅ | ✅ (1NCE OS) | | AWS IoT integration | — | ✅ (1NCE OS) | | Tags / device grouping | ✅ | — | | Rename devices | ✅ | ✅ | | Device transfer between accounts | ✅ | ✅ | | Multi-profile / eUICC management | ✅ (Hyper SIM, Outage Protection) | — | | Outage Protection (auto failover) | ✅ | — | | Secure device tunneling (SSH) | ✅ (Spacebridge) | — | | Order management via API | — | ✅ | | Support tickets via API | — | ✅ | | Organization / user management | ✅ | — | | Billing / transaction data via API | ✅ | — | | Async job / change-request tracking | ✅ | — | | API key rotation | ✅ | — (OAuth client credentials) | | Published OpenAPI spec | ✅ | ✅ | | MCP server | ✅ (documentation only, `llms.txt`) | — | # Activate multiple SIMs in bulk using the REST API Source: https://docs.hologram.io/guides/rest-api/activate-sims-in-bulk-using-the-rest-api Activating SIMs via the [Dashboard](/dashboard/activation/activation-overview) is a great option if you are only doing so for a handful of devices, but what if you want to activate dozens, hundreds, or even thousands of devices? For this we recommend using our [REST API](/api/1/). This option lets you programmatically activate devices and also enter SIM ranges instead of individual SIM numbers. ## How to activate multiple SIMs in bulk using the REST API Use the Hologram REST API to activate dozens or thousands of SIMs in a single request. You can submit explicit ICCID lists or ICCID ranges, and specify the data plan and zone to apply. **Note:** You can also perform bulk actions in the Dashboard for smaller jobs. If you aren't familiar with APIs, we highly recommend checking out our [introduction to Hologram's REST API guide](/guides/rest-api/beginners-guide-to-the-hologram-rest-api/) as well as using [Postman](https://www.getpostman.com/) to make the API calls mentioned in this guide. ### Prerequisites * **API key** with permission to manage SIMs * **Organization ID** where the SIMs belong * **Plan ID** and **zone** for the target plan (see below) Use the plans endpoint to list available plans. Find the `id` and the `zones` value (for example: `global`, `USA`, `usaall`, `1`, or `2`). Plans should generally have only one zone. ```bash cURL theme={null} curl --request GET \ --url 'https://dashboard.hologram.io/api/1/plans' \ -u apikey:YOUR_HOLOGRAM_API_KEY ``` ```json Response example highlight={14,27-28} theme={null} { "success": true, "limit": 1, "size": 1, "continues": true, "links": { "path": "/api/1/plans", "base": "dashboard.hologram.io", "next": "/api/1/plans?startafter=2345" }, "lastid": 2345, "data": [ { "id": 2345, "partnerid": 1, "name": "Global G3 Standard Network-Level Billing", "description": "Global G3 Standard Network-Level Billing", "data": 0, "recurring": 1, "enabled": 1, "billingperiod": 1, "groupid": 1234, "developerplan": 0, "tiers": { "BASE": { "devicecount": 0, "zones": { "global": { "amount": "1.000000", "sms": "0.190000", "overage": "0.030000", "carriers": { "13": { "apn": "hologram" } } } } } }, "display_category": "standard", "cellular_coverage_region": { "id": 1, "display_name": "Global", "description": "Connect your SIM anywhere in the world" } } ] } ``` ### Activate SIMs #### Activate SIMs with an explicit ICCID list Send a POST request to the bulk claim endpoint with a list of ICCIDs. ```bash cURL theme={null} curl --request POST \ --url 'https://dashboard.hologram.io/api/1/links/cellular/bulkclaim' \ -u apikey:YOUR_HOLOGRAM_API_KEY \ --header 'Content-Type: application/json' \ --data-raw '{ "sims": ["8901000000000000001", "8901000000000000002"], "plan": 1234, "zone": "global", "orgid": 5678 }' ``` #### Activate SIMs with an ICCID range Alternatively, submit a range for contiguous ICCIDs. ```bash cURL theme={null} curl --request POST \ --url 'https://dashboard.hologram.io/api/1/links/cellular/bulkclaim' \ -u apikey:YOUR_HOLOGRAM_API_KEY \ --header 'Content-Type: application/json' \ --data-raw '{ "simrange": "8901000000000000001-8901000000000000099", "plan": 1234, "zone": "global", "orgid": 5678 }' ``` **Warning:** Use the correct plan and zone to avoid unexpected charges. Verify a subset before running very large batches. ## Related guides How to activate SIMs in your dashboard How to change SIM data plans in bulk using the REST API # Beginner's guide to the Hologram REST API Source: https://docs.hologram.io/guides/rest-api/beginners-guide-to-the-hologram-rest-api Learn about core concepts, authentication, and common endpoints to manage SIMs and devices via the REST API. Use the REST API to automate actions you perform in your dashboard, such as SIM activation, tagging, plan changes, messaging, and monitoring. Full API reference for the Hologram REST API. ## What is a REST API? The REST API is a set of HTTP endpoints that let you programmatically manage your fleet. Bulk actions and automation are where it shines. ## Authentication Include your API key using Basic auth. ```http theme={null} Authorization: Basic Base64Encode("apikey:YOUR_API_KEY") ``` **Caution:** Never transmit API keys in plaintext or commit them to source control. ## Anatomy of an endpoint * Base URL: `https://dashboard.hologram.io/api/1/` * Categories: `devices`, `links/cellular`, `plans`, `usage`, `sms`, `tunnelkeys`, `organizations`, `users` * Query params: `orgid`, `limit`, etc. ## Common endpoints ### Get plan information ```http theme={null} GET https://dashboard.hologram.io/api/1/plans?orgid={ORG_ID} ``` ### Activate SIMs in bulk ```http theme={null} POST https://dashboard.hologram.io/api/1/links/cellular/bulkclaim?orgid={ORG_ID} ``` Body example: ``` { "sims": ["{ICCID_1}", "{ICCID_2}"], "plan": {PLAN_ID}, "zone": "{PLAN_ZONE}" } ``` ### Get tags ```http theme={null} GET https://dashboard.hologram.io/api/1/devices/tags?orgid={ORG_ID} ``` ### List devices (get Device ID/Link ID) ```http theme={null} GET https://dashboard.hologram.io/api/1/devices?orgid={ORG_ID} ``` ### Tag SIMs ```http theme={null} POST https://dashboard.hologram.io/api/1/devices/tags/{TAG_ID}/link?orgid={ORG_ID} ``` Body: ```json theme={null} { "deviceids": [DEVICE_ID_1, DEVICE_ID_2] } ``` ### Change plans (bulk) ```http theme={null} POST https://dashboard.hologram.io/api/1/links/cellular/changeplan ``` Body: ``` { "linkids": [LINKID_1, LINKID_2], "plan": PLAN_ID, "tier": "{PLAN_ZONE}", "orgid": ORG_ID } ``` ### Pause or resume a SIM ```http theme={null} POST https://dashboard.hologram.io/api/1/links/cellular/{linkid}/state?orgid={ORG_ID} ``` Body: ```json theme={null} { "state": "pause" } ``` ## Related actions # Change SIM data plans in bulk using the REST API Source: https://docs.hologram.io/guides/rest-api/change-sim-data-plans-in-bulk-using-the-rest-api Collect link IDs and plan details, then change plans for many SIMs via the REST API. ## How do I use the REST API to change data plans in bulk? ```bash cURL theme={null} curl --request GET \ 'https://dashboard.hologram.io/api/1/devices?orgid={ORG_ID}' \ -u apikey:YOUR_HOLOGRAM_API_KEY ``` ```bash cURL theme={null} curl --request GET \ 'https://dashboard.hologram.io/api/1/plans?orgid={ORG_ID}' \ -u apikey:YOUR_HOLOGRAM_API_KEY ``` ```bash cURL theme={null} curl --request POST \ 'https://dashboard.hologram.io/api/1/links/cellular/changeplan' \ -u apikey:YOUR_HOLOGRAM_API_KEY \ --header 'Content-Type: application/json' \ --data-raw '{ "linkids": [LINKID_1, LINKID_2], "plan": PLAN_ID, "tier": "{PLAN_ZONE}", "orgid": ORG_ID }' ``` ## Related actions Change data plans in your dashboard. Limited to 10 SIMs at a time. # Deactivate SIMs using the REST API Source: https://docs.hologram.io/guides/rest-api/deactivate-sims-using-the-rest-api Deactivate SIMs in bulk using the REST API, and understand the implications of permanent SIM deactivation. ## How to deactivate SIMs using the REST API Use the cellular state endpoint to deactivate one or more SIMs by `linkid`. **Danger:** SIM deactivation is permanent and irreversible once completed. If you plan to reuse SIMs, do not deactivate them, [pause them instead](/dashboard/sim-actions/pause-resume-sims). **Limited access:** Deactivation is limited to Owner, Admin, and Manager roles. ### Send a request to set state=deactivate using cURL ```bash cURL theme={null} curl --request POST \ 'https://dashboard.hologram.io/api/1/devices/batch/state' \ -u apikey:YOUR_HOLOGRAM_API_KEY \ --header 'Content-Type: application/json' \ --data-raw '{ "orgid": 12345, "deviceids": [123456, 234567], "state": "deactivate" }' ``` ### Send a request to set state=deactivate using HTTP ```bash cURL theme={null} curl --request POST \ 'https://dashboard.hologram.io/api/1/devices/batch/state' \ -u apikey:YOUR_HOLOGRAM_API_KEY \ --header 'Content-Type: application/json' \ --data-raw '{ "orgid": 12345, "deviceids": [123456, 234567], "state": "deactivate" }' ``` ## Related actions Deactivate SIMs in your dashboard. Limited to 10 SIMs at a time. Deactivate SIMs (bulk) POST /links/cellular/state # Determine device's location via the REST API Source: https://docs.hologram.io/guides/rest-api/determine-devices-location-via-the-rest-api Retrieve approximate device location from the last session via the Devices endpoint. ## How to determine device's location via the REST API You can query a device to retrieve its most recent location approximation via the REST API. The response includes a `lastsession` object with latitude and longitude when the network provides it. **Note:** If you're new to APIs, use a REST client and include your API key in the `Authorization` header. Pagination is supported via `limit` and `startafter`. Replace `YOUR_DEVICE_ID` with the integer device ID. ```bash cURL theme={null} curl -X GET \ 'https://dashboard.hologram.io/api/1/devices/YOUR_DEVICE_ID' \ -u apikey:YOUR_HOLOGRAM_API_KEY ``` **Warning:** Not every network provides location information, and not every session includes it. For historical data, use session history or data usage by session reports. # Determine if SIM is standard or industrial-grade using the REST API Source: https://docs.hologram.io/guides/rest-api/determine-if-sim-is-standard-or-industrial-grade-using-the-rest-api All new Hologram SIMs are industrial grade. Check legacy SIM grade via the links/cellular endpoint and the sim_attribute field. ## How to check SIM grade via the REST API Use the cellular links endpoint to retrieve `sim_attribute` for a SIM. For information on the difference between a Standard and an Industrial SIM please visit our [SIM Datasheet](/guides/sims/hologram-iot-sim-datasheets). **Note:** Your SIM must be activated and Live to check the status. If you need to check this for a card prior to activation, please contact us at [support@hologram.io](mailto:support@hologram.io). ```bash theme={null} curl --request GET \ --url https://dashboard.hologram.io/api/1/links/cellular/{linkId} \ -u apikey:YOUR_HOLOGRAM_API_KEY ``` Look for `sim_attribute` in the response: `STANDARD` or `INDUSTRIAL`. ```json highlight={13} theme={null} { "success": true, "data": [ { "id": 234567, "deviceid": 3456789, "devicename": "Device Name", "orgid": 12345, "simcardid": 1234567, "tunnelable": 0, "partnerid": 1, "sim": "8912340000123456789", "sim_attribute": "STANDARD", ... } ] } ``` # Get data usage by IMEI through the REST API Source: https://docs.hologram.io/guides/rest-api/get-data-usage-by-imei-through-the-rest-api-python Look up a device by IMEI, then fetch usage via REST API with a Python example. **Caution:** IMEIs can change if a SIM moves between devices. Not every network provides IMEI information for every session. ## How do I use the REST API to check usage by IMEI? ```bash cURL theme={null} curl --request GET \ 'https://dashboard.hologram.io/api/1/devices/?orgid=YOUR_ORG_ID&imei=YOUR_IMEI' \ -u apikey:YOUR_HOLOGRAM_API_KEY ``` ```bash cURL theme={null} curl --request GET \ 'https://dashboard.hologram.io/api/1/usage/data?deviceid=YOUR_DEVICE_ID×tart=YOUR_EPOCH_START&timeend=YOUR_EPOCH_END' \ -u apikey:YOUR_HOLOGRAM_API_KEY ``` ## Python example ```python theme={null} import requests from requests.auth import HTTPBasicAuth import json import datetime usr = 'apikey' pwd = 'YOUR_HOLOGRAM_API_KEY' orgid = 'YOUR_ORG_ID' imei = 'YOUR_IMEI' dev_res = requests.get( f'https://dashboard.hologram.io/api/1/devices/?orgid={orgid}&imei={imei}', auth=HTTPBasicAuth(usr, pwd) ) device_id = dev_res.json()['data'][0]['id'] start = int(datetime.datetime(2021, 9, 28).timestamp()) end = int(datetime.datetime(2021, 10, 5).timestamp()) usage_res = requests.get( f'https://dashboard.hologram.io/api/1/usage/data?deviceid={device_id}&orgid={orgid}×tart={start}&timeend={end}', auth=HTTPBasicAuth(usr, pwd) ) print(json.dumps(usage_res.json(), indent=2)) ``` ## Related actions Search for a SIM by IMEI then check data usage in your dashboard. # Rename SIMs using the REST API Source: https://docs.hologram.io/guides/rest-api/rename-sims-using-the-rest-api Rename devices individually or in bulk via the REST API. ## How to rename SIMs using the REST API You can set device names programmatically using the Devices endpoint. Below are two approaches: [upload a CSV of ICCIDs and names](/guides/rest-api/rename-sims-using-the-rest-api/#update-device-names-using-a-csv), or [apply a sequential prefix across a list of device IDs](/guides/rest-api/rename-sims-using-the-rest-api/#add-sequential-names-with-a-shared-prefix). **Note:** You can also rename SIMs [in your dashboard](/dashboard/sim-actions/rename-sims). ## Update device names using a CSV First we need to make the CSV. This is a simple document with two columns: one for the Name we want to give the SIMs, and the other with an ICCID from the SIM we want to receive this new name. | Name | ICCID | | - | - | | New Name 1 | 8901000000000000001 | | New Name 2 | 8901000000000000002 | | New Name 3 | 8901000000000000003 | **Caution:** It is important to name this CSV document `**hologram_renamer.csv**`, and to make sure the top row is used as a header and does not include data as our program skips it. You will also want to make sure that the program and the CSV file are on the same path to make your life easier. For smaller batches, you can also use [Dashboard bulk actions](/dashboard/sim-actions/rename-sims) to rename SIMs. Now we move on to the code. Use the code below in your favorite text editor or Python's IDLE. ```python theme={null} import csv import requests import base64 encoded_api=str(base64.b64encode((("apikey:"+input("Enter your API Key: ")).encode("utf-8"))),"utf-8") # Ask and Encode API Key head ={"Authorization":"Basic "+encoded_api} #header filename = 'hologram_renamer.csv' #CSV file names=[] #List where we will store the device names we pull from the CSV iccids=[] #List where we will store the device iccids we pull from the CSV deviceids=[] #List where we will store the device IDs we look up orgid=[] #List where we will store the id of the Orgs where the devices are with open (filename,'r') as file: #Open the CSV with the new names and SIMs to rename. reader = csv.reader(file,delimiter=',') lineCount=0 #Counter to be used to get specific list values for line in reader: #Iterate through all the rows in the CSV if lineCount==0:#Skip header row lineCount = lineCount + 1 else: #Populate list of names names.append(line[0]) #Populate list of iccids iccids.append(line[1]) #Populate list of deviceids get_device_url ="https://dashboard.hologram.io/api/1/links/cellular?sim="+iccids[lineCount-1] # set up query r= requests.get(get_device_url,headers=head) #get query to get current device information if str(r) == "": #Pass if successful pass else: print ("Record Failed ") #Flag if Failed and print failure print(r) print(r.text) jdata = r.json() #format JSON deviceids.append(jdata['data'][0]['deviceid']) #Add device id to list of device IDs orgid.append(jdata['data'][0]['orgid']) #Add org to list of orgids #Rename rename_device_url = "https://dashboard.hologram.io/api/1/devices/" + str(deviceids[lineCount-1]) +"?orgid=" +str(orgid[lineCount-1]) # set up query 2 r2 = requests.put(rename_device_url, data = {'name': names[lineCount-1]}, headers=head) #put query to modify the device name if str(r) == "": # Success status print ("Finished Record " + str(lineCount-1) +" SIM " + iccids[lineCount-1] + " is now called: "+ names[lineCount-1])#Print out progress else: #Fail status print ("Record Failed " + str(lineCount-1) +" SIM " + iccids[lineCount-1] + " is NOT called: "+ names[lineCount-1])#Print out progress print(r) print(r.text) lineCount = lineCount + 1 #Increase counter print("Renaming Complete") #Let us know the program ran to completion ``` Run the program and when prompted enter your [API Key](https://dashboard.hologram.io/account/api). **Note:** Always test with a few devices before applying bulk changes. ## Add sequential names with a shared prefix Use the code below in your favorite text editor or Python's IDLE. ```python theme={null} import requests prefix = "Prefix" #Enter the Prefix you want to add to your device deviceIDs = [DEVICE_1,DEVICE_2,DEVICE_N] #Enter list of your devices apikey = "YOUR_API_KEY" #Enter your API Key https://dashboard.hologram.io/account/api char_count= len(str(len(deviceIDs))) #count the number of characters in the list of devices to pad with zeros i = 0 for ids in deviceIDs: #loop for all devices in deviceIDs list device = str(deviceIDs[i]) #get the device number from deviceID's at position i i = i+1 #increase counter since we don't want to start numbering at 0 i_str = str(i) #save number as string print ("Working on record: " + i_str) #print the record we are working on url = "https://dashboard.hologram.io/api/1/devices/" + device +"?apikey=" + apikey # set up query r= requests.get(url) #get query to get current device information jdata = r.json() #format JSON name = jdata['data']['name'] #get the device's name name = name[-8:] #extract the last few digits of the SIM card automatically added to the device print ("device SIM end: " + name) #print the extracted information new_name = prefix + "-" + i_str.zfill(char_count) # format new prefix with device count new_name += name #format new prefix with SIM card numbers print ("new name: " + new_name) #print new name url2 = "https://dashboard.hologram.io/api/1/devices/" + device + "?apikey=" + apikey #set up query r2 = requests.put(url2, data = {'name': new_name}) #put query to modify the device name ``` Replace the green `Prefix` text with the prefix you'd like to add, but make sure to leave the `"` on either side. A `-#` will be appended to the prefix text starting at 1 and increasing by 1 for every device that is run through this script. Replace `DEVICE_1,DEVICE_2,DEVICE_N` with a comma separated list of device IDs you want to rename. An easy way to get a list of devices is using the CSV export tool at the bottom left-hand side of the Dashboard's Devices section. Replace the green `YOUR_API_KEY` text with your API Key, make sure to leave the `"` on either side. Run the script to rename the devices. # Send and receive SMS using the REST API Source: https://docs.hologram.io/guides/rest-api/send-and-receive-sms-using-the-rest-api You can use the Hologram REST API to send and receive SMS messages on your device. Use the SMS incoming endpoint to send a message to a device and read SMS responses via Data Engine logs. ## How to send and receive SMS using the REST API Use the SMS incoming endpoint to send a message to a device. ```bash theme={null} curl --request POST \ 'https://dashboard.hologram.io/api/1/sms/incoming' \ -u apikey:YOUR_HOLOGRAM_API_KEY \ --header 'Content-Type: application/json' \ --data-raw '{ "deviceid": YOUR_DEVICE_ID, "body": "Hello world!" }' ``` **Note:** Messages originate from a +44 number. Replies from the device appear in logs. ## View device SMS replies from logs Query Data Engine CSR logs for SMS activity. ```bash theme={null} curl --request GET \ 'https://dashboard.hologram.io/api/1/csr/rdm?deviceid=YOUR_DEVICE_ID' \ -u apikey:YOUR_HOLOGRAM_API_KEY ``` The `data` field is Base64-encoded; decode to read the text payload. ## Related actions Send SMS messages, or TCP or UDP cloud messages to your SIMs. No SIM limit. # Set a SIM's SMS limit using the REST API Source: https://docs.hologram.io/guides/rest-api/set-a-sims-sms-limit-using-the-rest-api Configure outbound SMS limits per SIM and understand pause behavior. Each SIM has an outbound SMS limit. The **default is 100 outbound SMS per SIM**, tracked across all installed profiles. SMS limits cannot be removed. Using the REST API, you can **lower** a SIM's SMS limit, or **raise it back up to the 100 default**. Raising the limit above 100 requires an active contract — see [How do I request an SMS limit increase?](#how-do-i-request-an-sms-limit-increase) below. ## What happens when a SIM reaches its SMS limit? When a SIM hits its SMS limit, it is [paused](/dashboard/sim-actions/pause-resume-sims) until the next billing period, and the organization owner receives an email notification. To resume the SIM sooner, increase its SMS limit; the SIM typically resumes activity within about 10 minutes. ## How do I request an SMS limit increase? **Limited access.** Customers with an active contract can request an SMS limit increase by contacting our [support team](/guides/get-started/contact-support). ## How do I update an SMS limit using the REST API? You can decrease the SMS limit on a SIM using the REST API, or increase the limit back to 100. ```bash cURL theme={null} curl --request POST \ 'https://dashboard.hologram.io/api/1/links/cellular/limit/sms' \ -u apikey:YOUR_HOLOGRAM_API_KEY \ --header 'Content-Type: application/json' \ --data-raw '{ "linkids": [YOUR_LINK_ID_1, YOUR_LINK_ID_2], "limit": YOUR_SMS_LIMIT }' ``` # Tag SIMs using the REST API Source: https://docs.hologram.io/guides/rest-api/tag-multiple-sims-using-the-rest-api If you want to tag hundreds, or even thousands of devices, we recommend using our REST API for additional control over how your SIMs are named. ## How to tag multiple SIMs using the REST API If you want to tag hundreds, or even thousands of devices, we recommend using our [REST API](/api/1/). This option lets you programmatically tag devices. Use the devices/tags endpoints to create a tag, list tag IDs, and link devices to a tag. If you aren't familiar with APIs, we highly recommend checking out our [introduction to Hologram's REST API guide](/guides/rest-api/beginners-guide-to-the-hologram-rest-api/) as well as using [Postman](https://www.getpostman.com/) to make the API calls mentioned in this guide. **Note:** You can also make bulk SIM changes [in your dashboard](/dashboard/sim-actions/tag-sims). ```bash cURL theme={null} curl --request POST \ --url 'https://dashboard.hologram.io/api/1/devices/tags' \ -u apikey:YOUR_HOLOGRAM_API_KEY \ --header 'Content-Type: application/json' \ --data-raw '{"name":"YOUR_TAG_NAME"}' ``` ```bash cURL theme={null} curl --request GET \ --url 'https://dashboard.hologram.io/api/1/devices/tags' \ -u apikey:YOUR_HOLOGRAM_API_KEY ``` ```bash cURL theme={null} curl --request POST \ --url 'https://dashboard.hologram.io/api/1/devices/tags/YOUR_TAG_ID/link/' \ -u apikey:YOUR_HOLOGRAM_API_KEY \ --header 'Content-Type: application/json' \ --data-raw '{"deviceids":[YOUR_DEVICE_ID_1, YOUR_DEVICE_ID_2, YOUR_DEVICE_ID_N]}' ``` **Note:** For tags scoped to a custom organization, include `orgid=YOUR_ORG_ID` where required. *** title: "Tag multiple SIMs using the REST API" description: "Create tags and link them to many devices using REST API endpoints." ---------------------------------------------------------------------------------- Programmatically tag large fleets using the REST API. ## How do I use the REST API to tag SIMs in bulk? ```http theme={null} POST https://dashboard.hologram.io/api/1/devices/tags ``` Body: ```json theme={null} { "name": "YOUR_TAG_NAME" } ``` ```http theme={null} GET https://dashboard.hologram.io/api/1/devices/tags ``` ```http theme={null} GET https://dashboard.hologram.io/api/1/devices ``` ```http theme={null} POST https://dashboard.hologram.io/api/1/devices/tags/{TAG_ID}/link ``` Body: ```json theme={null} { "deviceids": [DEVICE_ID_1, DEVICE_ID_2] } ``` ## Related actions Tag SIMs in bulk in your dashboard. # Can I manually switch profiles on a Multi-Core SIM? Source: https://docs.hologram.io/guides/sims/can-i-manually-switch-profiles Hologram's Multi-Core Hyper SIMs provide multiple mobile cores, each with their own network coverage. If these SIMs lose connectivity, they switch mobile cores automatically and change to backup network coverage, using our network fallback technology to automate this change. ## Why would I want to manually switch profiles? Sometimes you may want to steer your SIM to connect a specific to a specific carrier or set of networks. We see this happen most often in three cases. 1. When an organization with access to Tier-1 carriers in the United States or Canada has a SIM that has fallen back to a backup Global profile, but wants to switch back to the Tier-1 profile. 2. In rural deployments where there might be poor connectivity on a specific network in a specific region, and switching profiles provides better connectivity. 3. In global deployments where a device travels internationally and changes profiles regularly, to prepare a device in advance for travel to a new region or country. ## How can I switch profiles manually on a Multi-Core SIM? You can change profiles manually on a Multi-Core SIM by using the **Switch profiles** action in the SIM's details page. Learn how to switch profiles manually in your dashboard. We limit the ability to switch profiles to SIMs that are actively able to use data. If your SIM's data usage is paused, you will need to resume it before trying to switch profiles. This option will only appear for a SIM if its profile is able to be switched. ## How long does it take to switch profiles? Switching profiles should take under 10 minutes for most SIMs. However, this process can take longer if the SIM isn't immediately able to connect to the profile you are switching to. Switching to a SIM profile with Global coverage generally takes place in under 2 minutes. Switching to a SIM profiles with Tier-1 carrier coverage can occasionally take as long as 45 minutes if the SIM isn't immediately able to connect to the network. # Conductor for SIM orchestration at scale Source: https://docs.hologram.io/guides/sims/conductor **Conductor** is Hologram's SIM orchestration tool for engineering and operations teams managing IoT deployments in production. As fleets grow and carriers multiply, the work of managing SIM profiles, switching networks, and recovering connectivity becomes its own engineering problem. Conductor handles that problem so your team doesn't have to. Conductor illustration Conductor illustration We've been running SIM orchestration in production for years, completing tens of millions of over-the-air eUICC operations before Conductor was ever a product. We believe IoT teams deserve fleet-level SIM control that's as reliable as the hardware they're shipping, and Conductor is how we're delivering that. **Limited access:** Conductor is available now in alpha with Hologram's Hyper SIMs. New SGP.32-compliant Hyper SIMs are available in limited quantities, with a broader supply and full Conductor API support expected this summer. To request alpha access or learn more, visit [hologram.io/products/conductor](https://www.hologram.io/products/conductor/?utm_source=docs\&utm_medium=website\&utm_content=conductor_callout). ## What does it do? Conductor handles three core workflows that cover the full SIM lifecycle. **Provisioning and activation.** Provision, configure, and activate SIM profiles at scale without manual intervention. Every activation is logged, every change is attributed, and the full history of each device's profile is available on demand for compliance requirements and audititing. **Profile switching and failover.** When a carrier fails or coverage drops, Conductor provides multiple ways to respond. Rules-based failover triggers automatically when a profile fails. API-driven profile switches let engineering teams wire recovery into their own systems. Bulk actions let your operations teams move an entire fleet to a new profile when conditions demand it. Paired with Outage Protection™ and its contractual 99.95% uptime SLA you have resilience at every level of the stack. **Dynamic optimization.** Connectivity decisions that made sense at launch often stop making sense as a fleet grows. Carrier coverage that works in one region may be unreliable or expensive in another, and a pricing agreement that was competitive at 1,000 devices may not hold at 10,000. Conductor lets you respond to those shifts by switching profiles across some or all of a fleet without carrier negotiations or engineering sprints, whether the driver is cost, coverage, performance, or geography. ## How do I use Conductor? You can manage everything in Conductor through the API. For a more hands-off experience, work with Hologram's Solutions team to handle orchestration on your behalf. And, a UI is coming to your dashboard later this year. Teams can move between all three models as deployments and requirements change. ## FAQs Visit [hologram.io/products/conductor](https://www.hologram.io/products/conductor/?utm_source=docs\&utm_medium=website\&utm_content=conductor_callout) to request alpha access or learn more about Conductor. Hologram's eUICC Hyper SIMs are supported in Conductor. Devices must pass eUICC compatibility testing. Device data usage and connectivity patterns must support over-the-air configuration changes. Not yet, but a UI for Conductor will be coming later in 2026. Conductor supports profile provisioning, activation, switching, and failover, changing data plans and coverage, configuring Outage Protection, and more. All with real-time webhook notifications and a full audit trail. Multi-step configurations that used to take 40-50 minutes now complete in 5-10 minutes. The system is event-driven and only attempts operations when the device is online and most likely to succeed. # What are fallback events for Hyper SIMs with Outage Protection™? Source: https://docs.hologram.io/guides/sims/fallback-events Hologram's Hyper SIMs with Outage Protection can switch mobile cores automatically in the case an installed profile loses connectivity, protecting you from downtime and outages. When a SIM switches connectivity profiles automatically, we call this a **fallback event**. **Limited access:** Prevent unexpected outages with Outage Protection™ and get contractually guaranteed reliability by contacting our [sales team](https://www.hologram.io/contact-sales?utm_source=docs\&utm_medium=website\&utm_content=outage_protection_callout). ## How do I identify fallback events? Only one connectivity profile ("mobile core") on a SIM can actively use data and connect to networks. When profiles on a SIM change either due to over-the-air eUICC updates or fallback events, the active ICCID changes. You can identify profile changes by looking for ICCID changes between sessions. The **enabled profile ICCID** listed across pages in your dashboard the ICCID of the profile currently enabled and able to use data. ## Where can I find a list of all fallback events for a SIM? 1. To find details about installed profiles for your SIM and a full history of fallback events, open a SIM's details page from the **SIMs** section in the main menu of your dashboard or by searching for the SIM. 2. Navigate to the **Profiles tab** where you can see the currently installed profiles on the SIM and information about how your SIM will connect through multiple profiles. 3. The **Fallback history card** at the bottom of the page will list all fallback events for the SIM. Fallback history card showing list of fallback events ### Identify a fallback event 1. When viewing session details for a SIM, look for a sequence of sessions in which the ICCID changes. 2. In the **Recent Sessions tab** for a single SIM, individual fallback events are called out with an indicator and on the row next to the session's profile ICCID. Recent Sessions tab with fallback event indicator **Note:** This functionality was formerly called "fallback for Dual-Core Capable SIMs". Hologram's Hyper SIMs support fallback natively when two or more profiles are installed, which we now call "Multi-Core". # Hologram IoT SIM datasheets Source: https://docs.hologram.io/guides/sims/hologram-iot-sim-datasheets Hologram provides global IoT SIMs for every use case. Hardware and software specifications for Hologram IoT Hyper SIMs along with downloadable PDFs are available in this guide. SIMs are available in triple cut card, embedded MFF2, and eSIM form factors across SGP.02, SGP.22, and SGP.32 specifications. Hologram Hyper SIMs are industrial-grade eUICC SIMs available in triple cut (2FF/3FF/4FF) and embedded SIM (MFF2 DFN8) form factors. Industrial-grade SIMs support wide operating temperatures and extended lifecycle applications. ## SIM card specifications ### Hyper SIM - SGP.02 SGP.02 Triple Cut Hyper SIM card example **Triple cut format** * Mini (2FF): 25mm × 15mm × 0.71 mm * Micro (3FF): 15mm × 12mm × 0.71 mm * Nano (4FF): 12.3mm × 8.8mm × 0.71 mm **Embedded SIM format** * MFF2 (DFN8): 6 × 5 × 0.82 mm **Operating characteristics** * Electrical: 1.62V to 5V * Operational temperature: -40°C to +105°C (Industrial grade) * Available memory: 414,384 bytes * eUICC: SGP.02 v4.2 * Radio Access Technologies: 5G, 4G (LTE), 3G, 2G, NB-IoT, LTE-M ### Hyper SIM - SGP.32 SGP.32 Triple Cut Hyper SIM card example **Triple cut format** * Mini (2FF): 25mm × 15mm × 0.71 mm * Micro (3FF): 15mm × 12mm × 0.71 mm * Nano (4FF): 12.3mm × 8.8mm × 0.71 mm **Embedded SIM format** * MFF2 (DFN8): 6 × 5 × 0.82 mm **Operating characteristics** * Electrical: 1.62V to 5V * Operational temperature: -40°C to +105°C (Industrial grade) * Available memory: 318,936 bytes * eUICC: SGP.32 v1.2, SGP.22 v2.5 * Radio Access Technologies: 5G, 4G (LTE), 3G, 2G, NB-IoT, LTE-M   ## Previously available Hologram SIMs Global G1 and Canada G2 eUICC SIMs are no longer manufactured, but details remain for reference. **Triple cut format** * Mini (2FF): 25mm × 15mm × 0.71 mm * Micro (3FF): 15mm × 12mm × 0.71 mm * Nano (4FF): 12.3mm × 8.8mm × 0.71 mm **Operating characteristics – Standard grade** * Electrical: 1.6V, 3V, and 5V * Operational temperature: -25°C to +85°C * Memory (NVM): 340 KB * Radio Access Technologies: 4G (LTE), 3G, 2G, NB-IoT, LTE-M **Operating characteristics – Industrial grade** * Electrical: 1.62V to 5.5V * Operational temperature: -40°C to +105°C * Memory (NVM): 704 KB * Radio Access Technologies: 4G (LTE), 3G, 2G, NB-IoT, LTE-M Download datasheet (Global G1 Triple Cut) **Embedded SIM format** * MFF2 (DFN8): 6 × 5 × 0.82 mm **Operating characteristics** * Electrical: 1.6V, 3V, and 5V * Operational temperature: -25°C to +85°C * Memory (NVM): 340 KB * Radio Access Technologies: 4G (LTE), 3G, 2G, NB-IoT, LTE-M Download datasheet (Global G1 Embedded) **Triple cut format** * Mini (2FF): 25mm × 15mm × 0.71 mm * Micro (3FF): 15mm × 12mm × 0.71 mm * Nano (4FF): 12.3mm × 8.8mm × 0.71 mm **Operating characteristics** * Electrical: 1.62V to 5.5V * Operational temperature: -25°C to +85°C * Memory (NVM): 704 KB * Radio Access Technologies: 4G (LTE), 3G, 2G, NB-IoT, LTE-M Download datasheet (Canada G2 Triple Cut) ## Related guides Review pricing information for your SIMs Explore coverage and pricing by country Learn about available SIM form factors # Hologram SIM formats Source: https://docs.hologram.io/guides/sims/hologram-sim-formats Hologram Hyper SIMs and Global eUICC IoT SIMs are available in multiple form factors to suit a wide range of deployments. Hyper SIMs are available in industrial gradetriple cut 2FF/3FF/4FF and embedded DFN8 MFF2 form factors. For more details, see our [SIM card page](https://www.hologram.io/products/global-iot-sim-card/), find detailed hardware and software specifications in our [datasheets](/guides/sims/hologram-iot-sim-datasheets), or order some SGP.02 Hyper SIMs today in the [Hologram Store](https://store.hologram.io/). ## Hologram SIM formats and types | SIM | Spec | Format | Grade | | - | - | - | - | | Hyper SIM | SGP.32 | Triple cut
2FF/3FF/4FF | Industrial | | | | Embedded
MFF2 DFN8 | Industrial | | | SGP.02 | Triple cut
2FF/3FF/4FF | Industrial | | | | Embedded
MFF2 DFN8 | Industrial | | Hyper SIMs | SGP.32 | Triple cut (2FF/3FF/4FF) | Industrial | | | SGP.02 | Embedded (MFF2 DFN8) | Industrial | Hologram also offers SGP.22 eSIMs and Fixed Wireless Access (FWA) SIMs. To learn more, please contact our [sales team](https://www.hologram.io/contact-sales/). ## Previously available SIM formats and types Hologram's Global eUICC Hyper SIMs are no longer manufactured, but details remain for reference. | SIM | Spec | Format | Grade | | - | - | - | - | | Global G1 eUICC SIM | SGP.02 | Triple cut
2FF/3FF/4FF | Standard, Industrial | | | SGP.02 | Embedded
MFF2 DFN8 | Standard | | Canada G2 eUICC SIM | SGP.02 | Triple cut
2FF/3FF/4FF | Standard | ## Related guides Find detailed hardware and software specifications for Hologram Hyper SIMs # Hologram SIM ordering and shipping FAQs Source: https://docs.hologram.io/guides/sims/hologram-sim-ordering-and-shipping-faqs Get answers to some of the most frequently asked ordering and shipping questions about the [Hologram Store](https://hologram.io/store/). ## Where does Hologram ship SIMs? Hologram ships to most countries and territories worldwide using USPS, FedEx, and DHL. Shipping times depend on where the parcel is going to and how close the destination is to one of our warehouses. We also offer options to expedite shipping. A small number of destinations require special handling — see [What if the country I want to ship to is not listed?](#what-if-the-country-i-want-to-ship-to-is-not-listed) below. If you run into any issues with our checkout page, please [contact support](/guides/get-started/contact-support). If you work with our sales team and need to order more SIMs with your custom plan, please submit orders to [support@hologram.io](mailto:support@hologram.io). ## How do I track my order? With regards to tracking shipments, Hologram will send you an email with your tracking number as soon as your order leaves one of our warehouses. This email will come from **[noreply@notifications.hologram.io](mailto:noreply@notifications.hologram.io)** which is the same address used to send you your order confirmation as soon as your order is placed. ## What SIM should I order to get access to high-performance networks in the United States and Canada? Our Hyper SIMs provide permanent roaming in the United States and Canada. Get access to high-performance Tier 1 Native networks in the United States and Canada — or discuss custom coverage options — by contacting your account executive or reaching out to our [sales team](https://www.hologram.io/contact-sales/). ## What if the country I want to ship to is not listed? If you need to ship to one of the following countries, please [contact us](https://www.hologram.io/contact-sales/). * Angola * Belarus * Bermuda * Botswana * Bouvet Island * Brazil * Central African Republic * China * Comoros * Djibouti * Egypt * French Polynesia * Guadeloupe * Liberia * Libya * Maldives * Martinique * Mauritania * Montserrat * New Caledonia * Russian Federation * Saint Barthelemy * Saint Lucia * Samoa * Sao Tome and Principe * Saudi Arabia * Seychelles * Timor-Leste * Turkey * Turkmenistan * United Arab Emirates # How does Hologram use eUICC? Source: https://docs.hologram.io/guides/sims/how-does-hologram-use-euicc Hologram's Hyper SIMs use eUICC to enable global connectivity coverage and perform over-the-air updates to your devices. eUICC on a SIM acts as a sort of digital wallet that lets you use several different “credit cards” (or subscription profiles), all on the same eUICC SIM card. One eUICC SIM can switch between different profiles to adjust connectivity instead of having to physically remove one SIM with one profile for a different SIM with a different profile. Hologram developed Hyper, our eUICC offering, to give M2M users more flexibility with their devices. Hologram handles all the technical integrations so that companies can use eUICC-enabled devices anywhere, with any of Hologram's global carrier partners. This simplifies their supply chains and extends the life (and usefulness) of their devices. Our Outage Proof SIMs extend eUICC capabilities even further, allowing your devices to switch profiles automatically if your SIM loses connectivity. You can read more about how our Hyper SIMs use network fallback to protect you from unexpected downtime [here](/guides/sims/what-is-a-hyper-sim-with-outage-protection/). **Note:** If you're interested in contractually guaranteed reliability with Outage Protection™ for Hyper SIMs, reach out to your Hologram Account Executive or [contact our Sales team](https://www.hologram.io/contact-sales/?utm_source=helpcenter\&utm_medium=guide\&utm_content=what-is-hyper) to learn how you can make outages a thing of the past. ## How does eUICC work? Read more about how eUICC works [in our overview article](https://www.hologram.io/blog/euicc-what-it-is-and-how-it-works/?utm_source=helpcenter\&utm_medium=guide\&utm_content=what-is-hyper). ## What eUICC SIMs does Hologram offer? Every Hyper SIM Hologram ships is eUICC-enabled. Visit [Hologram's SIM overview](https://www.hologram.io/products/global-iot-sim-card/) to learn more about the SIMs we offer and how to get started. Hologram also offers some UICC SIMs including some legacy SIMs and SGP.22 SIMs. ## Is my device compatible with eUICC? eUICC operations utilize industry-standard methods of communication between the cellular module and eUICC SIM card such as BIP (Bearer Independent Protocol), SMS, and SIM toolkit AT commands. Outside of these common SIM and module functions, no additional requirements are typically required for IoT devices to support eUICC capability. *If your device works with UICC SIMs it will work with EUICC SIMs*. [Read more about Hologram's eUICC SIMs](/guides/sims/how-does-hologram-use-euicc) ## Does Hologram offer eUICC compatibility testing? [Contact our Sales team](https://www.hologram.io/contact-sales/?utm_source=helpcenter\&utm_medium=guide\&utm_content=euicc-compatibility) to learn more about how to best use eUICC in your organization, and to learn more about how our [Hyper SIMs with Outage Protection](/guides/sims/what-is-a-hyper-sim-with-outage-protection/) can protect you from costly downtime. As part of onboarding to Hologram, we can remotely run eUICC test operations with your device to validate successful over-the-air profile management operations through the Hologram management platform. ## Related actions View and understand SIM identification numbers Review pricing information for your SIMs Learn about automatic profile switching for reliability # How do I organize my devices and SIMs? Source: https://docs.hologram.io/guides/sims/how-to-organize-your-fleet Keep your fleet organized with tags and consistent naming conventions. ## Find your SIMs in your dashboard Your dashboard makes it easy to find and act on all the SIMs in your fleet. Open the **SIMs** section in the main menu to find all the SIMs in your organization, broken down into three views: * The [Active SIMs](/dashboard/sims/sims-active) page opens by default and contains all SIMs that have been activated and are able to use data and connect to the internet. * The [Pre-deployment SIMs](/dashboard/sims/sims-predeployment) page contains all SIMs configured for pre-deployment testing that have not yet been activated, if you have [access to Test Mode](/guides/sims/test-mode). * The [Deactivated SIMs](/dashboard/sims/sims-deactivated) page is a record of all SIMs that have been permanently deactivated from Hologram's network. Deactivated SIMs cannot be reactivated. Use these views of your SIMs to sort, filter, export, and take bulk actions on your entire fleet. The **Filters** pane on the left helps you narrow down to specific SIMs you need to act on, then select SIMs and use the **Manage SIMs** button to find all the bulk actions you can take on the SIMs you have selected. Read more about [filtering your SIMs](/dashboard/sims/sims-filters) and [taking bulk actions](/dashboard/sim-actions/bulk-actions-overview). ## Use tags to organize and report on your fleet Tags are labels you can apply to SIMs to: * Group related SIMs together (e.g., "Warehouse Cameras", "Temperature Sensors", "East Coast"). * Filter and search for specific groups of SIMs. * Apply bulk actions to tagged groups. * Generate reports and analytics by tag categories. ## Establish consistent naming conventions When activating tens, hundreds, thousands or even tens of thousands of SIMs at once, giving the SIMs specific names will help you keep track of your devices. This is especially true if you have a data management system that gives your hardware a specific name. ## Related actions # Device location and location history Source: https://docs.hologram.io/guides/sims/location-and-history View approximate tower location information and location history for your Hologram SIMs You can find **approximate location information** for the tower your SIM is connected to in the device's page in the SIMs section of your [dashboard](https://dashboard.hologram.io/). We provide approximate, crowd-sourced tower location data based on tower information from sessions shared with us from individual networks. **Important:** We provide location information for approximate troubleshooting of SIM behavior. Tower location information should not be relied on as a precise reporting tool. * **Some networks do not provide location information.** * **Some networks do not provide location information for every session.** This can cause location to sometimes "disappear" for a SIM. * **Crowdsourced location data information may be inaccurate or out-of-date.** ## SIM location information Tower location provides region, country, latitude, and longitude information that is useful for troubleshooting and reporting. The data provided is based on the network's tower location records, so accuracy varies by network. For dense cities the location of the SIM should be within a 1 kilometer (0.62 mile) radius. For more accurate location information or any real-time location-sensitive application, use a GPS module. You can also [look up a device's location using the REST API](/guides/rest-api/determine-devices-location-via-the-rest-api). ### Location data for a single SIM SIM location can be found in two locations within a SIM's details page. First open a SIM from the **SIMs** section in your dashboard or using search. In the **Status** tab, location information — if known — will display in the **Last connection** and session details along with a map. The tower location coordinates links to Google Maps. Status tab showing location information with map and coordinates Historical location information for a SIM can be found by opening the **Data usage** tab in the **Usage by network** card. Usage reporting tab showing session history with location data If you have access to full historical reporting, you can find location information by opening the **Data usage** tab in the **Session history** and **Location history** tabs. Usage reporting tab showing session history with location data ### Location data across your fleet Historical location information across your entire fleet is available at the session level by downloading the **Data usage by session** report found under the **Usage** section of your dashboard. Country, tower ID, and approximate latitude and longitude—if known—will be listed for all sessions in which we have them. Please note the disclaimer at the top of this page for location availability. *If you have access to full historical reporting*, you can find location information in two places. The **By SIM** tab will let you find usage by SIM, grouped by network. The **By location** tab will additionally break down usage by country and tower ID, with a map of approximate tower location. Usage reporting tab showing session history with location data *If you have access to recent usage*, the **By location** tab will group recent data usage by country, network, and tower ID. Usage reporting tab showing session history with location data *If you have access to full historical reporting*, you can find location information at the session level in the **By session** tab. Each session has network, country, tower ID, and approximate latitude and longitude coordinates for the tower location. Usage reporting tab showing session history with location data   **Restrict access:** Contracted organizations can optionally remove location data access. Learn more by contacting our [sales team](https://www.hologram.io/contact-sales?utm_source=docs\&utm_medium=website\&utm_content=location_data_callout). ## Related guides # View and organize SIMs in your dashboard Source: https://docs.hologram.io/guides/sims/organize-sims Navigate and manage your fleet of SIMs across Active, Pre-deployment, and Deactivated pages ## Active SIMs The default view of your SIMs shows all Hologram SIMs that have been activated, are charged a per-SIM monthly recurring charge for access to our platform and network, and are able to connect to the internet. This includes all Paused and Ready SIMs in a `LIVE...` or `PAUSED...` network state. Active SIMs are sorted by Last closed session date to help find SIMs with recent connections quickly. Active SIMs page showing all activated SIMs with status and usage columns * **Name** – Name given to this SIM card. * **SIM status** – The status of this SIM, which helps describe its ability to use data. Hover for a detailed description * **Last closed session** – Date and time in UTC of the last closed session for the SIM. This is when data is billed and how we calculate data usage. * **Data usage** – Data usage for the SIM's *current billing period*. For prepaid/self-service billing, data usage is for the SIM's unique 30-day billing period. For postpaid invoiced billing, data usage is for the current calendar month. * **Enabled profile ICCID** – ICCID of the currently enabled profile able to use data. Click to view the SIM's installed profiles and fallback events. * **Profile name** – Name of the enabled profile, which generally describes available carrier coverage. * **Manufactured profile ICCID** – ICCID(s) of the profile(s) installed on the SIM during manufacturing. These ICCIDs are printed on physical SIM cards. * **Last known IMEI** – IMEI of the last known device associated with the SIM, if known and provided by a carrier or network. * **SIM ID** – Hologram's unique ID for a SIM card: `hologramSimId` * **Data plan** – Name of the currently active data plan which determine's a SIM's coverage and cost. * **Activation date** – Date and time in UTC that this SIM was activated and was able to begin using ## Pre-deployment SIMs This page lists all SIMs that have not yet been activated, including all SIMs configured for pre-deployment testing using Test Mode. If you do not have access to pre-deployment testing with Test Mode, you can [learn more about it here](/guides/sims/test-mode). This includes all pre-deployment SIMs in a `TEST...` or `AVAILABLE` network state. This table shows the pre-deployment testing configuration of each SIM, its total data usage, and the target activation date at which the SIM will automatically activate if it has not yet used its available test data or SMS messages. Pre-deployment SIMs can also be manually activated out of test mode if you need to avoid configuration downtime after a device is delivered to your customers for SIMs with a Global-1 profile. Pre-deployment SIMs page showing SIMs in test mode with target activation dates * **Name** – Name given to this SIM card. * **SIM status** – The status of this SIM, which helps describe its ability to use data. Hover for a detailed description. * **Configuration** – The configured Test Mode free testing period for this SIM. * **Last closed session** – Relative time in UTC of the last closed session for the SIM. This is when data is billed and how we calculate data usage. * **Data usage** – Lifetime data usage for this SIM. SIMs in pre-deployment testing automatically activate after a session closes in which the SIM used at least 100 KB of data. * **Target activation date** – The date at which this SIM will automatically activate after its free test period ends. * **Data plan** – Name of the data plan which determine's this SIM's coverage, and will determine its cost after the SIM is activated and exits testing. * **Enabled profile ICCID** – ICCID of the currently enabled profile able to use data. Click to view the SIM's installed profiles and fallback events. * **Profile name** – Name of the enabled profile, which generally describes available carrier coverage. * **Manufactured profile ICCID** – ICCID(s) of the profile(s) installed on the SIM during manufacturing. These ICCIDs are printed on physical SIM cards. * **Last known IMEI** – IMEI of the last known device associated with the SIM, if known and provided by a carrier or network. * **SIM ID** – Hologram's unique ID for a SIM card: `hologramSimId` * **Activation date** – Date and time in UTC that this SIM was activated and was able to begin using data. ## Deactivated SIMs Deactivated SIMs are permanently disabled, removed from Hologram's network, and are not able to be reactivated. SIMs are most often deactivated when they are no longer needed, a device is lost, destroyed, stolen, or on accident. You may still need to refer to past data usage or configuration information on these SIMs, and can find them here or by searching for them. We sort these SIMs by the most recently deactivated first by default. Deactivated SIMs page showing permanently disabled SIMs * **Name** – Name given to this SIM card. * **Enabled profile ICCID** – ICCID of the last enabled profile on the SIM. * **Profile name** – Name of the last enabled profile on the SIM. * **Manufactured profile ICCID** – ICCID(s) of the profile(s) installed on the SIM during manufacturing. These ICCIDs are printed on physical SIM cards. * **Last known IMEI** – IMEI of the last known device associated with the SIM, if known and provided by a carrier or network. * **SIM ID** – Hologram's unique ID for a SIM card: `hologramSimId` * **Data plan** – Name of the currently active data plan which determine's a SIM's coverage and cost. * **Deactivation date (UTC)** – Date and time in UTC that this SIM was permanently deactivated from the Hologram Network. ## Export SIMs You can export all your SIMs using the Export SIMs button in the SIMs pages. You can export to XLSX, CSV, or JSON formats, and the exports will honor any filters you have applied or selections you have so that you can export exactly the data you need. [Read more about exporting SIMs 👉](/dashboard/sims/sims-export) ## SIM filters Filters help you find exactly the SIMs you are looking for so that you can take action on them quickly, or export specific sets of SIMs. The SIM counts above the table show you exactly how many SIMs match your filters and that you have selected. If you have selected multiple devices, your selections will remain even if the SIMs disappear from view. * **Tags** - Filter SIMs by any tag created in your organization. * **SIM status** - Filter by SIM status. Each page shows all possible statuses that could display in that page. * **Last closed session** - Filter by the last closed session for each SIM, using a specific timeframe. This defaults to a custom timeframe ending today, or choose a preset range. This filter uses your local time zone so that you don't have to do extra math to determine time zone differences against UTC, which is used in the Last Active column. * **Enabled profile ICCID** - Filter SIMs by the currently enabled profile. ICCIDs are unique to a profile and can change due to fallback events or over-the-air profile updates. The default "Contains" filter will show ICCIDs that match the entered ICCID exactly and is exactly as fast as the "Is" filter. * **Name** - Filter by SIM name, using a "contains" search. * **Manufactured profile ICCID** – ICCID(s) of the profile(s) installed on the SIM during manufacturing. These ICCIDs are printed on physical SIM cards. * **Last known IMEI** - Filter by the last known device IMEI for a SIM, if provided by a carrier and network. The default "Contains" filter will show IMEIs that match the entered IMEI exactly and is exactly as fast as the "Is" filter. * **Data plan** - Filter by all data plans available to your organization. If you have a contracted account with Hologram, data plans with negotiated rates display at the top of the list. * **Activation date** - Filter SIMs by the date the SIM was activated, using a specific timeframe. This filter works identically to the **Last active** filter. * **Target activation date** - Filter pre-deployment SIMs by the date the SIM will be automatically activated out of test mode testing, using a specific timeframe in the future. Other than the time ranges, this filter works identically to the Last active and Activation date filters. [Read more about filtering SIMs 👉](/dashboard/sims/sims-filters) ## Manage SIMs bulk actions Use filters and select SIMs in the table to take bulk actions on any number of SIMs using the **Manage SIMs** menu. The SIMs you have selected will stay selected even if you change filters or navigate away from the page. [Read more about available bulk actions 👉](/dashboard/sim-actions/bulk-actions-overview) # What is Outage Protection™? Source: https://docs.hologram.io/guides/sims/outage-protection Hologram's multi-core SIMs with Outage Protection can switch mobile cores automatically in the case an installed profile loses connectivity, protecting you from downtime and outages. When a SIM switches connectivity profiles automatically, we call this a **Outage Protection**. ## Applicability The Outage Protection Service Commitment described below applies only to Customers who have an active contract or Master Service Agreement (MSA) with Hologram explicitly stating that Outage Protection is included. If no such agreement exists, the Outage Protection Terms and Service Commitment **do not apply**. ## Multi-Core SIMs Hologram's Multi-Core SIMs are SIMs that combine two profiles, providing connectivity via a minimum of two network providers, on a single SIM card with fallback capability enabled. In the event of a loss of Individual Network Availability (as defined below) of the primary network provider ("Network Provider 1"), a Multi-Core SIM can switch profiles and automatically attempt to connect via the secondary network provider ("Network Provider 2"). All Multi-Core SIMs deployed in the USA are guaranteed access to at least one Tier-1 USA or Canada backup network in that respective country through Network Provider 2. ## Outage Protection™ Service Commitment Hologram shall use commercially reasonable endeavors to ensure that the Multi-Core SIM service Combined Network Availability, as defined below, is equal to or greater than 99.95% for any given calendar month (the "Service Commitment") for Multi-Core SIMs that are active, powered, and attempting to connect to a cellular network. In the event of a loss of Individual Network Availability, as defined below, of Network Provider 1, resulting in the modem signaling to the SIM that it has entered a limited service or no service state, and after no more than one hour of the SIM being continuously powered and the modem attempting to connect while in a limited service or no service state, a Multi-Core SIM can switch profiles so that a modem can automatically attempt to connect via Network Provider 2. In the event that Hologram does not meet this Service Commitment, Customer will be eligible to request a Service Credit as described below. For Multi-Core SIMs to switch profiles and operate as expected, a modem must support "proactive polling" and must send "STATUS" events to the SIM that indicate entering and leaving the states of limited service and no service on an interval of once every twenty to thirty seconds, and without interruption of this interval, as described in the 3GPP's Card Application Toolkit specifications (e.g. ETSI TS 102.221 and ETSI TS 102.223). For the avoidance of doubt, a lack of modem or device support shall not be considered an Outage, as defined below. For purposes of this Agreement, (1) "Individual Network Availability" shall mean for each network provider (each of Network Provider 1 and Network Provider 2) that the particular network provider allows modems to attach to a tower and establish a PDP context when using the correct/compatible modem configuration and APN configuration for Hologram's services; (2) "Combined Network Availability" shall mean whether or not a provider (at least one of either of Network Provider 1 or Network Provider 2) allows modems to attach to a tower and establish a PDP context when using the correct/compatible modem configuration and APN configuration for Hologram's services on those towers for which a SIM is contractually allowed access; and (3) "Outage" shall mean a loss of Combined Network Availability that results in a Combined Network Availability Percentage (as defined below) of less than 99.95%, but shall exclude the percentage of time (no more than one hour) prior to the Multi-Core SIM switching profiles, and a lack of coverage or contractual access to a network shall not be considered an Outage. ## Combined Network Availability Percentage The "Combined Network Availability Percentage" is calculated by subtracting from 100% the percentage of eligible minutes during the month that the Multi-Core SIMs faced a loss of Combined Network Availability and did not meet the Service Commitment. Combined Network Availability calculation periods are based on full calendar months, commencing at 00:00:00 on the first calendar day of the month to 23:59:59 on the final calendar day of the month. Note that scheduled/planned downtime (such as planned works) and the exclusions set forth in the Multi-Core SIM Service Commitment section and Service SLA Exclusion section, are not considered Outage periods and therefore not subject to the 99.95% availability commitment. ## Service Credits A "Service Credit" is a US dollar credit, calculated using the formula set forth below, that will be credited to Customer's Hologram account for assignment towards future Hologram service charges. Service Credits are calculated based solely on the monthly recurring charges and data charges attributable to Multi-Core SIMs with Outage Protection enabled that were affected by the Outage, excluding charges for any other SIM types, devices, or services. ### Combined Network Availability Percentage / Service Credit Percentage #### Less than 99.95% but equal to or greater than 99.0%: * Customer will receive 10% of the monthly recurring charges and data charges for affected Multi-Core SIMs with Outage Protection enabled in the month preceding the Outage as a Service Credit. #### Less than 99.0%: * Customer will receive 25% of the monthly recurring charges and data charges for affected Multi-Core SIMs with Outage Protection enabled in the month bill preceding the Outage as a Service Credit. Hologram will apply any Service Credits only against future payments due for Hologram services from Customers . Service Credits do not entitle Customer to any form of cash refund from Hologram at any time. A Service Credit will only be applicable and issued if the credit amount for the applicable billing monthly billing cycle is greater than one hundred dollars (\$100 USD). Service Credits may not be transferred or applied to any other accounts. ## Service Credit Claims To receive a Service Credit, Customer must submit a claim by sending an email to [support@hologram.io](mailto:support@hologram.io). Service Credit requests will only be accepted if they are submitted within thirty (30) calendar days of the claimed incident occurred and must include in the e-mail: the words "Outage Protection Service Credit Request" in the subject line; the dates, incident times and durations of the incidents you are claiming; the affected Hologram devices and service that experienced the disruption; a copy of your service logs and/or screenshots that support or corroborate your claimed service Outage; and any Hologram success e-mails and responses you receive from Hologram regarding the incident in question. If the Combined Network Availability Percentage of such request is confirmed by Hologram and is less than the Service Commitment, then Hologram will issue the Service Credit to Customer within one (1) billing cycle following the month in which Customer's request was confirmed by Hologram. Customer's failure to provide the request and other required information outlined above, within the agreed timeframe, will disqualify Customers from receiving a Service Credit. ## Service SLA Exclusions Hologram's Service Commitment, in addition to as set forth above in "Outage Protection Service Commitment", does not apply to any unavailability, suspension or termination of Hologram Cloud Services, or any other Hologram performance issues: (i) that result from a suspension due to breach of contract as outlined in this Agreement; (ii) caused by factors outside Hologram's reasonable control, including any force majeure event or internet access or related problems beyond the demarcation point of Hologram cloud services; (iii) that result from any actions or inactions of Customers or any third party; (iv) that result from Customer's equipment, software or other technology and/or third party equipment, software or other technology (other than third party equipment within Hologram's direct control); or (v) that result during normal planned and scheduled maintenance periods as determined by Hologram. Finally, if Combined Network Availability is impacted by factors other than those used in Hologram's Combined Network Availability Percentage calculation, then Hologram may issue a Service Credit after considering such factors at Hologram's discretion. Hologram's Service Commitments do not apply. Customers are in breach of this Agreement. # All about Hologram SIMs Source: https://docs.hologram.io/guides/sims/overview ## Hologram SIM hardware ## Outage Protection™ Learn how to make downtime a thing of the past with Outage Protection ## Test Mode Learn more about getting free data for testing and manufacturing with Test Mode ## Coverage and network availability ## Performance ## Ordering and shipping # Profile performance in the U.S. Source: https://docs.hologram.io/guides/sims/profile-performance-in-the-us Evaluate how latency and throughput performance informs which profile is best suited for your use case. ## Evaluate how latency and throughput performance informs which profile is best suited for your use case Selecting the right connectivity is not just about evaluating coverage. Latency and throughput performance play critical roles in ensuring you get the performance you need for your deployment. Hologram offers different profile configurations and the flexibility to change profiles with our Hyper SIMs, so you can confidently choose the right profile. ## Latency Latency measures how long it takes for data to travel from one point to another. Low latency is ideal, since it means data is transferred quickly between device, network, and outcome. IoT use cases that require especially low latency include industrial automation with a fast response time or video streaming that can't experience disruptions. All Hologram U.S. profiles achieve latency below 300ms, which is sufficient for most applications. If your use cases demand more, we offer profiles that can go as low as 50ms latency, giving you the flexibility and performance you need. Chart showing latency performance across different Hologram U.S. profiles ## Throughput Throughput measures how much information a system can process in a given amount of time. High throughput is ideal as it allows more information to pass through in a given timeframe and is most relevant for use cases with high data consumption in a short period of time. When testing throughput, it's important to test at different times of the day that may see differing network loads. Hologram monitors throughput at various locations globally. In the example below, hourly tests over a five day period were conducted with all profiles having an average downlink throughput exceeding 19.5Mbps. Chart showing throughput performance measurements across Hologram profiles over a five day period ## We take testing seriously, so you can choose confidently All Hologram profiles are built and tested thoroughly to maximize your performance and ensure reliable connectivity. With Hologram's Outage Proof SIMs, you also get the added flexibility of switching installed profiles on-demand, or working with us to change profiles over the air. While the performance measurements above give you a starting point for how to evaluate profiles, our team of experts can work with you to evaluate which is the best fit for your unique use case. We're more than a carrier — we're your partner. Reach out to our team at any time ## Related actions Learn about profile switching and Outage Protection capabilities View coverage details for your SIMs Understand how devices select and connect to networks # Where can I purchase Hologram SIMs? Source: https://docs.hologram.io/guides/sims/purchase-hologram-sims You can purchase Hologram Hyper SIM cards directly from [our store](https://store.hologram.io/store/) in quantities of 1 to 1,000. If you're just getting started, you can purchase a free pilot SIM [card from our store](https://store.hologram.io/) using the code **`FREEPILOTSIM`** to help you get connected. For larger pilots and deployments, for more information on our Hyper SIM cards, embedded SIMs, or Outage Protection™, please contact [our Sales team](https://www.hologram.io/contact-sales?utm_source=docs\&utm_medium=website\&utm_content=purchase_sims). SIM cards ship with no lead time globally in any order quantity. # Return and refund policy Source: https://docs.hologram.io/guides/sims/return-and-refund-policy At Hologram, our goal is to make sure that you are happy with our products and services. If you have any issues with the SIMs you have received, please email us at [support@hologram.io](mailto:support@hologram.io). ## Hologram SIMs Due to the nature of the information printed on Hologram SIMs, we are not able to accept returns or provide refunds regardless of their condition. ## Items damaged during shipping If your package was damaged during shipping please [contact support](/guides/get-started/contact-support) with pictures and a description of your package within 7 days of receiving it. ## Return and refund guidelines For all returns and refunds, [contact support](/guides/get-started/contact-support) with your order ID number and a brief description of why you are returning the item. We encourage you to also send pictures of your order to help us better understand what is going on. With the exception of manufacturing defects, all return shipments are not covered by Hologram. Furthermore, a restocking fee may be applied based on the condition of the returned goods. Hologram reserves the right to limit or deny support for purchases placed more than one year prior to the date of contacting support and of unsupported products. ## Return Summary | Item | SIMs | | :- | :- | | Refund Eligibility | Not allowed | | Method of Refund | N/A | | Product Condition: | N/A | | Refund Contact Info | [support@hologram.io](mailto:support@hologram.io) | | Charges | N/A | **Note:** Terms are subject to change by Hologram in its sole discretion at any time. # Pre-deployment testing with Test Mode Source: https://docs.hologram.io/guides/sims/test-mode **Hologram Test Mode** is a set of tools and capabilities to streamline the cellular IoT supply chain for your organization. Test your devices with free data, deploy to your customers seamlessly, and minimize costs. **Limited access:** Learn more about Test Mode and streamline your deployments by contacting our [sales team](https://www.hologram.io/contact-sales?utm_source=docs\&utm_medium=website\&utm_content=test_mode_callout). ## Benefits of pre-deployment testing ### Manage inventory Rather than manually activating devices, Hologram Test Mode provides a **clear view of your SIM inventory** and allows you to test devices **before incurring monthly subscription costs**. As soon as SIM cards ship from our warehouse, all SIMs will appear in the SIMs section your dashboard under the Pre-deployment page. You can then tag your SIMs to organize them based on hardware, contract manufacturer, staging location, or final deployment region. ### Automate your workflow Your devices in Hologram Test Mode will **automatically activate on a specific data plan** after using their free data, with no downtime or actions needed on your part. ### Powering a seamless supply chain Ensure that devices are fully tested and QA-approved before leaving your warehouse or manufacturer. SIMs in Test Mode come with 90 days of testing. This includes 100 KB of free data and up to 10 free device-originated SMS messages. ## How is a SIM in Test Mode configured? Each SIM in Test Mode can use **up to 100 KB of free data** and **up to 10 device-originated SMS messages** on the Hologram network. These SIMs have **90 days to use this data for free** before they automatically activate. A SIM will automatically activate under any of the following conditions, whichever comes first: * 100 KB of data is used * 10 outbound SMS messages are sent * 90 days of Test Mode have elapsed Upon activation, the SIM will transition to the preconfigured data plan set when the SIMs were ordered with no action needed on your part. ## How does Test Mode work SIMs in Test Mode allow your manufacturer to **test cellular connectivity** and **verify device functionality**. 1. Hologram SIMs ship from our warehouse to your hardware manufacturer. Once shipped, these SIMs will show up under the **SIMs section** of your dashboard under the **Pre-deployment page**. Pre-deployment page in dashboard showing SIMs in Test Mode 2. These SIMs are configured with **Test Mode**. Once your SIMs are configured for testing and ready to use test data, they will have the **In testing** status in your dashboard. The SIM's state often referenced in the API will be set to `TEST-ACTIVATE`. 3. Once your devices reach their final deployment destination, they will **automatically activate** once they reach their test data or testing duration. They are automatically configured with the **correct cellular data plan** and capabilities with no additional action needed on your part. ## Where can I find more detailed reporting of SIMs in Test Mode Dashboard's usage reports enables better **inventory management, activation tracking, and optimization of testing timelines** for your IoT deployment. 1. Comprehensive data usage and activation reporting on SIMs in Test Mode can be found under the **Usage section** of your dashboard in the **Pre-deployment SIMs page**. Usage page showing Pre-deployment SIMs reporting 2. The **SIMs in testing** report lists a complete inventory of all SIMs currently configured with Test Mode, allowing you to track which devices are still in the testing phase. 3. The **Activation History** report shows a record of SIMs that have **recently transitioned from Test Mode to active status**, providing visibility into your activation history. 4. From the **SIMs page** in your dashboard, you can also **Export** all your SIMs currently in Testing with similar detailed information found on these usage reports. # What are typical data transmission speeds? Source: https://docs.hologram.io/guides/sims/what-are-typical-data-transmission-speeds Expected cellular speeds for IoT devices and considerations for Cat-M1 and NB-IoT. Cellular data speeds vary by coverage, tower load, radio technology, and device configuration. Hologram SIMs can access 2G, 3G, 4G/LTE, and LTE-M where available. ## Cat-M1 speeds Cat-M1 is designed for lower power and lower bandwidth IoT links. Typical uplink/downlink is around 375 kbit/s in half-duplex, suitable for small to medium payloads. ## NB-IoT Optimized for low-bandwidth tasks (sensors, small telemetry, and infrequent messages). ## Profile performance For U.S. latency/throughput guidance, see: [Profile performance in the U.S.](/guides/sims/profile-performance-in-the-us) ## Related actions Explore coverage and pricing by country Review and select your data plan options Learn about latency and throughput metrics # What communication protocols are compatible with Hologram SIMs? Source: https://docs.hologram.io/guides/sims/what-communication-protocols-are-compatible-with-hologram-sims Overview of methods for sending data to and from devices using Hologram SIMs, including Hologram Cloud messaging, direct IP, Spacebridge tunneling, and SMS. There are a number of options available for sending data to and from your cellular device. In the table below, **Outbound** refers to sending data *from* the device, and **Inbound** refers to outside data sent *to* the device. ## How can I communicate with my device using a Hologram SIM? | Method | Outbound | Inbound | Pricing | | - | - | - | - | | Hologram Cloud messaging (TCP/UDP) | No | Yes | Data usage | | Direct IP | Yes | No | Data usage | | Spacebridge IP device tunneling | No | Yes | Data usage | | SMS via Hologram Cloud | Yes\* | Yes | Outbound: Data usage
Inbound: Free | | Circuit-switched SMS | Yes | Yes | Outbound: Per message
Inbound: [Purchase a phone number](/guides/communication/purchase-a-phone-number-to-send-sms-messages-to-a-sim) | Per-MB data usage pricing and per-message SMS pricing depends on your billing data plan. Check our [Pricing](https://hologram.io/pricing/) page for details. ## Hologram Cloud messaging The Hologram Cloud is the easiest way to send data between your device and the internet. The mechanisms for inbound and outbound communication are somewhat different, but in both cases, the Hologram cloud forwards messages between the device and the internet using the device's cellular data. ### Inbound (TCP/UDP to device) Hologram exposes an [API endpoint](/guides/cloud-and-tools/what-is-hologram-cloud-messaging) and [an interface in your dashboard](/dashboard/sim-actions/send-messages-to-sims) to send TCP or UDP messages to any port on your cellular device. This requires that your device runs embedded Linux or otherwise implements a networking stack. The Hologram Cloud translates the API requests (or submissions through your dashboard) into raw TCP/UDP messages and sends them to the desired device. ## Direct IP Devices on the Hologram cellular network have access to the full internet, so you may use any IP-based protocol to communicate with any internet-routable host. In fact, Hologram's Cloud messaging API relies on this standard IP connectivity. Advanced users may wish to bypass the Hologram Cloud and instead communicate directly with servers they control. For security Hologram cellular devices do not have internet-routable IP addresses, so you can't connect to your device directly from the internet. This means that to send data *to* your device, the device must first establish a connection to an outside server and request the data. The server can then send data back to the device in a response using the already-established connection. This *request-response* pattern is the basis for many common protocols such as HTTP. If device-originated requests aren't a good fit for your application, you can connect to your device via a tunnel, covered in the next section. ## Secure device tunneling with Spacebridge Since devices on the Hologram network do not have internet-routable IP addresses, it's not possible to directly connect to the devices over the internet. This makes it hard to use the device as a server that can listen for incoming requests. The solution is to establish a connection–or *tunnel*–through a different server which does have the ability to connect to your device. Hologram provides a service called [Spacebridge](/dashboard/sim-actions/spacebridge-tunneling), which uses secure SSH tunneling to let you connect to any port on your device. The inbound Cloud Messaging feature above relies on a Spacebridge tunnel behind the scenes. The Cloud Messaging approach is a simpler alternative to Spacebridge if you don't require direct access to the network socket. See our [device tunneling guide](/guides/communication/device-tunneling-for-beginners) for details. ## SMS via Hologram Cloud ### Outbound (from device) Outbound SMS messages [sent via API](/api/1/sms/outgoing/post) will appear as originating from an internal Hologram phone number. This is the case even if you have bought a phone number for receiving inbound SMS messages. ### Inbound (to device) Even if you don't buy a phone number for your device, you can send SMS messages to it from [your dashboard](/dashboard/sim-actions/send-messages-to-sims) or [REST API](/api/1/sms/incoming/post). You may also configure the phone number that the SMS will appear to originate from. To read inbound SMS messages on the device, use AT commands to request them from the modem or follow the equipment's instructions. ## Circuit-switched SMS ### Outbound (from device) To send an SMS via the standard SMS switching network, use AT commands to request them from the cellular modem. Outbound SMS messages will appear as originating from an internal Hologram phone number. This is the case even if you have bought a phone number for receiving inbound SMS messages. Device-originated SMS messages have a cost associated to them based on the data plan the SIM is under. ### Inbound (to device) To receive SMS messages from other SMS-capable devices, you must buy a [dedicated phone number](/guides/communication/purchase-a-phone-number-to-send-sms-messages-to-a-sim) for your Hologram device. To read inbound SMS messages on the device, use AT commands to request them from the modem or follow the equipment's instructions. ## Related actions Send TCP, UDP, or SMS messages to your devices Establish secure SSH tunnels to your devices Forward device messages to external services Enable inbound SMS from external numbers # What is a Hyper SIM with Outage Protection™? Source: https://docs.hologram.io/guides/sims/what-is-a-hyper-sim-with-outage-protection Overview of Hologram Hyper SIMs with Outage Protection, network fallback, benefits, and FAQs. No network is fail proof, and a single outage can devastate your business. That's why Hologram developed **Outage Protection** on our Multi-Core Hyper SIMs. With two fully independent mobile cores on a single SIM, it offers total redundancy and reliability, making it the strongest outage protection in IoT history. Each SIM with Outage Protection is uniquely equipped with two connectivity profiles, doubling your network resilience. If a core failure or outage prevents your SIM from connecting to its primary network, our built-in configurable **Fallback** technology immediately switches to a secondary network. It's a seamless handover that ensures your devices stay online, with very minimal downtime. Diagram showing how Hologram Hyper SIMs with Outage Protection work Diagram showing how Hologram Hyper SIMs with Outage Protection work ## What Multi-Core SIMs does Hologram offer? Hologram's Multi-Core SIMs are designed to fit your unique needs, whether you're optimizing for cost, performance, or roaming coverage. Multi-Core SIMs provide the ultimate redundancy and reliability, with access to two completely independent mobile cores and distinct profiles. ### Global SIMs with Outage Protection Access two global networks, with twice the roaming coverage from 500+ carriers in 200+ countries. Diagram showing how Hologram Hyper SIMs with Outage Protection work Diagram showing how Hologram Hyper SIMs with Outage Protection work ### Performance SIMs with Outage Protection Connect with Tier-1 providers in the US or Canada, backed up by a global roaming profile. With low latency and high throughput, these SIMs are designed for exceptional performance. Diagram showing how Hologram Hyper SIMs with Outage Protection work Diagram showing how Hologram Hyper SIMs with Outage Protection work ## How does network fallback work? The simplest way to think of network fallback is as a timer that communicates with the cellular modem and is constantly watching for extended periods without network connectivity. When the modem begins experiencing a period of limited or no service, the timer starts. Once the timer reaches a customizable threshold, it automatically executes an eUICC profile operation to enable the fallback profile and attempt to reconnect to the Internet. If it is successful in doing so, it lets the Hologram platform know that a fallback event has occurred and stays connected with the backup profile until it receives further instruction. Here are some additional things to know about network fallback: * The default timer value for network fallback is **15 minutes**. * By default, network fallback also supports **reverse fallback** - switching from a backup profile to the primary profile - based on the same trigger conditions. * Network fallback supports multiple customizable trigger thresholds including some that are volatile (will reset if the device is restarted) and nonvolatile (can persist between device resets). ## What are the benefits of Outage Protection? The biggest benefit of network fallback is a significant reduction in the duration of incidental loss of connectivity (from hours or days to minutes). Although cellular networks are considered to be highly available and reliable compared to alternate wireless protocols (ex: Wi-Fi), periodic loss of connectivity caused by lost coverage, network downtime, or device roaming is inevitable. These outages may take hours or even days to resolve, stranding the device without connectivity without recourse. This downtime may result in lost data, lost revenue, or failures of mission-critical operational systems. Multi-Core SIMs help devices that get disconnected reconnect quickly using an alternate connectivity profile so they can resume normal operation in minutes. ## What are the primary use cases for network fallback? There are three primary use cases for network fallback: 1. **Resiliency to downtime.** As discussed above, product creators may wish to add and link a backup profile to their SIM with network fallback to attempt to automatically reestablish connectivity to prevent lost data or revenue in the event the primary profile loses connectivity. 2. **Regional profile selection.** Many product creators have primary markets that drive the majority of their demand, and long tails of international customers that may benefit from an alternate connectivity solution due to cost or performance considerations. Stitching multiple profiles together with network fallback allows SIMs to automatically localize connectivity to the most effective profile without building and supporting multiple individual SKUs. 3. **Combining coverage footprints.** In rare instances, Hologram's connectivity relationships may not enable access to every carriers in a particular country using a single connectivity profile, or may provide more cost-effective access to the same carrier via a different profile. Linking multiple profiles together using network fallback allows devices to access the richest selection of carriers at the best possible cost, all on a single SIM. ## Can I customize the behavior of network fallback on my SIMs? Yes! Network fallback was designed with thoughtful defaults that work with most applications. Fallback behavior can be thoroughly customized to meet the needs of your application as part of a professional services engagement with us. [Contact our Sales team](https://www.hologram.io/contact-sales?utm_source=helpcenter\&utm_medium=guide\&utm_content=dual-core-sims) to learn more. * Turning network fallback ON or OFF * Setting trigger thresholds for network fallback (15 minute default) * Changing the default profile your SIM ships with * Turning reverse fallback ON or OFF ## FAQs [Contact our Sales team](https://www.hologram.io/contact-sales?utm_source=helpcenter\&utm_medium=guide\&utm_content=dual-core-sims), or if you already work with an Account Executive reach out to ask about how Outage Protection can protect your connectivity. Network fallback tracks limited and no service status messages from the modem and evaluates them against a threshold that triggers the SIM to enable the backup profile. Limited and no service status events can occur in any of the following scenarios: * The network is not available (outage or coverage) * The profile is paused while the device is powered * The profile is blocked from accessing a carrier by the underlying steering for its connectivity plan You can also manually switch enabled profiles using our REST API and bypass the network fallback timer. The SIM intelligence that enables network fallback is signed and encrypted at the time the SIM is provisioned, and thus can only added at the time of SIM manufacturing. Support for network fallback cannot be flashed or added to SIMs previous generation Hyper or UICC SIMs from Hologram shipped prior to June 2023. Network fallback is supported on all Hologram SIMs shipped after November 2023. For older SIMs, the SKU printed on your SIM will end in `-F` or `-AFB` and were commonly called Dual-Core or Dual-Core Capable SIMs. You can also find this information in your dashboard. When devices reconnect to the Internet, they pass a callback to the Hologram platform to let us know it's reconnected. This allows us to update the status of your SIM card, and the data session information will contain the new ICCID that will tell you that a profile has changed. [Read about how to view network fallback events for a SIM](/guides/sims/fallback-events). The biggest benefit of network fallback over multi-IMSI solutions is that it provides the device with full route redundancy — an alternate networking path to the Internet. Multi-IMSI solutions typically house all alternate IMSIs within a single profile, which makes them susceptible to single points of failure in operator maintaining the multi-IMSI profile's mobile core and connectivity infrastructure. ## Related actions View comprehensive SIM information and status See when and how your SIMs switched profiles Monitor individual SIM data consumption # AT command reference and troubleshooting cellular modules Source: https://docs.hologram.io/guides/troubleshooting/at-command-reference-and-troubleshooting-cellular-modules Common AT commands to configure, monitor, and troubleshoot cellular modules with examples and next steps. ## Overview AT commands help you diagnose connectivity, SIM, registration, signal, and SMS issues. This reference includes standard 3GPP commands and vendor variations with example outputs and actions. **Note:** Responses vary by vendor and firmware. Use vendor AT manuals in parallel. ## 1. AT - Basic connectivity check ```bash theme={null} AT ``` | Response | Meaning | Next steps | | - | - | - | | OK | Modem responsive | — | | ERROR | Not responding to basic cmd | Check serial, baud, power | | No response | Host not connected | Verify hardware | ## 2. Identify device: ATI / +CGMI / +CGMM / +CGMR / +CGSN / +GSN ```bash theme={null} ATI AT+CGMI AT+CGMM AT+CGMR AT+CGSN AT+GSN ``` ```bash theme={null} ATI Quectel BG96 Revision: BG96MAR02A07M1G OK ``` ## 3. +CPIN? - SIM status ```bash theme={null} AT+CPIN? ``` | Response | Meaning | Next steps | | - | - | - | | +CPIN: READY | SIM detected and unlocked | — | | +CPIN: SIM PIN | PIN required | Enter with AT+CPIN="xxxx" | | +CPIN: SIM PUK | SIM blocked | Contact SIM provider | | +CPIN: NOT INSERTED | SIM not detected | Check tray/orientation | | +CPIN: SIM FAILURE | SIM unreadable | Try another SIM | | +CPIN: PH-SIM PIN | SIM network lock | Unlock with carrier code | ## 4. +CCID - ICCID retrieval ```bash theme={null} AT+CCID ``` ```bash theme={null} +CCID: 891234XXXXXXXXXXXXXX OK ``` ## 5. +CREG? / +CGREG? / +CEREG? - Registration status ```bash theme={null} AT+CREG? AT+CGREG? AT+CEREG? ``` | Stat | Meaning | Common causes | Next steps | | - | - | - | - | | 0 | Not registered | Modem off, antenna issue | AT+CFUN=1, check +CPIN? | | 1 | Registered (home) | Normal | — | | 2 | Searching | Scanning | Wait / relocate | | 3 | Registration denied | SIM blocked or wrong RAT | Check SIM/APN | | 4 | Unknown | Transient | Retry | | 5 | Registered (roaming) | Normal for global SIMs | — | | 8 | Emergency only | Weak coverage | Move | ## 6. +COPS - Operator selection ```bash theme={null} AT+COPS? AT+COPS=? AT+COPS=mode,format,oper,AcT ``` * **Modes**: 0 Auto, 1 Manual, 2 Deregister, 4 Manual/auto fallback * **Formats**: 0 Long name, 1 Short name, 2 Numeric MCCMNC * **AcT**: 0 GSM, 2 UTRAN, 7 LTE, 8 LTE-M, 9 NB-IoT ```bash theme={null} +COPS: 0,0,"T-Mobile",8 +COPS: 1,2,"310260",7 ``` ## 7. +CSQ - Signal strength ```bash theme={null} AT+CSQ ``` | RSSI | dBm | Meaning | Action | | - | - | - | - | | 0 | ≤ -113 | No signal | Check antenna | | 1-9 | -111 to -93 | Very weak | Relocate | | 10-14 | -91 to -81 | Weak | Expect drops | | 15-19 | -79 to -69 | Fair | May drop | | 20-24 | -67 to -57 | Good | — | | 25-30 | -55 to -45 | Strong | — | | 31 | ≥ -51 | Excellent | — | | 99 | Unknown | Not camped | Check registration | ## 8. +CESQ - Extended signal quality ```bash theme={null} AT+CESQ ``` * RSRP (dBm) = -140 + rsrp * RSRQ (dB) = -19.5 + (rsrq × 0.5) ## 9. +CGATT / +CGACT - Attach and activate PDP ```bash theme={null} AT+CGATT? AT+CGATT=1 AT+CGACT? AT+CGACT=1,1 ``` | Response | Meaning | Next steps | | - | - | - | | +CGATT: 1 | Attached | — | | +CGATT: 0 | Not attached | Check SIM, signal, registration | ## 10. +CGDCONT - Define PDP context ```bash theme={null} AT+CGDCONT=,"","" ``` ```bash theme={null} AT+CGDCONT=1,"IP","hologram" ``` ## 11. +CNMI - New SMS indication ```bash theme={null} AT+CNMI=,,,, ``` ```bash theme={null} AT+CNMI=2,1,0,1,1 ``` ## 12. +CMGF - SMS message format ```bash theme={null} AT+CMGF= ``` | Mode | Meaning | | - | - | | 0 | PDU (raw hex) | | 1 | Text (human-readable) | ## 13. +CSCA - SMSC address ```bash theme={null} AT+CSCA? AT+CSCA="", ``` ```bash theme={null} +CSCA: "+1234567890",145 ``` ## 14. +CMGS - Send SMS ```bash theme={null} AT+CMGF=1 AT+CMGS="+1234567890" >Hello World +CMGS: 45 OK ``` ## 15. +CME ERROR - Equipment errors ```bash theme={null} +CME ERROR: 10 // SIM not inserted +CME ERROR: 30 // No network service ``` ## 16. +CMS ERROR - SMS errors ```bash theme={null} +CMS ERROR: 1 // Unassigned number +CMS ERROR: 27 // Invalid SMSC ``` ## 17. +CFUN - Functionality level ```bash theme={null} AT+CFUN? AT+CFUN=[,] ``` ## 18. +CGEREP - Packet domain event reporting ```bash theme={null} AT+CGEREP=, ``` ## 19. +CGPADDR - Show PDP address ```bash theme={null} AT+CGPADDR[=] ``` ## 20. +CGCONTRDP - Read PDP context parameters ```bash theme={null} AT+CGCONTRDP= ``` ## 21. +COPS=? - Network scan ```bash theme={null} +COPS: (1,"T-Mobile","TMO","310260",8), (1,"AT&T","ATT","310410",7) ``` ## 22. +CSCON - RRC connection status ```bash theme={null} AT+CSCON? ``` ## 23. +CEDRXS / +CPSMS - Power saving modes ```bash theme={null} AT+CEDRXS=,, AT+CPSMS=[,,] ``` ## 24. 3GPP reject cause codes | Code | Meaning | Action | | - | - | - | | 2 | IMSI unknown | SIM not active | | 3 | Illegal MS | Contact provider | | 7 | GPRS not allowed | SIM plan issue | | 15 | No suitable cells | Move/check bands | | 33 | Service option unsupported | APN issue | | 40 | No EPS bearer | LTE network problem | ## Appendix - Vendor-specific commands ### Quectel * AT+QNWINFO - Network & RAT info * AT+QENG="servingcell" - Serving cell * AT+QCSQ - Extended signal * AT+QCFG - RAT/band selection ### SIMCom * AT+CSERVINFO - Service info * AT+CNETSCAN - Scan with metrics * AT+CSQEXT - Extended CSQ ### u-blox * AT+URAT - RAT selection * AT+UBANDMASK - Band mask * AT+UCGED - Cell info # Automated modem diagnostics using Python Source: https://docs.hologram.io/guides/troubleshooting/automated-modem-diagnostics-using-python Run automated modem diagnostics and save results to a file. ## Run automatic modem diagnostics This script runs the annotated modem diagnostics automatically and saves results to a text file. Download [`modem_diagnostics.py`](/guides/troubleshooting/automated-modem-diagnostics-using-python#modem-diagnostics-py) and [`modem_interface.py`](/guides/troubleshooting/automated-modem-diagnostics-using-python#modem-interface-py) to the same directory. ```bash theme={null} python3 modem_diagnostics.py --port /dev/ttyUSB2 --baud 115200 ``` **Note:** `--port` and `--baud` are optional. If omitted, the script will prompt for available serial ports and default to 115200 baud. The output prints in your terminal and saves to `ModemDiagnostics.txt` in the same directory. Attach this file when opening a support ticket. ## ModemManager variant If you use ModemManager, run the alternative helper script: ```bash theme={null} python3 mmcli-diagnostics.py ``` ## Python scripts ### mmcli-diagnostics.py ```python expandable theme={null} #!/usr/bin/env python3 ### ### 2023-12-06 | Authors: Leonardo Gurria ### The project is the automated process of running modem diagnostics on Linux using ModemManager ### License: hologram.io ### import subprocess import logging import time import json # Sanity checks for ModemManager def check_mmcli(log): # Check if mmcli is installed (should be installed by default) log.debug('Checking if mmcli is installed') installed = subprocess.getoutput('which mmcli') # Check if mmcli is running (should be running on boot) log.debug('Checking if mmcli is active and running') running = subprocess.getoutput('sudo systemctl status ModemManager') if len(installed) == 0 or 'active (running)' not in running: return False return True # Sanity checks for debug mode def check_debug_mode(log): # Check for service file log.debug('Checking if ModemManager.service file exists') service = subprocess.getoutput('ls -lrt /lib/systemd/system/ModemManager.service') if len(service) == 0: log.warning('File /lib/systemd/system/ModemManager.service does not exist') return False # Check for debug flag log.debug('Checking if debug flag is present') flag = subprocess.getoutput('grep "debug" /lib/systemd/system/ModemManager.service') if len(flag) == 0: log.debug('Debug flag is not present') return False return True # Ask user how to proceed def user_selection(log): # Print user menu print('\nDebug mode is not enabled on ModemManager') print('How would you like to proceed?') print(' 0 - Basic Diagnostics') print(' 1 - Show me how to enable it') user_input = int(input('Your selection: ')) while user_input != 0 and user_input != 1: log.error('Please enter a valid option') user_input = int(input('Your selection: ')) if user_input == 0: log.info('Proceeding with basic diagnostics! Please note this might take around 5 mins') # Do basic diagnostics b, p = basic_diagnostics(log) del p log.info(json.dumps(b, indent=4)) else: log.debug('Showing instructions to enable debug mode') # Show instructions print('\nStep 1) Add --debug at the end of line: ExecStart=/usr/sbin/ModemManager in /lib/systemd/system/ModemManager.service file') print(' Line should look like this: ExecStart=/usr/sbin/ModemManager --debug') print('Step 2) Restart your RPi/Linux machine and run this script again!') exit(0) # Basic diagnostics def basic_diagnostics(log): # Check that modem is plugged in log.debug('Checking if modem is plugged in') plugged = subprocess.getoutput('mmcli -L') if 'No modems were found' in plugged: log.error('No modem is plugged in') exit(0) plugged = subprocess.getoutput('mmcli -L -J') plugged = json.loads(plugged) plugged = plugged['modem-list'][0] # Check for modem info log.debug('Checking for modem information in slot ' + plugged) modem = subprocess.getoutput('mmcli -m ' + plugged) if "error: couldn't find modem" in modem: log.error('Unable to check modem information') exit(0) log.debug(modem) # Get information on JSON format modem = subprocess.getoutput('mmcli -m ' + plugged + ' -J') log.debug('Modem JSON file') log.debug(modem) m = json.loads(modem) s = m['modem']['generic']['sim'] b = m['modem']['generic']['bearers'][0] if len(m['modem']['generic']['bearers']) > 0 else 'No bearer' # Check that SIM is present log.debug('Checking for SIM in slot ' + s) sim = subprocess.getoutput('mmcli -i ' + s) if "error: couldn't find SIM" in sim: log.error('SIM is missing') exit(0) log.debug(sim) # Get information on JSON format sim = subprocess.getoutput('mmcli -i ' + s + ' -J') log.debug('SIM JSON file') log.debug(sim) # Check for bearer log.debug('Checking for connection in slot ' + b) bearer = subprocess.getoutput('mmcli -b ' + b) if "error: couldn't find bearer" in bearer or b == 'No bearer': log.warning('Connection is not in use') bearer = 'No bearer' else: log.debug(bearer) # Get information on JSON format bearer = subprocess.getoutput('mmcli -b ' + b + ' -J') log.debug('Bearer JSON file') log.debug(bearer) # Parse JSON information return parse_basic_diagnostics(log, modem, sim, bearer, plugged) # Parse basic diagnsotics from JSON format def parse_basic_diagnostics(log, modem, sim, bearer, plugged): log.debug('Basic Diagnostics') m = json.loads(modem) s = json.loads(sim) if bearer != 'No bearer': bea = json.loads(bearer) b = bea['bearer']['properties']['apn'] else: b = bearer # Networks networks = subprocess.getoutput('sudo mmcli -m ' + plugged + ' --3gpp-scan --timeout=300 -J') if 'error' not in networks: net = json.loads(networks) n = net['modem']['3gpp']['scan-networks'] else: n = networks log.warning(n) # Extended signal ext_signal = subprocess.getoutput('mmcli -m ' + plugged + ' --signal-get') ext_signal = ext_signal.replace('error rate threshold', '') if 'error' not in ext_signal: # Setup extended signal ext_signal = subprocess.getoutput('sudo mmcli -m ' + plugged + ' --signal-setup=10') # Wait 10 + 1 secs time.sleep(11) # Get actual extended signal ext_signal = subprocess.getoutput('mmcli -m ' + plugged + ' --signal-get -J') es = json.loads(ext_signal) if es['modem']['signal']['lte']['rssi'] == '--': log.debug('Fetching all RAT extended signal') sig = es['modem']['signal'] else: log.debug('Fetching LTE extended signal') sig = es['modem']['signal']['lte'] else: sig = ext_signal log.warning(f'Unable to get extended signal due to: {ext_signal}') basic_diagnostics = { 'module': m['modem']['generic']['model'], 'manufacturer': m['modem']['generic']['manufacturer'], 'firmware': m['modem']['generic']['revision'], 'iccid': s['sim']['properties']['iccid'], 'signal': m['modem']['generic']['signal-quality'], 'extended_signal': sig, 'registration_status': m['modem']['generic']['state'] + ' | ' + m['modem']['3gpp']['registration-state'], 'apn': b, 'current_operator': m['modem']['3gpp']['operator-code'] + ' | ' + m['modem']['3gpp']['operator-name'], 'networks_in_reach': n, 'cpin': '', 'fplmn': '', 'csq': '', 'cgact': '', 'creg': '', 'cgreg': '', 'cereg': '', 'cgdcont': '' } log.debug(json.dumps(basic_diagnostics, indent=4)) return basic_diagnostics, plugged # Full diagnostics def full_diagnostics(log): # Run basic diagnsotics first full_diagnostics, plugged = basic_diagnostics(log) log.debug('Full diagnostics') # Run remaining commands for full diagnostics cpin = subprocess.getoutput("sudo mmcli -m " + plugged + " --command='+cpin?'") fplmn = subprocess.getoutput("sudo mmcli -m " + plugged + " --command='+crsm=176,28539,0,0,12'") csq = subprocess.getoutput("sudo mmcli -m " + plugged + " --command='+csq'") cgact = subprocess.getoutput("sudo mmcli -m " + plugged + " --command='+cgact?'") cgdcont = subprocess.getoutput("sudo mmcli -m " + plugged + " --command='+cgdcont?'") # These need to be checked in /var/log/syslog for their output creg = subprocess.getoutput("sudo mmcli -m " + plugged + " --command='+creg?'") # creg_out = subprocess.getoutput('cat /var/log/syslog | grep -i "+creg:" | tail -1') creg_out = subprocess.getoutput('journalctl -u ModemManager | grep -i "+creg:" | tail -1') cgreg = subprocess.getoutput("sudo mmcli -m " + plugged + " --command='+cgreg?'") # cgreg_out = subprocess.getoutput('cat /var/log/syslog | grep -i "+cgreg:" | tail -1') cgreg_out = subprocess.getoutput('journalctl -u ModemManager | grep -i "+cgreg:" | tail -1') cereg = subprocess.getoutput("sudo mmcli -m " + plugged + " --command='+cereg?'") # cereg_out = subprocess.getoutput('cat /var/log/syslog | grep -i "+cereg:" | tail -1') cereg_out = subprocess.getoutput('journalctl -u ModemManager | grep -i "+cereg:" | tail -1') # Sanity checks for outputs if 'error' in cpin or cpin == "response: ''": log.warning(f'Unable to run +cpin command due to: {cpin}') else: full_diagnostics['cpin'] = cpin if 'error' in fplmn or fplmn == "response: ''": log.warning(f'Unable to run +crsm command due to: {fplmn}') else: full_diagnostics['fplmn'] = fplmn if 'error' in csq or csq == "response: ''": log.warning(f'Unable to run +csq command due to: {csq}') else: full_diagnostics['csq'] = csq if 'error' in cgact or cgact == "response: ''": log.warning(f'Unable to run +cgact command due to: {cgact}') else: full_diagnostics['cgact'] = cgact if 'error' in cgdcont or cgdcont == "response: ''": log.warning(f'Unable to run +cgdcont command due to: {cgdcont}') else: full_diagnostics['cgdcont'] = cgdcont if 'error' in creg or len(creg_out) == 0: log.warning(f'Unable to run +creg command due to: {creg}') else: find = creg_out.find('<-- ') parse = creg_out[find:] full_diagnostics['creg'] = parse.replace('<-- ', '').replace("'", '').replace('', '').replace('OK', '') if 'error' in cgreg or len(cgreg_out) == 0: log.warning(f'Unable to run +cgreg command due to: {cgreg}') else: find = cgreg_out.find('<-- ') parse = cgreg_out[find:] full_diagnostics['cgreg'] = parse.replace('<-- ', '').replace("'", '').replace('', '').replace('OK', '') if 'error' in cereg or len(cereg_out) == 0: log.warning(f'Unable to run +cereg command due to: {cereg}') else: find = cereg_out.find('<-- ') parse = cereg_out[find:] full_diagnostics['cereg'] = parse.replace('<-- ', '').replace("'", '').replace('', '').replace('OK', '') log.info(json.dumps(full_diagnostics, indent=4)) # Main def main(): # Measure execution time start_time = time.time() # Log info log = logging.getLogger('mmcli-diagnostics') logging.basicConfig(level=logging.DEBUG, filename='mmcli-diagnostics.log', filemode='w', format='%(asctime)s | %(name)s | %(levelname)s | %(message)s') # Console con = logging.StreamHandler() con.setLevel(logging.INFO) con.setFormatter(logging.Formatter('%(asctime)s | %(name)s | %(levelname)s | %(message)s')) log.addHandler(con) log.info('Starting script!') # Run sanity checks for ModemManager mmcli_ready = check_mmcli(log) if mmcli_ready is False: log.error('Your system does not have ModemManager ready for diagnostics') exit(0) # Run sanity checks for debug mode debug_mode_ready = check_debug_mode(log) if debug_mode_ready is False: log.debug('Debug mode is not enabled') # Check for user selection user_selection(log) else: log.info('Debug flag is present. Proceeding with full diagnostics! Please note this might take around 5 mins') full_diagnostics(log) log.info('Script completed!') # Measure execution time end_time = time.time() log.info('Execution duration: ' + str(end_time - start_time) + ' secs') # Python stuff if __name__ == '__main__': main() ``` ### modem\_interface.py ```python expandable theme={null} #!/usr/bin/env python3 # # This code provide a robust serial interface to a modem. # Cory Dixon, Hologram # #from tkinter import W import serial import time import sys import glob import os import re # helper function to perform sort def atoi(text): return int(text) if text.isdigit() else text def natural_keys(text): ''' alist.sort(key=natural_keys) sorts in human order http://nedbatchelder.com/blog/200712/human_sorting.html (See Toothy's implementation in the comments) ''' return [ atoi(c) for c in re.split(r'(\d+)', text) ] """ Lists serial port names :raises EnvironmentError: On unsupported or unknown platforms :returns: A list of the serial ports available on the system """ def serial_ports(): # Windows OS if sys.platform.startswith('win'): ports = ['COM%s' % (i + 1) for i in range(256)] # Linux OS elif sys.platform.startswith('linux') or sys.platform.startswith('cygwin'): # this excludes your current terminal "/dev/tty" ports = glob.glob('/dev/tty[A-Za-z]*') # Mac OS elif sys.platform.startswith('darwin'): ports = glob.glob('/dev/tty.*') # Some other OS else: raise EnvironmentError('Unsupported platform') # Mainly for MacOS user = os.environ.get('USER').lower() if user: user = user.lower() # Store port names result = [] for port in ports: if user in port.lower(): continue elif 'bluetooth' in port.lower(): continue try: s = serial.Serial(port) s.close() result.append(port) except (OSError, serial.SerialException): pass result.sort(key=natural_keys) return result """ Modem AT Command Manager Class """ class ATManager: def __init__(self, serial_timeout=5, msg_timeout=1, print_debug = False): self.print_debug = print_debug self.ser = None self.init_time = time.time() self.sent_cmd = None self.last_rx = time.time() self.serial_timeout = serial_timeout self.msg_timeout = msg_timeout self.msg_timeout_def = msg_timeout self.send_at = None self.last_sms = [] # message from last urc code self.have_sms = False self.ping_count = 0 self.have_ping = False self.last_ping = 0 # The default message timeout is 1 second. However, some commands like the AT+COPS=? # can take much longer. You should cal set_msg_timeout(big_number) for those commands # and then it is advised to set the timeout back to 1 set_msg_timeout(1) def set_msg_timeout(self, val): if val is not None: self.msg_timeout = val self.msg_timeout_def = val # Assign an AT command to the command manager def set_cmd(self, val): self.send_at = val #print("setting cmd {}".format(self.send_at)) # Open serial port def open(self, port, baud): self.ser = serial.Serial(port, baudrate = baud, timeout=self.serial_timeout) #self.ser.flushInput() self.ser.reset_input_buffer() self.ser.reset_output_buffer() self.ser.flush() self.ser.read_all() # Close serial port def close(self): if self.ser: self.ser.reset_input_buffer() self.ser.reset_output_buffer() self.ser.flush() self.ser.read_all() self.ser.close() self.sent_cmd = None self.ser = None # DO NOT CALL THIS DIRECTLY. Use set_cmd def __write(self,val): cmd = 'AT' if not (val.startswith('AT') or val.startswith('at')) else '' dt = (time.time() - self.init_time) if self.print_debug: print("TX [{:.2f}]: {}".format(dt, cmd+val)) cmd = cmd + val + '\r\n' cmd = cmd.encode() self.ser.write(cmd) self.ser.flush() self.sent_cmd = time.time() # Check is serial port is open def isOpen(self): return self.ser.isOpen() # Wait for modem to respond to AT command sent def wait_for_rx(self, wait_time=None, log_file=None, exit_flag = False): if wait_time is not None: self.msg_timeout = wait_time full_rep = [] while self.sent_cmd or self.send_at and exit_flag != True: rep = self.update(log_file) if rep is None: return full_rep elif rep == '': time.sleep(0.01) else: full_rep.append(rep) self.msg_timeout = self.msg_timeout_def return full_rep # Update output/log_file def update(self, log_file=None): #print("{} {} {} {}".format(time.time(), self.send_at, self.last_rx, self.sent_cmd )) if not self.ser.isOpen(): if self.print_debug: print("Serial port is not open") return None n = self.ser.inWaiting() dt = (time.time() - self.init_time) if n > 0: self.last_rx = time.time() try: reply = self.ser.readline() reply = reply.decode().strip() except: return '' # URC detection #if reply.startswith('+') self.parse_urc( reply, log_file) if self.sent_cmd: if self.print_debug: print("RX [{:.2f}]: {}".format(dt, reply)) if reply.startswith('OK') or 'ERROR' in reply or 'ABORTED' in reply: self.sent_cmd = None else: if self.print_debug: print("UX [{:.2f}]: {}".format(dt, reply)) #print('[{:.2f}] {}'.format(dt, reply)) if log_file: log_file.write('[{:.2f}] '.format(dt)) log_file.write(reply) log_file.write('\r\n') #print("have reply: {}".format(reply)) return reply elif self.sent_cmd: #print("waiting on send") if (time.time() - self.sent_cmd) >= self.msg_timeout: if self.print_debug: print("ERROR: timed out waiting for response") self.sent_cmd = None return 'TIMEOUT' # Don't send a new command faster than 200 ms elif self.send_at and (time.time() - self.last_rx) >= 0.2 and (time.time() - (self.sent_cmd if self.sent_cmd else 0)) >= .2: #print("next send") if log_file: log_file.write('[{:.2f}] '.format(dt)) log_file.write(self.send_at) log_file.write('\r\n') self.__write(self.send_at) self.send_at = None return '' # Parse URC values we may care about def parse_urc(self, rsp, log_file=None): #print(f'parse_urc {rsp}') # +UUSORD: 0,17 if '+UUSORD' in rsp: val = rsp.rsplit(':', 1)[-1] cmd = 'AT+USORD=' + val self.__write(cmd) elif '+CMT' in rsp: # Send SMS ack #self.set_cmd('AT+CNMA') self.have_sms = True self.last_sms = rsp elif '+QPING' in rsp: # Ping ack # +QPING: 0,"8.8.8.8",32,295,255 # +QPING: 0,1,1,0,295,295,295 val = rsp.rsplit(':', 1)[-1] ms = val.split(',') self.ping_count += 1 if len(ms) > 2 and ms[1].isdigit(): count = int(ms[1]) if count + 1 == self.ping_count: self.have_ping = True self.last_ping = int(ms[-1]) self.sent_cmd = None # get sms def get_sms(self): if self.have_sms: self.have_sms = False sms = self.last_sms self.last_sms = [] return sms return None # get ping def get_ping(self): if self.have_ping: self.have_ping = False self.ping_count = 0 ping = self.last_ping self.last_ping = [] return ping return None # Get the current carrier def get_carrier(self, log_file=None): # send command self.set_cmd('AT+COPS?') # wait for response reply = self.wait_for_rx(log_file=log_file) # parse response if reply is not None and len(reply) == 2 and 'OK' in reply[-1]: vals = reply[0].split(',') if len(vals) >= 3: return vals[2] return '' # See if the modem will respond to AT command def connected_state(self, log_file=None): # send command self.set_cmd('AT+CEREG?') # wait for response reply = self.wait_for_rx(log_file=log_file) # parse response if reply is not None and len(reply) == 2 and 'OK' in reply[-1]: vals = re.findall('[0-9]+', reply[0]) if len(vals) >= 2: try: v = int(vals[1]) return v except: return 4 return 4 # Ping a server def ping(self, server="8.8.8.8", num=4, log_file=None): timeout = 1 self.have_ping = False self.ping_count = 0 # format command cmd = f'AT+QPING=1,"{server}",{timeout},{str(num)}' # send command self.set_cmd(cmd) # wait for response reply = self.wait_for_rx(wait_time=5, log_file=log_file) if reply is None or reply[-1] != 'OK': return None for i in range(20): self.update() if self.have_ping: return self.get_ping() time.sleep(.1) return None ``` ### modem\_diagnostics.py ```python expandable theme={null} #!/usr/bin/env python3 import sys import signal import argparse # Fails on Windows unless X-server is used # If this line is commented, though, the script runs fine + W is not used anywhere # from tkinter import W from modem_interface import * import re # setup handler for control-c to exit cleanly def ctrl_handler(signum, frame): print("Ctrl-c was pressed.") atm.close() if log_file: log_file.write("\nCtrl-c was pressed.\n") log_file.close() sys.exit(0) # Main def main(): # SERIAL_PORT = "/dev/ttyACM0" # Raspberry Pi 2 # BAUD = 115200 SERIAL_PORT = None BAUD = None # get inputs parser=argparse.ArgumentParser() parser.add_argument('--port', default='', type=str, help='Serial port to use') parser.add_argument('--baud', default=115200, type=int, help='Baud rate to use') args=parser.parse_args() if args.baud: BAUD = args.baud if args.port: SERIAL_PORT = args.port else: sp = serial_ports() print('Select port:') for (i,s) in enumerate(sp): print('{} {}'.format(i,s)) ind = int(input('> ')) SERIAL_PORT = sp[ind] # Diagnostic Commands #atCommands = ['ATE0','ATI','AT+CGMI','AT+CGMM','AT+GMM','AT+CMEE=2', 'AT+CREG=2', 'AT+CGREG=2', 'AT+CEREG=3', 'AT+CGEREP=2,1', 'AT+CPIN?','AT+CCID','AT+CRSM=176,28539,0,0,12','AT+CFUN?','AT+CSQ','AT+CESQ','AT+CREG?','AT+CGREG?','AT+CEREG?','AT+CGDCONT?','AT+CGACT?','AT+COPS?','AT+COPS=?'] atCommands = ['ATE0','ATI','AT+CGMI','AT+CGMM','AT+GMM','AT+CMEE=2', 'AT+CREG=2', 'AT+CGREG=2', 'AT+CEREG=3', 'AT+CGEREP=2,1', 'AT+CPIN?','AT+CCID','AT+CRSM=176,28539,0,0,12','AT+CFUN?','AT+CSQ','AT+CESQ','AT+CREG?','AT+CGREG?','AT+CEREG?','AT+CGDCONT?','AT+CGACT?','AT+COPS?'] # Create and open modem interface atm = ATManager(print_debug=True) # Save to file file_name = 'ModemDiagnostics.txt' log_file = open(file_name, 'w') signal.signal(signal.SIGINT, ctrl_handler) print('\n---------------\nConnecting to modem ...') while True: try: atm.open(SERIAL_PORT, BAUD) break except: time.sleep(.1) pass while atm.isOpen(): atm.set_cmd('AT') reply = atm.wait_for_rx(log_file=log_file) #print(reply) #print(reply[-1]) #print('OK' in reply) if reply is None or len(reply) == 0: time.sleep(1) elif 'OK' in reply[-1]: break # the COPS=? command can take several minutes atm.set_msg_timeout( 300 ) for cmd in atCommands: atm.set_cmd(cmd) atm.wait_for_rx(log_file=log_file) log_file.write('-----\r\n') print('-----\r\n') # How you can parse out ICCID atm.set_cmd('AT+QCCID') reply = atm.wait_for_rx(log_file=log_file) print('----') if len(reply) >= 2 and reply[1] == 'OK': x = re.findall('[0-9]+', reply[0]) print(x) else: print('Invalid reponse!') # close interfaces log_file.close() atm.close() print("Good bye!") # Python stuff if __name__ == '__main__': main() ``` # Clear the FPLMN (forbidden networks) list Source: https://docs.hologram.io/guides/troubleshooting/clear-the-fplmn-forbidden-networks-list Understand when and how to clear the SIM's Forbidden PLMN list using AT commands. ## About the FPLMN list The FPLMN (Forbidden Public Land Mobile Network) list is stored on the SIM and contains networks the device should avoid. **Caution:** Only clear the FPLMN when instructed by Hologram support or your device vendor. Doing this at the wrong time can disrupt registration. ## Check the FPLMN ```bash theme={null} AT+CRSM=176,28539,0,0,12 ``` If the response shows 24 Fs, the list is empty: ```bash theme={null} +CRSM: 144,0,"FFFFFFFFFFFFFFFFFFFFFFFF" ``` AT+CRSM read showing 24 Fs indicating empty FPLMN ## Clear the FPLMN Before writing, set minimal functionality if required by your module: ```bash theme={null} AT+CFUN=0 ``` Write exactly 24 Fs: ```bash theme={null} AT+CRSM=214,28539,0,0,12,"FFFFFFFFFFFFFFFFFFFFFFFF" ``` **Warning:** Include exactly 24 Fs in the payload. AT+CRSM write showing 24 Fs to clear FPLMN Restore full functionality afterward: ```bash theme={null} AT+CFUN=1 ``` # Connect a Raspberry Pi to the internet using a Hologram SIM Source: https://docs.hologram.io/guides/troubleshooting/connect-a-raspberry-pi-to-the-internet-via-cellular-modem Connect a Raspberry Pi to the internet using a cellular modem and a Hologram SIM with NetworkManager (nmcli) and ModemManager (mmcli), then verify connectivity with a ping test. ## Requirements * A Raspberry Pi, with a mouse, keyboard, and monitor for the initial setup. * A cellular modem with an activated Hologram SIM and a data plan. If you have not activated your SIM yet, see [Activate your first SIMs](/guides/get-started/activate-your-first-sims). * NetworkManager (`nmcli`), pre-installed starting on Debian 12 (bookworm). * ModemManager (`mmcli`), pre-installed starting on Debian 12 (bookworm). ## Connect the Raspberry Pi Confirm that both `mmcli` and `nmcli` are available: ```bash theme={null} which mmcli which nmcli ``` Both are installed by default on Debian 12 and later. If either is missing, install it: ```bash theme={null} # NetworkManager sudo apt-get install network-manager # ModemManager (note: the Raspbian package name is all lowercase) sudo apt-get install modemmanager ``` On Debian 11-based and older images, set up your network connection with NetworkManager **before** continuing, so you do not lose access to the device. Newer images do this automatically, and this step is not needed if you use Ethernet. **Important:** Set up WiFi while the Raspberry Pi is connected to a monitor, keyboard, and mouse. You can lose remote access after installing `nmcli`. If you used the Raspberry Pi Imager, you can set the WiFi SSID and password there until you can set up Ethernet. ```bash theme={null} # Check connections nmcli device nmcli device show wlan0 nmcli connection # Enable WiFi nmcli radio nmcli device wifi list nmcli device status # Connect to WiFi sudo nmcli device wifi connect password "" nmcli device status nmcli connection show # Verify the services are running (you may need to restart first) sudo systemctl status ModemManager sudo systemctl status NetworkManager ``` Insert your activated SIM into the modem, then connect the cellular modem to your Raspberry Pi via USB. Verify that the Raspberry Pi detects the modem: ```bash theme={null} lsusb ``` lsusb output listing the connected cellular modem as a USB device Connect the modem to the network using ModemManager and your [APN](/guides/get-started/set-the-device-apn): ```bash theme={null} # Get your modem ID mmcli -L # Verify your modem details mmcli -m # Connect the modem to the network sudo mmcli -m --simple-connect="apn=" # Verify the changes mmcli -m ``` mmcli output showing modem details before connecting mmcli output showing the modem connected to the network after simple-connect Adding the connection to NetworkManager sets up the correct IP routes. ```bash theme={null} # Look for the GENERAL.TYPE and GENERAL.DEVICE values for the next step nmcli device show ``` nmcli device show output highlighting the GENERAL.TYPE and GENERAL.DEVICE values Create the connection, replacing the placeholders with your own values: * `` — the `GENERAL.DEVICE` value from the previous command. * `` — any name you choose for the connection. * `` — the APN for your SIM. ```bash theme={null} sudo nmcli connection add type gsm ifname "" con-name apn # Verify the changes nmcli connection show # To update an existing connection with other modem details: # sudo nmcli connection modify ifname "" apn # For more options and how to use them: # nmcli connection --help ``` nmcli connection add command creating a new gsm connection nmcli connection show output listing the new gsm connection **Note:** The `type gsm` connection works well with Verizon SIMs too, as long as your modem is Verizon certified and you use the correct Verizon profile type (Cat-1+ vs. Cat-M). Confirm the modem connection appears in NetworkManager on the correct `TYPE` and `DEVICE`, and shows as connected (green): ```bash theme={null} nmcli connection show ``` nmcli connection show output with the cellular connection active and shown in green Confirm your IP table has the appropriate `wwan0` or `ppp0` interface, including the SIM's IP address: ```bash theme={null} ip a ``` ip a output showing the wwan0 interface with the SIM's assigned IP address Test the new connection by pinging `hologram.io`. Replace `` with the appropriate interface (`wwan0` or `ppp0`): ```bash theme={null} ping -I hologram.io -c 5 ``` ping output showing successful replies from hologram.io over the cellular interface Turn off the Raspberry Pi's WiFi and open a site such as `https://www.google.com` in a browser. **Congratulations!** Your Raspberry Pi is now connected to the internet through your cellular modem. ## Troubleshooting ### General troubleshooting commands Use the built-in help for each tool to explore available options: ```bash theme={null} # More info: https://manpages.ubuntu.com/manpages/bionic/man8/mmcli.8.html mmcli --help # More info: https://manpages.ubuntu.com/manpages/kinetic/en/man1/nmcli.1.html nmcli --help ``` ### Add IP routes manually If these or other tools are giving you issues, the device most likely does not have the correct routes configured. Add them manually with the commands below. You need to re-add these routes every time the device boots, unless you use the Hologram SDK, which configures them automatically. ```bash theme={null} # These routes apply to all Hologram SIMs, regardless of the upstream partner: 10.176.0.0/16 and 10.254.0.0/16 # Replace with the appropriate value (wwan0, ppp0, etc.) ip route add 10.176.0.0/16 dev # This route also lets you use Spacebridge while on WiFi ip route add 10.254.0.0/16 dev # Verify ip route ``` ip route output showing the manually added Hologram network routes ### Run AT commands through ModemManager You can put ModemManager in debug mode to run AT commands directly through it: ```bash theme={null} # Find the service file ls -lrt /lib/systemd/system/ModemManager.service # Find the line that starts with ExecStart and add --debug at the end. # It should end up looking like: ExecStart=/usr/sbin/ModemManager --debug # Restart the ModemManager service (or reboot the Raspberry Pi), then run AT commands like this: sudo mmcli -m 0 --command='+cgmi' # Note: registration status commands are not shown in mmcli responses but # logged in the Linux system logs and can be accessed with one of the below # depending on the OS version: # Debian 11 or older cat /var/log/syslog | grep -i "+cereg:" | tail -1 # Debian 12+ journalctl -u ModemManager | grep -i "+cereg:" | tail -1 ``` ## Optional: AT command access alongside the cellular connection By default, ModemManager claims all AT-capable ports on the EG25-G, which prevents external tools from accessing them. The fix is to free up `ttyUSB3` with a udev rule while leaving ModemManager in control of `ttyUSB2` for the cellular connection. ```bash theme={null} sudo nano /etc/udev/rules.d/99-quectel-at.rules ``` Add the following line: ```text theme={null} SUBSYSTEM=="tty", KERNEL=="ttyUSB3", ENV{ID_MM_PORT_IGNORE}="1" ``` ```bash theme={null} sudo udevadm control --reload-rules sudo udevadm trigger sudo systemctl restart ModemManager ``` ```bash theme={null} sudo mmcli -m 0 -v | grep ttyUSB ``` Expected output: ```text theme={null} ports: cdc-wdm0 (qmi), ttyUSB0 (ignored), ttyUSB1 (gps), ttyUSB2 (at), ttyUSB3 (ignored), wwan0 (net) ``` `ttyUSB3` is now permanently free for AT command tools such as minicom or [AT Command Wrangler](https://wrangler.wovyn.com/), while the cellular data connection continues running on `ttyUSB2`. The rule persists across reboots automatically. ### Port reference | Port | Role | | - | - | | `ttyUSB0` | Diagnostic (QCDM) — not AT | | `ttyUSB1` | GPS/NMEA | | `ttyUSB2` | AT — used by ModemManager | | `ttyUSB3` | AT — free for your use | | `cdc-wdm0` | QMI interface | | `wwan0` | Network interface | # Find and troubleshoot zero-byte sessions Source: https://docs.hologram.io/guides/troubleshooting/find-and-troubleshoot-zero-byte-sessions Identify zero-byte sessions and resolve common causes such as APN misconfiguration or firmware behavior. **Zero-byte sessions**, which are sometimes labeled as "**sessions without data**" in your dashboard, can indicate signaling sessions in proper connection sequence. However, in large volumes, these zero byte sessions generally indicate possible device configuration issues preventing successful data traffic. You can find zero-byte sessions in your dashboard under a [single device's page](#find-zero-byte-sessions-for-a-single-sim), a [SIM's details page](#find-zero-byte-sessions-for-a-sim), or our [data usage reports](#identify-zero-byte-sessions-across-your-fleet). ## Debugging steps and possible causes Zero-byte sessions are generally caused by one of two issues: ### 1. The APN is incorrect A device can *attach* to a network even if the APN is incorrect. However, the device cannot pass data with an incorrect APN. If the device's APN is incorrect, the device may display zero-byte sessions in your dashboard. To debug this scenario, confirm that your device's APN is set to `hologram`. ### 2. Device firmware issue A device with many zero-byte sessions in quick succession indicates excessive and unnecessary reconnects. This may be caused by improper connection logic by the device firmware or the cellular module's current configuration. For example, a device constantly trying to connect despite successfully opening data sessions will result in multiple zero-byte sessions over time. To debug this scenario, audit the device's firmware to ensure that it is programmed to recognize and utilize successful connections. Also confirm that the device's timeout allows for ample time to receive a response message from the network when attempting to open a session. It may also be helpful to refer to any device-level or network logs from the cellular module because these will provide the most accurate information about your device's behavior. ## Find zero-byte sessions for a single SIM In the details page for any SIM, open the **Recent sessions tab** or the **Usage reporting tab**. The charts and tables on these two pages display zero-byte sessions for your SIM. Usage report showing zero-byte breakdown ## Find zero-byte sessions for a SIM On a SIM's details page, open the **Data usage** tab. The report that displays will show zero-byte sessions broken down for the selected date range by: * Recent sessions * Total zero-byte sessions per profile * Total zero-byte sessions per network * Total zero-byte sessions per day * Session history with zero-byte sessions ## Identify zero-byte sessions across your fleet All our data usage reports separate "productive sessions," or sessions in which data was successfully passed through a network, from zero-byte sessions. You can find zero-byte session information broken down across your fleet per day in the **Overview tab**, per SIM in the **By SIM** tab, and per device per day in the **By SIM and day tab**. Usage report showing zero-byte breakdown # What is my organization ID (orgid)? Source: https://docs.hologram.io/guides/troubleshooting/find-org-id Locate your organization's unique numerical identifier in the dashboard Each Hologram organization has a unique numerical identifier called an **organization ID** (`orgid`). If you are using the [REST API](/guides/rest-api/beginners-guide-to-the-hologram-rest-api), you will likely use your organization ID in the request URL or body. ## Organization ID in your dashboard You can find your organization ID in two places in your dashboard. 1. Click the **Organization** drop-down in the top left corner of your dashboard. The dropdown displays the name of the current organization you are viewing. 2. Within the dropdown menu, click the **Org ID** row to copy the ID to your clipboard. Organization ID shown in Settings under This organization page 3. This ID is also available in the **Settings** section of the main menu under the **This organization** page. **Note:** If you are having trouble finding a specific SIM, remember to check if you have the correct organization open using the dropdown in the top left corner of your dashboard. ## Related guides Choose which organization opens by default when you log in. Change the active organization in your dashboard. # Hologram Support priority levels Source: https://docs.hologram.io/guides/troubleshooting/hologram-support-priority-levels ## What are Hologram Support priority levels? Priority levels help route and resolve issues based on urgency and impact. | Priority level | Classification | Description | | :- | :- | - | | **P1** | **Business critical** | This status is for production applications only. It indicates a total or near-total loss of service, or a major feature being completely unavailable, with no workaround available. It does not cover development issues, staging environment problems, or issues limited to a small number of devices. | | **P2** | **Degraded service** | Covers intermittent connectivity or performance issues affecting a meaningful portion of your deployment. A workaround may be available, but the impact remains significant. It does not include development issues or staging environment problems. | | **P3** | **Limited issue** | Covers isolated or lower-impact issues affecting a small portion of your deployment, typically with a workaround available. May also include billing or account questions that affect active service. | | **P4** | **General inquiry** | Covers product questions, feature requests, general account or billing inquiries, and other non-urgent requests that don't affect service. | **Note:** Premium Support plans include priority handling. See Support plans on the website for details. # Hologram's scope of support Source: https://docs.hologram.io/guides/troubleshooting/holograms-scope-of-support What Hologram support covers vs. what is out of scope (professional services). ## What can Hologram help with? **Note:** For professional services inquiries, contact [support@hologram.io](mailto:support@hologram.io). | Area | In scope | Out of scope | | - | - | - | | Network data | Hologram receives metadata and reports usage in Dashboard and API. | Hologram cannot see data content or device-level activity. | | Connectivity | Hologram controls connectivity for Hologram SIMs. | Hologram cannot control device settings or operator selection; use your device manual. | | Modem diagnostics | Hologram reviews diagnostics you submit. | Hologram cannot remote into devices to retrieve or change settings. | | Data usage | Hologram records and exposes usage via Dashboard and API. | Refunds or investigations for high usage not caused by identified issues. | | Support SLAs | Based on time to first response. | SLAs are not based on full resolution time. | | Device support | Guidance to relevant IoT docs and concepts. | Training on third-party devices or coding support for deployments. | # How do I reset my password? Source: https://docs.hologram.io/guides/troubleshooting/how-do-i-reset-my-password Reset your Hologram Dashboard password and troubleshoot common issues with reset emails. If you are having trouble logging into your dashboard using an existing account, first go to the login page for your dashboard at [https://dashboard.hologram.io/account/login](https://dashboard.hologram.io/account/login). Press **Forgot password?**, shown just above the password field. Dashboard login page showing the Forgot password link Enter the email on file from your dashboard account then press **Reset my password**, and we will send a password reset link that email if it's associated with an account. In the event you do not receive the email, please check your spam and junk folders. Dashboard reset password form ## Related guides # How can I check the status of Hologram's systems? Source: https://docs.hologram.io/guides/troubleshooting/how-to-check-hologram-system-status Check the status of Hologram's systems, incident history, API response time, and uptime visit our [Status page](https://status.hologram.io/). The current system status can also be found in the **Support** menu in the top menu in your dashboard. We highly recommend subscribing to system Status updates by clicking on the **Subscribe to updates** button in the top right corner of the page. Status page with Subscribe to updates button # How to find SIM ICCIDs and EIDs Source: https://docs.hologram.io/guides/troubleshooting/how-to-find-sim-iccids-and-eids Where to find ICCIDs and EIDs on SIM cards, packaging, and in the Dashboard. There are multiple identifiers or "SIM numbers" that can be used to identify the SIMs you receive from Hologram. You will need to reference these IDs when activating SIMs for the first time, and you can search your dashboard by any ID you have access to. You can activate SIMs in your dashboard using any available ICCID or EID for your SIMs. SIM card showing identifiers ## What are the IDs on a SIM card? Every SIM ships with at least one **ICCID**, which is the ID of a **profile** installed on the SIM that gives you access to a cellular carrier network through Hologram. Our Hyper SIMs are Multi-Core and ship with one or more preinstalled profiles. Each SIM also has an **EID**, the unique global identifier of the eUICC SIM. ### Activating SIMs using an ICCID The ICCIDs of profiles preinstalled on a Hologram SIM are printed on the triple cut card. One of these ICCIDs is printed with the barcode and directly on the Nano (4FF) SIM card. You can activate and search for SIMs by any installed profile ICCIDs. SIM card showing ICCID printed on the 1FF format If you purchased a box of SIMs from Hologram, the range of SIM ICCIDs included in the box are listed as ICCID Start to ICCID End. Box label showing ICCID range ### Activating SIMs using an EID (eUICC ID) Each eUICC-enabled Hyper SIM also has an **EID**, the unique global eUICC ID given to a SIM when it is manufactured. You can activate and search for SIMs by EID. SIM card showing EID printed on the 1FF format   ### What is the "primary" ICCID or SIM number on a SIM card? At any given time, only one profile on a SIM card can be `enabled`, active, and able to use data. This is the **enabled profile ICCID**. You may also see this referred to as the "active profile". **Note:** ICCIDs are part of the profile on your SIM. If a profile is ever changed or removed, the ICCIDs on your SIM will also change. Multi-Core Hyper SIMs with network fallback change active profiles when switching to a backup profile, changing the active profile ICCID for your SIM. Profile information in Dashboard **Manufactured profile ICCIDs** are ICCIDs of profiles installed on the SIM during manufacturing. The enabled manufactured ICCID is printed on triple-cut SIM cards on the smallest size (4FF) and on embedded SIMs (MFF2).   ## Find ICCIDs and EIDs in a SIM page Identifiers for SIM cards are easier to find in a SIM's details page. 1. From the **SIMs** page, open a SIM. 2. The **EID** is found on the **SIM and device tab**, which includes all information about the SIM and the last known device we saw it within. EID (eUICC ID) in SIM and device tab 3. **ICCIDs** for currently installed profiles are found in the **Profiles tab** and in the header of the page. ICCIDs in Profiles tab 4. A historical record of installed ICCIDs for the SIM are listed in the **Profile history card**. You can show this information by clicking the **Show profile details button** in the bottom-right corner of the Profiles card. 5. **Manufactured profile ICCIDs** are found in the Manufactured profile ICCID column of the SIMs pages, and are listed in the footer of the Profiles card on the SIM's details page. ## When do ICCIDs on a SIM card change? An ICCID is the ID of a profile installed on a SIM card. When a profile changes on that SIM card, whether through an over-the-air (OTA) update, profile swap, or with Outage Protection via a network fallback event, those ICCIDs may change. The EID on a SIM will never change. ## What other IDs can be used to track a SIM card? Each SIM is also installed in your physical device, which we represent using the **Device ID**, or `deviceId`. This is the main ID used in the API. We give each SIM it's own **SIM ID**, `hologramSimId`, the primary identifier we use to track Hologram SIM cards. This is a unique ID per SIM card like an EID, but is shorter to make it easier to work with file exports and reports. # IMEISV vs IMEI Source: https://docs.hologram.io/guides/troubleshooting/imeisv-vs-imei Understand the difference between IMEI and IMEISV and how they appear in Hologram. The **[IMEI](https://en.wikipedia.org/wiki/International_Mobile_Equipment_Identity)** is the device's modem identifier. The value Hologram stores and shows is the one we receive from the cellular network each time a device connects successfully. The Hologram REST API also returns the **IMEISV**. The difference is in the final digits: * **IMEI** — 14 digits plus a 1-digit checksum. * **IMEISV** — the same 14 digits plus a 2-digit **software version** instead of the checksum. The software version lets you distinguish module firmware versions across devices that use the same cellular module. #### Traditional IMEI = IMEI + 1 digit checksum **4** **9** **0** **1** **5** **4** **2** **0** **3** **2** **3** **7** **5** **1** *8* #### IMEISV = IMEI + 2 digit software version **4** **9** **0** **1** **5** **4** **2** **0** **3** **2** **3** **7** **5** **1** *0* *1* # Introduction to AT commands Source: https://docs.hologram.io/guides/troubleshooting/introduction-to-at-commands Learn AT command basics and operators (read, set, test) for modem control. ## AT command basics AT (Attention) commands are used to communicate with cellular modems via a serial interface. Use a terminal (e.g., Screen, Tera Term, PuTTY, GTKTerm) to open the modem's serial port. Send `AT` and expect `OK`. * **? (read)**: Query current value, e.g., `AT+CFUN?`. * **= (set)**: Set value, e.g., `AT+CFUN=1`. * **=? (test)**: Show supported options, e.g., `AT+COPS=?`. Terminal screenshot running AT basics **Note:** You can also run the automated diagnostics script if preferred. # Modem & SIM annotated diagnostic test Source: https://docs.hologram.io/guides/troubleshooting/modem-and-sim-annotated-diagnostic-test Run a standard set of AT commands to capture modem, SIM, registration, and APN state for troubleshooting. ## Run modem and SIM annotated AT diagnostic tests Use a serial terminal to connect to your modem and run each command. Record the outputs for support. **Note:** Some scans (e.g., network search) can take up to 3 minutes to complete. | Command | Function | Sample response | | - | - | - | | AT | Attention; verifies command path | OK | | ATI | Module number | SARA-U201-03B-00 | | AT+CGMI | Manufacturer identity | u-blox | | AT+CGMM | Manufacturer model identity | SARA-U201 | | AT+CPIN? | SIM PIN state (Hologram SIMs do not require a PIN) | +CPIN: READY | | AT+CCID | SIM ICCID (profile identifier) | +CCID: 891234... | | AT+CRSM=176,28539,0,0,12 | Read FPLMN (forbidden networks) | +CRSM: 144,0,"FFFFFFFFFFFFFFFFFFFFFFFF" | | AT+CFUN? | Module functionality | +CFUN: 1,0 | | AT+CSQ | Signal quality | +CSQ: 22,4 | | AT+CREG? | GSM/SMS registration | +CREG: 0,5 | | AT+CGREG? | 3G registration | +CGREG: 0,5 | | AT+CEREG? | LTE/EPS registration | +CEREG: 2,5,"MI9S","25SS404",8 | | AT+CGDCONT? | PDP context parameters (APN) | +CGDCONT: 1,"IP","hologram","0.0.0.0",0,0 | | AT+CGACT? | PDP context activation | +CGACT: 1,1 | | AT+COPS? | Operator selection status | +COPS: 1,2,"310260",2 | | AT+COPS=? | Networks in reach (scan) | +COPS: (1,"AT\&T","AT\&T","310410",2) | **Note:** Prefer capturing raw terminal text output instead of screenshots. ## Next steps * If `AT+CSQ` is very low, relocate the device or improve the antenna. * If not registered (`+CREG/+CGREG/+CEREG`), verify SIM activation and supported RAT/bands. * Ensure APN is set to `hologram` and the active PDP context matches the APN line. ## Related guides # No permissions to perform operation error Source: https://docs.hologram.io/guides/troubleshooting/no-permissions-to-perform-operation-error Resolve permission errors by updating your collaborator role in the organization. If you are getting a `No permissions to perform operation` error it means that your access level on the [organization's collaborator](/dashboard/orgs-and-users/user-roles) settings is not high enough to complete said action. To fix this you need to contact the organization **Owner** or an **Admin** and ask them to upgrade your collaborator access. ## Collaborator access levels Collaborators may be granted one of three access levels in an organization: * **Admin**: Full access. Same permissions as Manager, plus the ability to change billing settings * **Manager**: Same as Editor, plus managing device settings that could affect costs (e.g. changing data plans). * **Editor**: View devices and cloud messages, manage device settings that don't affect costs, manage app integrations. To change a user's access level, go to the **Settings** section in the main menu, open the **This organization** tab, and modify the user's access in the **Team** card. User list in This organization settings ## Related guides Add teammates to your organization Manage team members with access to collaborate in an organization # What causes the "Paused by system" SIM status? Source: https://docs.hologram.io/guides/troubleshooting/paused-by-system-sim-status Why a SIM is paused by system and how to resolve it (balance, data limit, SMS limit). You may find a SIM in the **Paused by system** status without having taken any actions on the SIM. When a SIM is in this state, its data usage has been automatically paused, and you cannot update its data plan or transfer it to another organization. This is generally caused by an insufficient account balance, reaching a data usage limit, reaching an SMS limit, or missing contractual payments. "Paused by system" is a different status from "Paused by user," which happens when your team manually pauses data usage for a SIM. Paused SIMs are similar to "suspended" SIMs, but suspended is not an exact match for how Hologram's billing works. SIM paused by system with status in the SIM details page List of SIMs with a Paused by system status in the SIMs pages   **Note:** Unpausing data usage for a SIM is automatic once the underlying cause has been addressed, but requires changes to propagate across our entire network before you see your device show up with a **Ready** status (`LIVE` network state). You should see your device go from Paused to Ready within a few minutes. ## How are SIMs "paused by system?" The system will pause your device into the **Paused by system** status (`PAUSED-BY-SYS` state) for one of three reasons. ### You ran out of funds in your account balance 1. Add balance by navigating to the **Account** page under the **Billing** section. 2. Click the **Add balance** button and enter the desired dollar amount you wish to add. 3. Finally, click **Add balance**. We recommend [enabling auto-refill](/guides/billing/auto-refill) so you can set and forget this. Hologram's automatic refill feature allows users to automatically charge a credit card on file whenever the account balance gets below an amount designated by the user. Though it's not required, we strongly recommend enabling this feature to avoid service interruption, which occurs when your account has a negative balance. ### The SIM reached a data usage limit To fix this, set a larger [data usage limit](/dashboard/sim-actions/set-usage-limits) on the SIM. After setting a higher data usage limit or removing the limit, your SIM's data usage will resume automatically. 1. Open the **SIM details** page by pressing the SIM's name in the **SIMs** pages, or by using search. 2. The SIM's current data usage, included data, and data limit will display in the page header. 3. Open the **Manage SIM** menu and select the **Set data usage limit** action to set a data limit on your SIM. ### The SIM reached an outbound SMS limit SIMs by default can send 100 outbound SMS messages per billing period. Any SIM that reached an SMS limit cannot be unpaused until the SIM's next billing period. If you have lowered SMS limits below your organization's default limit (generally 100), you can increase the limit to resume SMS usage. **Note:** If you need help troubleshooting outbound SMS limits for a device, please [reach out to our Support team](/guides/get-started/contact-support). # Security at Hologram Source: https://docs.hologram.io/guides/troubleshooting/security-at-hologram Overview of Hologram's network and platform security, including monitoring and isolation. ## Access three layers of firewalls through cellular technology * **Gateway perimeter:** Protects devices from unwanted connections from internet. * **Customer isolation:** Protects devices against unintended inside threats. * **Device isolation:** Protects against hackers leveraging IoT devices to communicate to other devices. ## Proof of performance We exceed industry best practices in network uptime and share data transparently with customers in a Proof of Performance report. ## Monitoring and communication Customers can sign up to receive outage alerts via SMS, Slack, phone, webhook, and email. We monitor connectivity and outages and notify customers in their dashboard. ## Platform protections Easily pause and deactivate devices that have been tampered with. # Troubleshooting alert and webhook errors Source: https://docs.hologram.io/guides/troubleshooting/troubleshooting-alerts-and-webhooks This guide reviews troubleshooting steps for some common issues when using alerts and webhooks. You can use webhooks to communicate with applications and services through Hologram SIMs. Using alerts, you can subscribe to events and receive webhook notifications when specific events occur in your fleet. ## How do I fix a "Webhook connection error"? This error usually happens when there is a malformed url in your webhook app configuration. The destination url needs to include the protocol. ### Common fixes * Change the URL from `http://your-webhook-url.com` to `https://your-webhook-url.com`, using the **HTTPS** protocol. ## How do I fix a malformed JSON payload? If your webhook fails to send, or your endpoint rejects the request, the message payload may not be valid JSON. ### Common fixes * Double check that the message data payload is properly formatted with valid JSON. Common formatting issues are uses of single quotes and the inclusion of numbers. If in doubt, use a JSON validator. * Do **not** wrap the `<>` variable in quotes. It is replaced with a JSON array (e.g. `["_DEVICE_12345_", "_SMS_DO_"]`), so writing `"<>"` produces invalid JSON. Other variables are replaced with plain text, so string values like `<>` and `<>` **do** need quotes inside a JSON payload. * Remember that the payload is a template: validate it with sample values in place of variables, not with the variables themselves. ## Why does my webhook arrive with an empty or unparseable body? If your endpoint receives the request but the body is empty or can't be parsed, the alert is most likely missing the JSON content type. ### Common fixes * When sending a JSON payload, add a `content-type: application/json` header in the webhook configuration. The Hologram Dashboard adds this header automatically when it detects a JSON payload, but alerts created through the API or older alerts may be missing it. * Send the webhook to an HTTP request inspector such as **RequestBin** to see exactly which headers and body your endpoint receives. ## How do I fix a "Socket error: timed out message"? **Socket error: timed out messages** are the result of a failure to establish a connection. These are usually associated to devices being offline or not having the correct connection setup, which prevents connections to a SIM from being established. ### Common fixes * Verify that the device is **online** and that the modem is `**able to connect**`. Some devices may restrict data connections to limit battery usage which can prevent device communication and also cause issues with eUICC operations. * Verify that the webhook connection setup is correct, especially the **host** and **port**. * Verify in your dashboard that the SIM is opening sessions and passing data correctly. If you see zero-byte sessions, you may need to troubleshoot the device's connection setup. ## How do I fix an "Error decoding JSON message"? This generally comes from a misconfigured Alert. If you see an error like "Error decoding JSON for variable `decdata.foobar`", it means you have used an incorrect variable in the message payload. ### Common fixes * Verify that the message data payload is properly formatted with valid JSON and alert variables. See [available variables](/guides/cloud-and-tools/use-event-variables-in-alerts) for more information. * The `<>` form only works when the device payload is JSON and the field exists. Verify the field name matches the JSON your device actually sends. # Troubleshooting connecting to the Hologram network Source: https://docs.hologram.io/guides/troubleshooting/troubleshooting-connecting-to-the-hologram-network This guide reviews steps to follow if you are having trouble connecting to the Hologram network. Systematically isolate connectivity issues across device, SIM, network, and application layers. When troubleshooting, our main objective is to isolate the issue to either the hardware, SIM card, the cellular network, or potentially downstream application traffic such as a web server. The following steps help us to hone in on the source of the issue: Check that the SIM status in your dashboard is either **Ready** or **Connected**. If it is not, then your SIM has not been properly [activated.](/dashboard/activation/activation-overview) Re-insert the SIM. Confirm your SIM is inserted properly. Make sure the notch on your SIM matches the location of the notch on the printed hardware guide for your device. Check that the circuit contacts of the SIM slot touch the gold plating on the SIM. Lastly, confirm that the SIM is making good contact with your device. SIMs should fit snugly inside your device. If you feel like your SIM is too loose, try inserting a thin and flat object, such as a piece of paper, between your SIM and the top of the SIM holder (not between the metal contacts). This can be the result of manufacturing or assembly variance of the SIM holder parts on circuit boards. SIM orientation and seating diagram Confirm that you are in a location that receives cell service. Check that Hologram supports available networks and radio access technologies in your area by checking our [coverage page](https://www.hologram.io/coverage/). Check any data roaming settings on your device and make sure they are enabled (no additional charges will be incurred). This should be documented in your device's manual. Roaming is what allows us to connect to 550+ networks around the world. Confirm that [your device's APN is set to "hologram".](/guides/get-started/set-the-device-apn) Send an SMS message to your device from the Dashboard's messaging tool and confirm that you can receive SMS messages sent. SMS is a separate network that does not require our APN. Checking this will help us determine if we are registering to the circuit switched cell towers successfully. If you are still having issues and you have access to an unlocked phone, place the SIM into the unlocked phone. If the phone is able to receive SMS and transmit data, there is likely a hardware issue. You can also check our [status page](http://status.hologram.io/) to see if there are any reported outages. ## Advanced troubleshooting Advanced troubleshooting can be performed if you have access to your device's modem via AT Commands. If you do, please run the [Modem and SIM diagnostic](/guides/troubleshooting/modem-and-sim-annotated-diagnostic-test). The diagnostics provide information about available networks in the device to validate coverage, cell module information to check any specific cell module issues, and SIM information for proper configuration. You can also contact [support@hologram.io](/guides/get-started/contact-support) with your results. # Troubleshooting undelivered SMS messages Source: https://docs.hologram.io/guides/troubleshooting/troubleshooting-undelivered-sms-messages Diagnose SMS delivery issues for messages sent to or from a Hologram device. ## Understand SMS delivery statuses * **Sending from a Hologram device:** "Delivered" means Hologram delivered the SMS to the receiver's network; last-mile delivery to the device is not guaranteed. * **Sending to a Hologram device:** "Delivered" means the sender's network delivered to the network your device is attached to; last-mile depends on that network and device state. **Note:** Charges apply for a successful send from Hologram, even if the end device does not receive the SMS. ## Common issues ### Carrier blocks international SMS Some carriers block international SMS by default (Hologram uses global, non-domestic numbers). Ask the carrier to allow messages from international numbers (for example, +882 or +999). ### Cat-M1 SMS maturity On some networks, SMS over Cat-M1 may be delayed or require both sender and receiver to be on the same Cat-M1 network. ### Incorrect SMSC routing Misconfigured SMSC mappings on either network can prevent delivery. These mappings are controlled by carriers. ## Additional troubleshooting Confirm there are no incidents affecting SMS or API. Ensure both devices are powered and have adequate coverage. If sending from a Hologram device, test to another device (ideally on the same carrier) and confirm it receives SMS. Use `AT+CMGL` or the device's documented command set to read stored SMS. ## Related guides AT command reference and troubleshooting cellular modules # Does Hologram provide coverage in the UAE? Source: https://docs.hologram.io/guides/troubleshooting/uae-coverage Yes. Hologram global SIMs can connect in the United Arab Emirates; permanent deployments require UAE IoT certification. ## Coverage in the UAE Hologram offers global coverage, including in the United Arab Emirates (UAE), using Hologram global SIMs. ## Certification requirements in the UAE **Caution:** Permanent deployments in the UAE require government authorization and certification. # Unable to transfer SIM to new organization Source: https://docs.hologram.io/guides/troubleshooting/unable-to-transfer-sim-to-new-organization Resolve transfer issues caused by data plan mismatches or missing permissions. If you run into errors while trying to transfer devices from one organization to another, it means that the data plan active on the selected SIMs is not available in the new organization you are trying to transfer devices to, or you do not have permissions in the new organization you are trying to transfer to. ## Data plan mismatch in the new organization To solve this issue make sure that all SIMs' data plans are available in both the originating organization and the receiving organization. For example, if all SIMs are on the **U.S. Only Pay as you Go** data plan, both organizations must have access to the U.S. Only Pay as you Go data plan. **Note:** If you receive this error please email [support@hologram.io](mailto:support@hologram.io) or create a [support ticket](/guides/get-started/contact-support). They will help you resolve the issue. ## Activation permission needed in the new organization To solve this issue, you need **Manager** or **Admin** rights in the receiving organization. You will need to reach out to an Admin in the receiving organization to provide you with access. A list of users in the organization you are logged in to can be found by opening the **Settings** section in the main menu, opening the **This organization** page (the default page in Settings), then scrolling to the **Team** card. ## Related guides # Device using odd or unexpected amounts of data Source: https://docs.hologram.io/guides/troubleshooting/unexpected-data-usage Common causes and debugging steps for unexpected data consumption Hologram does not modify the data payload used by the device. We report full network activity from your device, which includes additional payload data such as TCP/IP headers. Furthermore, Hologram only has access to limited [device metadata](/dashboard/sims/sim-details-overview#last-known-device-details), and [session-level data usage details](/dashboard/usage/usage-single-sim) provided within our session history reports. All information we have available is posted to your dashboard and available through the REST API. When the data being reported is unexpected, it is best to check your device logs. Device logs will provide more specific information about the data that was transmitted. We have found a few common issues that can cause odd amounts of data: ## Multiple data streams/sessions within a PDP context Hologram reports usage based on the PDP context records. A PDP context is created whenever a modem registers and activates on our network, and it can hold multiple data streams until either: 1. The modem disconnects gracefully. 2. The connection times out, usually because of a power loss or device failure. Given this scenario, debugging per "message" usage may not be accurately reported given that multiple messages could be sent per PDP context. To debug this scenario: 1. Monitor usage logs on your server to measure the actual data transferred per session (and not per PDP context). 2. Create a test where you disconnect from the tower after each message to close the PDP session and record the log. 3. Use the device's "Inspect" tool to view the PDP context logs to identify usage patterns. ## Missing IP traffic overhead in data calculation Although your device send only a few Bytes of usable data, the overall payload being transferred on the network is larger because additional data is added to your message to route it correctly. For example, you can read more about how our message system compares to HTTP here:\ [https://medium.com/hologram-io/hologram-io-data-usage-breakdown-3fc48f7a24c8](https://medium.com/hologram-io/hologram-io-data-usage-breakdown-3fc48f7a24c8) To debug this scenario: 1. Understand your overhead based on the communication protocol being implemented. 2. Explore lighter weight protocols such as MQTT to reduce additional overhead compared to HTTPS. ## Background activity / chatty devices It is not uncommon for devices to misuse their data communication. For example on embedded linux devices, background activity can consume extra bandwidth. For other devices, sometimes triggering can generate extra message events that consume bandwidth. We often observe that most data budgets are conservative and underestimate the actual data consumption when deployed. To debug this scenario: 1. Try to isolate the conditions under which the usage occurs. 2. Check any device log activity to identify anomalous behavior (or perhaps this is regular behavior). 3. Use the PDP contexts to plot and correlate device activity with network activity to see if the behavior is consistent. **We also offer [data limits](/dashboard/sim-actions/set-usage-limits) to protect from abnormal usage.** Note that data limits are checked at the close of a data session and could allow for additional usage to occur before the limit is enforced. # Use Hologram docs with AI Source: https://docs.hologram.io/guides/troubleshooting/use-hologram-docs-with-ai Connect Claude, ChatGPT, or your coding assistant to Hologram's documentation to find guides, API examples, and answers with source links. Connecting an AI tool to our documentation lets you search guides, look up API examples, and get answers with links to relevant documentation without leaving your workflow. Hologram provides a hosted documentation server using the Model Context Protocol (MCP), a standard for connecting AI tools to external sources. **No Hologram account or API key is required.** ## Connect your AI tool of choice You need an AI tool that supports remote MCP servers. Custom MCP availability depends on your tool and workspace settings. If you cannot add a server, check with your workspace administrator. Connection settings: | Setting | Value | | - | - | | Name | Hologram Docs | | Server URL | `https://docs.hologram.io/mcp` | | Authentication | None | Open **Customize → Connectors** and select **Add custom connector**. Enter **Hologram Docs** as the name and `https://docs.hologram.io/mcp` as the URL. Add the connector and enable it for your conversation. Ask Claude: > Using Hologram Docs, explain how to configure a device to connect with a Hologram SIM. Include links to the setup guides. Check that Claude uses the connector and returns links to Hologram's documentation. See [Claude's custom connector instructions](https://support.claude.com/en/articles/11175166-get-started-with-custom-connectors-using-remote-mcp) for more details. Open **Plugins**, select the **+** button, and choose **Add custom MCP server**. Enter **Hologram Docs** as the name and `https://docs.hologram.io/mcp` as the server URL. Select **No authentication**, review the connection notice, and choose **Create as a plugin**. Open the resulting plugin and install it. Start a new **Work** chat, type `@`, and select **Hologram Docs**. Ask ChatGPT: > Search Hologram Docs for the difference between Paused by user and Paused by system. Include links to the documentation. Check that ChatGPT uses the plugin and returns links to Hologram's documentation. See [OpenAI's connection guide](https://developers.openai.com/plugins/quickstart) for more details. With Claude Code installed, run this command in your terminal: ```bash theme={null} claude mcp add --transport http hologram-docs https://docs.hologram.io/mcp ``` Run `/mcp` in Claude Code to check the connection. Then ask Claude Code to search Hologram's documentation and include source links. See [Claude Code's MCP documentation](https://code.claude.com/docs/en/mcp) for more details. With Codex CLI installed, run this command in your terminal: ```bash theme={null} codex mcp add hologram-docs --url https://docs.hologram.io/mcp ``` Start a new Codex session and ask it to search Hologram's documentation. Check that it uses the documentation tools and returns source links. See [Codex's MCP documentation](https://learn.chatgpt.com/docs/extend/mcp?surface=cli) for more details. In your tool's MCP settings, add a remote HTTP server using `https://docs.hologram.io/mcp`. Select no authentication if prompted. Enable the server and ask your assistant to search Hologram's documentation. Check that it returns relevant source links. ## Try these prompts Once connected, ask your assistant to use Hologram Docs: * "Find the Hologram APN settings and explain how to configure my modem." * "Find Hologram's connectivity troubleshooting guide and walk me through the checks." * "Find a Python example for sending an SMS through the Hologram REST API. Use placeholders for credentials." Include your device model, programming language, or the feature you're working with to help your assistant find relevant guidance. ## What the connection can access The connection searches and reads Hologram's public documentation. It cannot view your account, inspect your devices, activate or pause SIMs, or send messages unless you specifically choose to provide API access. Your assistant can also report documentation issues to our team. Ask your assistant to include source links so you can review the guidance and any generated code before using it. For help with a specific account or device, [contact Hologram Support](/guides/get-started/contact-support). # What can I do if I haven't received a verification email? Source: https://docs.hologram.io/guides/troubleshooting/what-can-i-do-if-i-havent-received-a-verification-email Steps to find or receive your Hologram account verification email. ## If you don't see the verification email Look in Spam, Junk, Trash, Deleted Items, and Archive. Filters and rules may move automated emails. Search your mailbox for "Hologram" or "verification". Add `no-reply@hologram.io` to your allowlist if applicable. **Note:** Some `@yahoo.com` addresses may block messages from `.io` domains. Consider using a different email domain or contacting Yahoo to remove the block. Return to your dashboard and request a new verification email, then repeat the checks above. # Why does my modem show my ICCID with an extra F at the end? Source: https://docs.hologram.io/guides/troubleshooting/why-iccid-has-extra-f Some modems pad ICCIDs with an 'F' character; remove it before using the ICCID in Hologram systems. ## ICCID padding behavior Some modems (for example, SIM7000) append an `F` to the end of the ICCID. This is due to internal buffer padding with `F` values; the trailing `F` is not part of the ICCID and does not affect SIM performance. **Note:** If your modem returns an ICCID with a trailing `F`, remove the extra `F` before using the ICCID in Hologram systems (Dashboard or REST API). AT command output showing ICCID reading # Why is my device not showing an IMEI? Source: https://docs.hologram.io/guides/troubleshooting/why-is-my-device-not-showing-an-imei IMEI may not always be available for a SIM. This can be expected in some cases. ## What is an IMEI? The **IMEI** (International Mobile Equipment Identity) is a unique, usually 15-digit number identifying a cellular modem on the network. ## Why is the IMEI missing for a SIM? * **Network did not provide it:** Some networks do not provide IMEI with every data session. Some networks do not provide IMEI consistently between sessions. We show the IMEI whenever it is available, and default to showing the last known IMEI when we have it. * **No connections yet:** SIMs that have not connected to a network will not have IMEI information. * **Device/SIM swapped:** If a SIM was moved to another device, you may see the previous IMEI until a new session occurs. **Note:** As a best practice, store the device's printed IMEI alongside the SIM's ICCID in your inventory before deployment. If you change modules or move SIMs, the IMEI will change. ## What can I do about a missing IMEI? IMEI is only reported once a SIM completes a data session on the network. A SIM that has never connected will not show an IMEI. Power on the device and confirm it connects. The IMEI typically appears after the next successful session. If you need the value immediately, read the IMEI printed on the modem or device label, or query it directly from the module (often with the `AT+CGSN` command). If the SIM was moved to a new device, the previous IMEI may show until a new session occurs. If a SIM has had successful sessions and the IMEI still never appears, [contact support](/guides/get-started/contact-support). ## What does the SIM details page show if no IMEI is available? If no IMEI has been seen for a SIM, the SIM details page shows "Not available" for Last known IMEI. # Get connected with Hologram Source: https://docs.hologram.io/index Hologram is a global IoT cellular connectivity provider with outage-proof global SIMs, best-in-class tools for managing your fleets, data insights for IoT devices, and APIs to integrate with your applications. Get help activating SIMs, using the platform, managing your SIMs and devices, troubleshooting connectivity issues, and using our APIs. ## How can we help?
## Product documentation Hologram's tools help you quickly troubleshoot, diagnose, and act on issues across your fleet. Find, view, organize, and manage your SIM cards and devices. Take actions on your SIMs: pause, resume, tag, send messages, and more. Monitor and analyze data usage across your fleet with detailed reporting. Manage account balances, and find transactions and data plan pricing. Manage team members, permissions, and multiple organizations. ## API documentation Integrate Hologram's cellular connectivity into your applications and workflows using the REST API that powers our dashboard. ## More **Note:** Dedicated or phone support is available for contracted accounts. Contact our [sales team](https://www.hologram.io/contact-sales) for details. # Hologram Release Notes - 2024 Source: https://docs.hologram.io/release-notes/release-notes-2024 Keep up with the latest Hologram product and API updates. ### What's new * We've gone back to using the term **Monthly recurring charge** (or MRC) instead of "Platform fee" to refer to the per SIM monthly charge for an active SIM. Nothing is changing except the words we're using. ### What's improved * The **Home** page now links to the SIMs pages, and we have removed the old data usage chart which was the cause of some navigation and loading issues for organizations with over 10,000 SIMs. * **Last active** dates in the SIMs pages have been renamed to **Last closed session**. This is a more accurate label for the data shown. ### What's fixed * The **SIMs page status filters** select the correct status after refreshing, and when using URL parameters to pre-filter the page. * A number of small display bugs in the single SIM details page. ### What's new * **Connected status** now displays in the SIMs pages and when viewing a single SIM, including for SIMs in pre-deployment testing. This status appears when a SIM is assumed to have an open data session, actively communicating with a network. ### Known issues with open session data * Connected status is **display-only in the SIMs pages** (Active and Pre-deployment SIMs). You can't filter or sort on these statuses yet. * SIMs with Outage Protection that have recently fallen back to a second profile will list the enabled profile as the last profile that had a *closed session*. * **Last active dates** do not yet account for open sessions. * **Data usage reports** are not aware of open sessions or Connected statuses. * Open session data is **unavailable for networks that send data usage through reporting windows**. ### What's new * **Webhooks** and **Routes** are now available in the SIMs pages for accounts with access. ### What's fixed * Our **Sign Up page** had issues with certain password managers like LastPass. * **Emailed collaborator invitations** now do not prevent registration if the token is removed by an external privacy measure. * Network information was missing from session info in the data usage report for a single SIM. * Some filters our data usage by SIM and day and single SIM reports did not properly filter all the data in the reports. ### What's new * **Deactivate SIMs**, **Rename SIMs**, **Set data limits**, and **Transfer SIMs** in bulk in the SIMs pages using the Manage SIMs dropdown. * **Deactivate**, **Set a data limit**, and **Transfer** a single SIM from the Manage SIM dropdown on its details page. ### What's fixed * **Pre-deployment SIMs** can now be seen by Editor Limited roles. * This was a bug we introduced then fixed as part of a broader update on user roles, but we heard your feedback and are keeping this behavior. ### Known issues * These newly added bulk actions do not yet work reliably for large SIM counts. ### What's new * **Filter SIMs by URL.** Apply filters and copy the URL directly from your address bar to share specific views of SIMs. [View available URL filter parameters](/dashboard/sims/sims-filters#url-filter-parameters) ### What's improved * **SIMs page filters** are now organization-specific and are not carried across organizations. ### What's fixed * SIMs configured for pre-deployment testing can now be manually activated SIMs out of testing from the Devices pages in all cases as expected. * Change Plan no longer shows up as an available action for deactivated SIMs. ### What's new * **Data usage warning thresholds** now display in the Data Usage by SIM and Data Usage by SIM and Day reports. * The Data usage by SIM reports now shows the **% of total SIMs with data usage and overage**. ### What's fixed * **Data usage limits** now correctly display in the SIM Details page and in our data usage reports for SIMs on Pay Monthly data plans with included data. * **Data usage filters** in our data usage reports now correctly filter on bytes instead of MB for more accurate reporting, and exclude all SIMs with \<500 KB of data usage. * SIMs with zero bytes of data usage in the selected date range within our usage reports are now correctly excluded from "SIMs with data usage" totals. * Country filters in the Data usage by SIM report now work correctly. * Profile names now correctly display for SIMs with active USA-2 CAT1+ and USA-2 CATM1 profiles. **Note:** As of 2026-08-19, US2 profiles can no longer be distinguished between Cat 1+ and Cat M1, and are labeled as US2. ### What's new * On Monday, September 30th we updated our pricing and packaging, moving away from tiered packages to an add-on only model. * Access to some Dashboard features will be changing. Most customers will gain access to new features and functionality, and some customers we will notify will lose access to features we are retiring or replacing. * The **Subscription** page under Settings has been removed. ### What's fixed * We've squashed a bug that could cause our new product tours not to display for certain users. ### Known issues * Some adblockers prevent product tours from displaying in Dashboard. ### What's new * **New data usage reports** with detailed filtering, historical data, table capabilities, and exporting make reporting on data usage easier. * **New pre-deployment testing reports** provide a clearer look into test mode SIMs currently in testing and that have been recently activated. * You can find these reports when viewing data usage for a single SIM, and in the Usage section of your dashboard under the Active SIMs and Pre-deployment SIMs tabs. * This is the vision for reporting we've always wanted to provide you and we're excited it's finally available. * **Hide location data** at the session level in your dashboard by contacting support. * **Public IP addresses** now display in SIM details page for customers with static IP addresses. ### What's improved * Missing location data when viewing a single SIM is more clearly labeled. ### What's fixed * Reporting now correctly hides data plan and pricing details for Editor Limited roles. * Pre-deployment inventory age analysis reporting is now limited to accounts with legacy test mode testing durations of over 1 year. ### What's fixed * A bug introduced in v1.34.0 breaking **Switch Profiles** functionality for multi-core SIMs in Dashboard has been fixed. ### What's fixed * **Editor Limited** roles are once again working as expected. ### What's new * **Change data plans** within the SIMs pages, including bulk data plan changes. ### What's fixed * Unavailable actions and popovers in the SIMs pages now display as expected. ### Known issues * **Change data plans** may have performance issues or be unable to run in some cases when taking bulk actions on over 1,000 SIMs. * (Resolved) Access and display issues for **Editor Limited** roles have been identified and are being fixed. ### What's new * **Export SIMs** in XLSX, CSV, or JSON formats from the SIMs pages in your dashboard! * Exporting honors filters and selected SIMs so that you can export exactly the SIMs you need. * Excel (XLSX) formatting doesn't truncate long IDs like ICCIDs to make reporting workflows quicker. * The new **Pricing tab** on a SIM's details page lists out all the costs a SIM can incur, including the SIM's data plan, data usage rates, SIM costs, and add-ons like phone numbers. * This page will replace the Data Plan tab when viewing a Device. ### What's fixed * The Activity Console at the bottom of your dashboard now filters when viewing a single SIM, and a number of other bugs with the drawer have been fixed. ### What's new * **A billing address is now required to activate Hologram SIMs.** We require a billing address for tax and regulatory purposes. ### What's improved * **Managing credit cards and billing addresses** has been improved and is consistent across Activation, Billing, and when changing a SIM's data plans. * The billing address form now supports **address autocomplete** and validation for most countries. ### What's fixed * Manager users in organizations with monthly invoicing that couldn't activate SIMs in rare cases should now be able to activate SIMs as expected. ### What's new * The **Usage this billing period** card for a SIM (found on the Status tab) provides additional details for each SIM's data usage, including the SIM's data usage billing period, included data, SMS limits, and pre-deployment testing details. * Prepaid, **included data** available to a SIM from its data plan now displays in the header on each SIM's details page. * If you have **active SIMs but are missing a billing address**, you will see a reminder to enter a billing address. We will soon require this information for regulatory and billing purposes to activate SIMs. ### What's improved * **Deactivated SIMs** are more clearly labeled after deactivation. * **Initial loading times are speedier** for everyone. * A new application-level banner for outages and planned downtime helps us clearly label disruptive events without breaking your page layouts. ### What's fixed * **Inaccurate pre-deployment testing and data limit details** when viewing SIMs and devices. ### What's new * The **Reports (beta) section** of Dashboard will be sunset on August 30, 2024. * The most important data from these reports has been moved to our new reports that can be found in the **Usage** section of your dashboard under the Usage reports (beta) and Pre-deployment pages. ### What's fixed * **Rounded data usage totals** now round up in the SIMs section of your dashboard to better match behavior in the existing Devices section. Hovering over any usage total will show the actual usage in bytes. ### What's new * **Rename a SIM** from the new SIM details pages. * Added a **Data usage filter** to the Data Usage by SIM report. Today we are releasing our **new SIMs pages** and **data usage reports** out of early access as a public beta for all customers! As we continue to update and refine these new pages and begin to sunset the Devices pages, we would love to hear [your feedback](https://form.asana.com/?k=HOb2iQqhGUeSG1lj_PjIKQ\&d=523429734671116). ### What's included in the beta release? * A new **SIMs** *(beta)* section of your dashboard gives you more control to search and filter through every SIM in your fleets — no matter the size — to find and act on exactly the SIMs you are looking for. * **Bulk actions** that can act on on any number of devices. * A redesigned single **SIM page** *(beta)* that helps you better understand your SIM's connectivity behavior, supports Hyper SIMs with network fallback (Outage Proof or Dual-Core SIMs), lists fallback events, and provides more detail into all aspects of your SIM. * The ability to manually **Switch profiles** for a Hyper SIM with multiple installed profiles from the SIM page. * New **Data usage** *(beta)* reporting under the Usage section of your dashboard and the single SIM page, with more detailed usage information, location details for sessions, zero-byte sessions, and profile-level data usage summaries. * **Last active and last session info** for your SIMs now looks at data usage for all time. * Updated **Data usage totals** that calculate month-to-date data usage for organizations with monthly invoicing. ### Known limitations * (Resolved) **Beta data usage reports are limited to 30 days of data.** In this release, session reporting is limited to 30 days of data, however reporting on older sessions for up to 90 days are still available in our legacy reporting pages. We anticipate that his 30-day limit will be lifted by next month, and the beta reports will have a full 90 days worth of data usage. ### What's new * **Tag** SIMs from the new SIMs pages using the **Manage SIM(s)** menus. * The **Manage SIM menu** for a single SIM now lists all available actions for a single SIM, linking to the Device page for actions that are not yet available. ### What's improved * The SIM page **SIM and device tab** reformatted for clarity, including Dual-Core Capable SIM fallback status. * **Single SIM data usage report** now loads up to 1,000 recent sessions within the selected date range in the session history visualization. * **Tags filter** now only lists tags added to SIMs in the current SIMs page view. * Labeling on our beta data usage reports is now clearer, including how to download all matching results. * **Legacy data usage reports** have been turned back on for early access users. * Beta data usage report **country filters** now preload countries. ### What's fixed * **Pre-deployment testing details** fixed, including correct activation dates and test durations. * Incorrect SMS counts removed from single SIM data usage reports. ### What's new * Improved **Tags** page under the SIMs section of your dashboard. * **Support** button in the main menu now links to creating a support ticket, Help Center, and giving feedback. * The SIMs pages load much more quickly, especially for large fleets. * The **Single SIM data usage report** now displays up to 1,000 sessions in range in the session history chart to make finding spikes in data usage or strings of zero-byte sessions much easier. ### What's fixed * **Maps** on the Device, SIM, and Action Items pages display correctly after a brief outage. * **Data plans filter** in the SIMs page now shows custom data plans first, matching data plan order displayed in Activation and the Data plans page. * SIM recent session information on the Status tab **no longer shows inaccurate location** information for sessions where a carrier or network has shared inaccurate or no location. * Total data usage for a SIM now uses the same data source in the SIMs page and a single SIM's details page, and will always be identical. ### Known issues * The Data Usage by SIM and Data Usage by SIM and Day reports for early access customers will only return 500 results. We are working on a fix. ### What's new * **Data usage** totals are now available in the the SIMs section of your dashboard, and in the header when when clicking into a SIM's details page. * For organizations with invoiced, monthly billing, data usage is totaled *month-to-date* for the current billing period. * For organizations with prepaid, self-service billing, data usage is totaled for *each SIM's unique 30 day billing period*. * For SIMs in pre-deployment testing, data usage *includes total lifetime* data usage. SIMs in pre-deployment testing are automatically activated after using 100 KB of data. ### What's fixed * **Byte labels** have been improved and use the label "B" instead of "b". * **Date handling and filters** have been improved to work as expected with UTC. ### What's new * **Last active** dates – the date of the SIM's last closed session – now display for your SIMs, and are the new default sorts in the Active and Pre-deployment SIMs pages. * **Activation date** shows up as a new column on the Active SIMs page. * **Filter by last active** to find SIMs that last connected within a specific date range. * **Filter SIMs by data plan.** * **Filter by activation date** in the Active SIMs page. * **Search** for SIMs by **SIM ID**. ### What's improved * **Single-Core SIM profile information** now matches Dual-Core SIMs and shows expected connectivity behavior. ### What's fixed * Searching for a profile ICCID on a SIM that has switched profiles would sometimes not return any results. ### What's new * **Bulk select, pause, and resume SIMs** from the SIMs page in your dashboard. Bulk selection works even when changing filters. * **Pause and resume a SIM** when opening it from the SIMs page. The new Manage SIM button in the header of the SIM details page will be the main destination to take any action on individual SIMs in the future. * **Sort** by any column on the SIMs page. * **Filter by tags and SIM status** on the SIMs page. * **Location data and a map** for the last connection now show on the SIM details page for most carriers. ### What's improved * The SIMs page remembers your sorting, filtering, and selections, even after navigating away. * Column sizes on the SIMs pages. ### What's fixed * Opening certain pages in a new tab should not switch you to your personal organization. Please send your feedback if you still find this happening. * Missing data plans and SIM IDs in the new Usage reports should now correctly display. * Data plan and SIM IDs now correctly display in the early access data usage reports. ### Known issues * (Resolved) Verizon returns incorrect, randomized locations for nearly all sessions. These appear in the Last Connection information for a single SIM and in session history. ### What's new * **Map and location** information for the last session are available on the SIM Status page. * **Pre-deployment testing** configuration shows the SIM's testing duration in the SIMs pages. * **Profile name** column. * **Tooltips and help text** for APN and status information in the SIMs pages. ### What's improved * SIMs page loading times. ### What's fixed * **Email invitations for new users** now correctly let new users join an organization. * **Inaccurate activation dates** have been fixed in the SIMs pages. * **ICCID filters** now apply when leaving the filter in the SIMs pages. # Hologram Release Notes Source: https://docs.hologram.io/release-notes/release-notes-2025 Keep up with the latest Hologram product and API updates. ### What's new * The **Data plans** page has been reworked to show all data plans available to your organization. * Data plans are now categorized by plan type: Pay as you go plans, Included data plans, and Data pools. * Custom data plans with negotiated rates are now separated from Standard data plans for organizations with an active contract. * By default, Standard data plans without any assigned SIMs are hidden from view, but can be displayed using the toggle switch. * Pre-deployment SIM counts are now displayed for organizations with access to Test Mode. Clicking SIM counts will filter the SIMs pages to those specific SIMs. * The `/plans` API endpoint now contains new properties. * `use_variable_rates` denotes plans configured with Network-Level Billing. When `true`, the return will also include a `rates` object that contains the rate range for that plan. * `is_dynamic_pool` denotes dynamic data pools when configured. * `display_category` differentiates between Standard data plans (`standard`), and Custom data plans with negotiated rates (`custom`). ### Known issues * For organizations configured with Network-Level Billing, Standard data plans with flat rates will still display NLB rates within Coverage Explorer. This should be fixed by the end of January. ### What's improved * The **Welcome page** for new users includes some additional links and resources for getting started with Hologram SIMs. * The **Webhook** tab for a single SIM has been updated with clearer labeling and descriptions. ### What's fixed * The **Pricing** tab for a single SIM no longer treats SIMs with a 0 MB data limit as having no set data limit. * The **Recent sessions** tab for a single SIM now correctly hides the SIM name column. ### Known issues * The **Profiles** tab for a single SIM displays the MSISDN of the enabled profile for all installed profiles instead of each profile's MSISDN. ### What's new * **Our end-of year survey** is now open and is linked from your dashboard. After the notification is dismissed you can find the link again by opening the **Support** menu. ### What's fixed * **System notification banners** no longer show an error when dismissing items past the first when multiple notifications are in effect. * **Test Mode duration** information in the SIM's details page now displays correctly for certain custom configurations. ### What's new * **Deactivated date** has been added as a new column to to the Deactivated SIMs page with an accompanying filter. * SIMs with a **Deactivating** status instead show the date and time the deactivation request was made. ### What's fixed * **Deactivated date** now correctly displays in the SIM details page under the SIM and Device tab. ### What's new * Added **Total data usage** to the Data Usage **by Session** report. * Hologram's standard data plans for self-service accounts have changed: * **Global G3 Standard Flat Rate** – Available for our standard Hyper SIMs with Global-3 (G3) profiles. This plan remains the same as before, with a new name. * **Global Standard Flat Rate** – Available for any other Hologram SIM configuration. **Important:** Beginning October 31, 2025, SIMs on legacy data plans such as our old Professional Plan Flexible Data or Maker Edition Plan will be migrated to our new standard data plans. Affected organizations were contacted in advance. ### What's improved * **Total data usage** for the Data Usage **by SIM** reports now displays in MB to match the By Day report. * Session-level reports **label IMEI\_SV when present** and show the last known IMEI field to accompany it. ### What's fixed * Updated **Total data usage** for the Data Usage by SIM report to correctly summarize data usage for **active SIMs only**. * Historical data usage reporting is available in the Data Usage by Session report. * Fixed a bug in the Data Usage by SIM report that could rarely include SIMs in unexpected pre-deployment states. ### What's fixed * The **Activity history details** page now correctly displays device IDs, and additionally shows the SIM ID. * The **Activity history details** page is no longer accessible if the action was taken on 0 SIMs. * **Help and documentation links** in your dashboard now point to our [new documentation](https://docs.hologram.io/). ### Known issues * The **Activity history details** page CSV export returns SIM ID instead of Device ID. ### What's fixed * References to the [configure your device for a Hologram SIM](/guides/get-started/set-up-your-device-to-use-a-hologram-sim) guide have been fixed and should load as expected. * References to a deprecated Test Mode API endpoint have been removed. ### What's new * We've refreshed and reorganized our Help Center. Hologram's **new Documentation** can now be found at [https://docs.hologram.io](https://docs.hologram.io). * Old links that pointed to Help Center content at support.hologram.io will now redirect to docs.hologram.io. * New **billing documentation** is available in the [Help & FAQs](/guides/billing/how-billing-works) page under **Billing**. Here you can find new guides for: * [Data plans](/guides/billing/data-plans-overview) * [Network-level billing](/guides/billing/network-level-billing-overview) * [Invoiced (postpaid) billing](/guides/billing/invoiced/postpaid-billing-overview) * [Custom billing](/guides/billing/custom/custom-billing-overview) * [What happens when billing methods change?](/guides/billing/what-happens-when-billing-methods-change) * **Updated product documentation** is available at [https://docs.hologram.io/dashboard](https://docs.hologram.io/dashboard). Here you can find clearer documentation for specific features, functionality, and data available in your dashboard. * Guides now include **cross-links** to related content, guides, and actions. * **[Release notes](https://docs.hologram.io/release-notes)** now have a dedicated page in the navigation and can be filtered by product. * **Search results** now include API calls. ### What's fixed * We've removed a number of older guides that were no longer relevant or accurate. * Screenshots have been removed or updated to match recent UI changes. ### What's new * **Updated REST API documentation** is now available at [https://docs.hologram.io/api](https://docs.hologram.io/api). * You can now test API calls directly, find updated examples, and find additional information for newer endpoints. * Dashboard now links to our new API documentation. * **Updated product documentation** is now available at [https://docs.hologram.io/dashboard](https://docs.hologram.io/dashboard). You can now find documentation for all features, functionality, and data available in your dashboard in one place separate from our how to guides and FAQs. ### What's fixed * **Tagging SIMs in activation** no longer submits the activation when creating new tags, and correctly applies new tags to activated SIMs. ### What's new **Important:** As of August 2026, bootstrap profiles are now known as **manufactured profiles**. The bootstrap profile ICCID is the manufactured profile ICCID that was enabled during manufacturing, and is printed on physical SIM cards. For SIMs with multiple installed profiles, you can now filter the SIMs pages by the ICCID printed on the physical SIM card. This profile that is initially manufactured on the SIM card is known as the **bootstrap profile**. * **ICCID filters** in the SIMs pages filter on both enabled profile and bootstrap profile. * **Bootstrap profile ICCID** now has a dedicated column in the **Pre-deployment SIMs page** to help manage SIMs in Test Mode with multiple installed profiles. ### Known issues * The SIMs page ICCID filters only search the enabled profile and bootstrap profile, even if additional profiles are installed. * The Active SIMs page will not display matching bootstrap profile ICCIDs by default, unless the enabled profile is also the bootstrap profile. ### What's fixed * Stopped incorrectly showing the new user Welcome page for some organizations on login. If you have active SIMs you should now correctly see either the Active SIMs page or the Home page. * Fixed a rare bug that would log users out shortly after logging in. * Fixed a bug that prevented password resets for some users. ### What's fixed * Emailed hardware invoices are now being sent on behalf of [support@hologram.io](mailto:support@hologram.io) as expected and should no longer be flagged by Google as possible spam. ### What's new * **Exports from the SIMs pages** now include "Connected" statuses. * The **manage secure tunneling** action now displays a SIM's Link / Profile ID when changing settings for a single SIM to make finding the ID easier when using Spacebridge. ### What's improved * Our **password strength requirements** have increased. Our new minimum password requirements: * 8 characters (up from 6) * 1 number * 1 UPPERCASE * 1 lowercase * 1 special character * This change applies to new account creation and password changes only. This change does not invalidate existing passwords, and does not require users to update existing passwords. * Organizations with network-level billing can no longer download incorrect Statements, and will see disclaimers in Billing pages with more details about their billing configuration. ### What's fixed * Organizations with custom billing now correctly see data availability disclaimers in Billing pages. ### What's new **Breaking change:** The `/devices/locations` endpoint has a default limit of 50 results, with a maximum limit of 5,000 results. The endpoint is now paginated and will use the `startafter` property to return additional results like with our other API calls. [View API documentation](https://hologram.docs.apiary.io/reference/devices/list-all-device-locations) ### What's improved * The `/devices` endpoint is faster. * The `/devices` endpoint now properly returns the most recently known location of all profiles on a device. ### What's new * **Zero-data rates** now display in the Data plans page for data plans configured with a zero-data rate. * **Zero-data discounts** now display in the Pricing tab for a single SIM if the SIM has been configured with a zero-data rate and the SIM has used 0 B of data in its current billing period. * We've added a link to Hologram's **Release notes** to the **Support menu** in your dashboard. Press the Support button in the bottom of the left-hand main menu in your dashboard to find this link, to give us feedback, or get help. ### What's improved * Calls to `GET https://dashboard.hologram.io/api/1/devices/:id` and `GET https://dashboard.hologram.io/api/1/devices` are simpler and faster, and no longer return plan prices in the nested `plans` object. * **Important:** Requests to the /devices endpoint can still get the old default plans response by providing an `includePricing` parameter in the request. * The old default `/devices` payload included plan pricing and returned this payload: ```json theme={null} "plan": { "id": 2, "zone": "global", "name": "Pay as you Go Plan 123", "data": 0, "cost": "1.000000", "sms": "0.190000", "overage": "0.250000", "account_tier": "BASE" } ``` * The new default payload looks like this: ```json theme={null} "plan": { "id": 2, "zone": "global", "name": "Pay as you Go Plan 123", "data": 0 } ``` ### What's improved * Organizations with network-level billing can now find all their invoices in the same table in the Billing section on the Invoices page. ### Known issues * Statements and transactions are unavailable for organizations with network-level billing or custom billing to avoid confusion between invoices and transaction reports. * If your organization is affected, you should continue to rely on billing reporting provided by your account team. We are actively working to provide new, detailed billing reporting for these organizations. ### What's improved * Contracted accounts configured with custom billing may have manually managed billing data including invoices and data plan rates. If your organization is custom billed, you will now see warnings across your dashboard if the data displayed is manually managed and may not be 100% contract-accurate. * If your account has custom billing, your billing data should be referenced either directly from contracts or billing documents provided by your account teams. * If you have any questions, [contact support](/guides/get-started/contact-support) or reach out to your account representative; we're here to help! ### What's fixed * The **Transactions page** no longer crashes. ### What's fixed * The **Data usage by session** report now correctly filters results by the selected date range. ### What's fixed * We tidied up several small UI elements in the Activation workflow — particularly first-time SIM Activation for new users — that were misaligned or broken. ### Known issues * Fixed in v2.7.1 ~~The **Transactions page** in the Billing section of Dashboard crashes with an error due to an internal codebase update performed during v2.7.0.~~ ### What's new * Our **Registration form** now requires a phone number for new users registering for dashboard for the first time for a new org. ### What's improved * The **Switch Profiles** action for a SIM now optimistically updates the UI with the selected profile's "pending" state to provide clearer feedback that a profile swap request is in progress. * The **Switch Profiles** action now also checks the profile state when opened, preventing users from submitting multiple switch requests at once. ### What's improved * **IMEIs available in search** are now updated within seconds. In the past, it could take up to 24 hours before IMEI was searchable. * **SIM status indicators in search results** update more quickly to match what's displayed in the SIMs pages in Dashboard. ### Known issues * Searchable IMEIs for USA-1 and USA-2 profiles are delayed by 1-3 hours due to carrier usage reporting. ### What's fixed * The **Recent sessions** page for a SIM shows the correct notification for SIMs that have exited Test Mode but haven't had any further active sessions. * Fixed a bug introduced in the previous release that caused the Recent Sessions table to sporadically sort in reverse chronological order. ### What's improved * **Sessions that occurred in Test Mode are now labeled in the Recent sessions tab** for a SIM. This distinguishes free Test Mode activity from billed data usage. ### What's fixed * We've fixed a bug that could incorrectly charge Auto-Refill to misconfigured accounts that were formerly prepaid. * Dashboard **Search now ignores whitespaces** in number-only search queries like ICCID. * The **Manage secure tunneling** modal had a broken link to the Help Center. ### Known issues * **Fixed in v2.6.2** – The Test Mode label in Recent Sessions doesn't appear if the SIM has activated and the last session was in Test Mode. It will only appear if a session has closed since activation. ### What's new * **Registering a new Hologram account** is quicker, with fewer steps! * All new users are added to a business organization when creating a new account, which is set to their default organization. Now all new accounts can add collaborators by default without the restrictions of a personal organization. ### What's fixed * The Pre-deployment Age Analysis report filter correctly loads in and lists SIMs by time in testing. ### What's fixed * The Pre-deployment SIMs in Testing report now correctly shows total data usage in bytes instead of MB. ### What's fixed * The single SIM data usage report correctly shows data usage after a SIM has been deactivated. ### What's new * Our **data usage reports** have been updated to be more reliable, accurate, and quick, with additional breakdowns of your data. * **The SIM Details data usage reports** have been consolidated down to a single Data Usage tab. * **Data Usage by SIM** now contains all fleet-level SIM reports in one location including Data Usage by SIM and Day and by Network. * A **new Outbound SMS by SIM report** can be found within the Usage section → By SIM tab. * A **new Data Usage by Profile report** is available within the Usage section → By SIM tab. ### What's improved * **Reports run faster** for most organizations. * **Data visualizations** **no longer hit display limits** when viewing large session counts, and show the most recent session information. * **Outbound SMS counts** are available in the Data Usage by SIM, SIMs in Testing, and Pre-deployment Age Analysis reports with SIM SMS limits. * The **Data Usage by Session report** now includes a visualization of recent sessions. * **Location information** should now be available and more reliable for more sessions. * **Test Mode configuration** information has been added to the Pre-deployment SIMs usage reports. ### What's fixed * Outbound SMS counts were incorrectly calculated in the single SIM data usage report. * Active SIM counts could rarely fall out of sync with the Home and SIMs pages in Dashboard. * Global-3 and USA-2 CAT1+ profile names would not appear reliably in all Active SIMs reports. **Note:** As of 2026-08-19, US2 profiles can no longer be distinguished between Cat 1+ and Cat M1, and are labeled as US2. * SIMs that transferred organizations mid-month would sometimes have mismatched data across reports. * SIMs that transferred data plans mid-month would sometimes have mismatched data across reports. * SIMs with data usage on inactivated profiles would sometimes have mismatched data across reports. ### What's fixed * **Updated billing pages and recent invoices** correctly display for contracted accounts with network-level billing. * **Network-level billing rate cards** when viewing coverage for data plans or individual SIMs correctly display for contracted accounts with network level billing. * **Billing API calls** correctly return updated invoice details for contracted accounts with network-level billing. * If assigned to a SIM, public IP addresses now correctly display in a SIM's Status tab in the Last connection card. ### What's improved * The Last connection card for a SIM will now display a warning if the **last session occurred during Test Mode**. * Icons are now consistent across the SIM's Status tab. ### What's new * **A new Status card on SIM details pages** better illustrates a SIM's connectivity status, separating out Last connection details into its own card. * **Copy IDs to your clipboard** from a SIM's details page by clicking the IDs in the header or in the Status card. * A simpler **Start page** listed on the back of our printed SIM cards helps you get connected faster. ### What's improved * The **Last connection card** on a SIM's details page has better handling of missing network information and includes Profile name. * Carrier information for a SIM is now more accurately categorized and labeled as **Mobile core operator**. ### What's fixed * **Pay Monthly plans with included data** now show correct rates in Coverage cards when viewing a single SIM or data plan. * SIMs with a **Deactivating** status, in a `DEAD-PENDING` state, now correctly show connectivity, pricing, and session details when viewing a single SIM. * **Long data plan names** without spaces now display correctly in the Activation and Change Plans workflows. * The **Profiles tab** for a SIM now uses the correct icons for SIM statuses. ### What's new * **Sort and filter SIMs in Test Mode by target activation date** in using the new column and filter in the Pre-deployment SIMs page. ### What's fixed * A bug showing incorrect **ranges of data usage rates in Coverage pages** has been fixed for contracted organizations that have access to variable rates per network. * **Data usage totals** now support TB labeling, and decimal place display is more consistent across dashboard. * **Date range filters stored in a user session** now behave as you'd expect when set to a relative date. * **Date pickers** and the change organization dropdown no longer run off the screen, especially when they had long labels * Dashboard's header layout has been improved on low-resolution displays. ### What's new * **Find Data plan pricing and coverage** by clicking into the **new Data plan details page** from the Data Plans page or from a SIM's Pricing page. Here you can find detailed pricing, coverage, and other info for each of your data plans. * **Filter SIMs with no tags** using the Tag filter in the SIMs pages. ### What's improved * **Static data pool information** is more consistent and accurate across your dashboard. * We've made a large number of small visual improvements across dashboard to make the experience more consistent. ### What's fixed * **Coverage explorer price ranges** should now display as expected for all data plans. * **SIMs with no data usage** should now show as expected in the Data Usage by SIM report. We've moved them to a new table in the report. ### What's new * We've updated the **look and feel** of Dashboard to better represent our current branding! * **New billing pages for contracted accounts with network-level billing** and variable rate data usage. ### What's improved * Dashboard now looks, feels, and works more consistently across operating systems and browsers. * We've removed even more data from initial loads to speed up loading times. ### What's fixed * A wide range of small issues have been fixed across dashboard including accessibility improvements. * Low-resolution displays now have more consistent scroll and padding behavior. ### What's new * **View coverage and rates when Activating SIMs or Changing data plans.** Now you can understand precise network coverage and rates when choosing a data plan for your SIMs. ### What's improved * The **SIM's Pricing** page now supports SIMs with network-level billing and variable rate data usage. * The **SIM's Pricing** page now supports zero-data rate MRCs for contracted accounts with zero-data rates. ### What's new * **Outbound SMS counts** are now available in the data usage reports by day, by SIM, by SIM and day, and for single SIMs. * **Data usage by location** reporting now provides additional detail for data usage by SIM. ### What's improved * Data usage reports in your dashboard have been improved in a number of ways: * **Load times** have been drastically improved. All reports should load in at least twice as fast. * **Tag filters** now search on individual tags as expected. * **Filters** are now synced between tabs in the Usage section, and for a single SIM. * **Dashboard load times** are a little faster, and load in less data. ### What's fixed * Clicking into old Devices links now directly open SIMs pages instead of rerouting the links. ### What's new * **View coverage and rates for your SIMs in the new Coverage Explorer.** Open up any SIM and head to the Coverage tab to see a breakdown of all available networks, rates, RATs, and more available to your SIMs. [Read more about Coverage Explorer](/dashboard/billing/coverage-explorer) * **Find recent sessions** across all your SIMs and dive into more details in an improved Recent sessions page under the Usage section of your dashboard. This replaces the old Live Sessions page. ### What's improved * We've replaced some old code to reduce overall **loading times** of your Dashboard. * **Adding tags in the Activation and Change Plan** workflows has been updated to match the SIMs pages. ### What's fixed * **Creating a new tag** from the SIMs pages bulk action would sometimes not apply the tag to every selected SIM. * Tabbing through and selecting some controls like dropdown menus should now work and display as expected. ### What's fixed * **Home page** **pre-deployment SIM counts** now correctly include all possible pre-deployment SIM states with labels updated to match the SIMs pages. Pre-deployment SIM counts now display as expected if you have no pre-deployment SIMs. * **SIMs page deep links** correctly recognize URL filters as expected for all users. * **Logos** are no longer blurry on high DPI displays. * Minor visual and bug fixes. ### What's improved * **SIM location history reporting** now warns about SIM profiles that don't provide location data. * **SIM recent sessions** help text and empty states improved for clarity. * **Simulating a message from the Activity console** correctly pre-fills existing message details as it did before. * Minor visual and bug fixes. ### What's new * **The SIMs pages have exited beta!** 🚀 We're waving a fond farewell to the Devices pages that have served us well for nearly 10 years. * **All available SIM actions** can be found under the Manage SIM dropdown at the top of page when viewing a SIM. * **Device IDs** can be found on a SIM's Status tab or the SIM and Device tab under the Devices sections of the respective pages. * **Link ID**—the ID of a profile—can be found on the Profiles tab. * **Data plan and pricing information** can be found under the Pricing tab. * **Recent sessions** are now available in a SIM's details page under the Recent Sessions tab. * The last 100 sessions display on this page by default, and can be **exported** from the top of the Recent sessions card. * **Profile changes and fallback events** are called out directly in this table to make troubleshooting profile changes clearer. * **SIM location reporting** can be found in a SIM's Location history tab. Please note that location is not provided for every network or session. * **Fleet location reporting** is now available in the Usage section of your dashboard under the By location tab. * **Drill down into tagged SIMs** directly from the Tags page. ### What's improved * The single SIM's Data usage tab has been **renamed to Data reporting** to more accurately reflect that data is delayed by up to an hour. * **Device ID** has been added to the SIM's Status tab under the Device section. * **Link ID** labeling has been re-added to the SIM's Profiles tab. ### What's fixed * **Previously set data limits will now display as expected** when setting a data limit for a single SIM. * **ICCID filtering** in the single SIM data usage report now correctly filters cards in the report. * The **Simulate button in the Activity console** now directly opens the Simulate message to API modal for the selected SIM. * The **Home page** now correctly categorizes all pre-deployment SIM states. ### Known issues * After sending an SMS or cloud message to a SIM, the Activity console does not automatically open. * SMS counts are not yet available in the Data usage by SIM report. * Creating a new tag using the SIMs pages bulk action does not automatically apply it to the selected SIMs. ### What's improved * **Timestamps displayed in the SIMs** pages are now consistent and show conversion from UTC to local time on hover. * **Deactivated SIMs'** details pages now correctly hide or show data and tabs if the data is no longer available or reliable. ### What's new * **Manage Phone Numbers** from a SIM's details page. Open the SIM's **Pricing tab** to find available add-ons for a SIM, including phone numbers. Added phone numbers will also display on the **SIM and device tab**. ### What's improved * Purchasing a phone number now gives more detail when no phone numbers are available for a country. Please note that phone numbers are only available for countries that match your billing address. ### What's improved * The SIM details page has clearer and improved **error and empty states**. * **Warning banners for missing billing addresses** should no longer flicker as frequently on and off while navigating your dashboard. ### What's new * **Outbound SMS counts** are now available in the SIMs pages. Open any SIM and find the outbound SMS usage under the **Status** tab in the **Usage this billing Period** card. * **MSISDN** now displays for every profile on a SIM's Profiles tab. ### What's improved * **Single SIM Data usage reports** now default to the SIM's billing period. Data usage in the report should now match the data usage in the SIM's current billing period. Please note that this report runs hourly, so recent sessions may not appear immediately. Recent session data will be added this page soon. * **Profile details** for SIMs have been improved to make profile states, details, and expected behavior clearer. * **Profile history** now always displays at the bottom of the Profiles tab. ### What's fixed * Global-3 profile names now correctly appear in the single SIM data usage report. **Caution:** Once recent session data and managing phone numbers have been added to the SIM details pages we will be sunsetting the old Single Device Page. Links from Devices will point to the SIM's details page. ### What's improved * **Activation** now defaults to showing Standard Data Plans if there are no Custom Data Plans that can be added to the current SIM. * The **Status filter Select all option** on the SIMs pages has been removed. * **Dropdown panels** like the Organization picker now correctly layer with other elements on screen and stay on screen as expected. ### What's new * **Set data usage warning thresholds** in the SIMs pages. ### What's fixed * **Removing a phone number** no longer crashes Dashboard. ### What's new * **Manage secure device tunneling** and communicate with your devices with Spacebridge, now available in the SIMs pages. This action can be taken on up to 10 SIMs at a time. ### What's new * **Simulate a message** from your device to the API from a single SIM's details page. ### What's fixed * Some actions in the SIMs pages like Change Plan and Pause/Resume SIMs were showing as available even if the SIM couldn't take the action. Actions should now correctly check SIM states. # Hologram Release Notes Source: https://docs.hologram.io/release-notes/release-notes-2026 Keep up with the latest Hologram product and API updates. ### What's fixed * **SMS limit pause alert emails** now go out at most once every 24 hours per organization. Before, a new email went out on every SMS biller pass while SIMs stayed paused. * **Order receipt emails** are no longer sent for contracted accounts that already display orders within their invoices. * **Changing state with `POST /devices/state`** now updates each SIM's intended state. ### What's new * **We are moving to a new SIM-level data limit field** (**`data_limit_bytes`**) to set data limits to an exact value regardless of a data plan's included data, like how data warnings work (with `datathreshold`). This field can be set using `PUT /simcards/{{sim_card_id}}`. * This is separate from `overagelimit` at the profile (link) level, which can only be set above the plan's included data. Setting an overage limit on a profile via existing endpoints will still work as it does today and will update `data_limit_bytes`, but checks are now made against the new field. ### What's improved * **Data limits and data warnings are checked much faster** after reaching a limit. SIMs will be paused sooner after reaching a limit and alerts are sent out faster. * **SIMs paused by reaching a data or SMS limit** now resume as soon as the limit is raised above the SIM's current billing period usage. * **SMS usage can now be filtered by SIM.** Pass `simcardid` or a comma-separated list of `simcardids` to `GET /usage/sms`, and use `usagetype=simtotal` to get one row per SIM per period without duplicate rows for each profile. ### What's fixed * **Data and SMS limits of `0`** correctly apply using the `POST /devices/usagelimit` and `POST /devices/{deviceid}/usagelimit` endpoints. ### Known issues * When updating `data_limit_bytes` ,`datathreshold` , `smslimit` or `overagelimit` values for a SIM card. SIMs configured with alerts may received duplicate alerts, will be addressed soon in future release. ### What's new * New SKUs have been added to [SIM datasheets](/guides/sims/hologram-iot-sim-datasheets). ### What's fixed * **Change plan** would sometimes show plans for other profiles as available even if they didn't have coverage for the SIMs you selected. * **Viewing coverage** when activating or changing plans now scrolls correctly. * MFF2 embedded SIM designs in the SIM datasheets now show the correct printed ICCID format. ### What's improved * The SIM **Profiles tab** has clearer display and labeling of enabled, fallback, manufactured, and uninstalled profiles. * The SIM **Pricing tab** displays a warning if the SIM's **data warning is higher than a data limit** and may never be reached. * **Set data warning threshold** will now display existing data limits if all selected SIMs share a data limit or have mixed data limits. * The **[update location endpoint](/api/1/links/cellular/updatelocation/post)** displays all errors at once instead of returning one error at a time. ### What's fixed * SIMs on a data plan with included data could have an incorrect data limit set during Change Plan or when bulk changing data plans. * SIMs with mixed data limits would not have their data limit updated when changing plans if they were already on the selected data plan. ### Known issues * Data limits and SMS limits cannot be set to 0 using the `/devices/usagelimit` and `/devices/{deviceid}/usagelimit` endpoints. Until a fix is in place, data limits in your dashboard can only be set to values above 0, or above the included data amount for plans with included data. ### **What's new** * **New icons** match our latest branding and bring clearer iconography to some actions in your dashboard. ### **What's improved** * **Dates** use a consistent format (2026-09-25) everywhere, except in cases where the month is written out. ### **What's fixed** * Chromium browsers were unable to upload CSVs in Activation using the system file browser. Drag and drop was unaffected. ### **What's new** * **Connected** is now shown as a distinct status indicator, separate from a SIM's network status. * Ready SIMs that are connected still show as “Connected” in the UI. However, any other status can now show Connected as a separate status next to it. * **Network refresh (Update location)** actions are now available in the SIM details page and SIMs tables. This will issue an update location command to carriers, interrupting open sessions or attempting the next time your SIM connects. * **Bulk SIM selection** checkboxes now support shift-click to select a range in SIM Inventory, plus a right-click menu to select the first 10, 1,000, or 10,000 SIMs in the current filter. * **Release notes** now appear as a notification the first time you open your dashboard on a new minor or major release. * The Hologram **Status Page has more granular tracking** of services and individual carrier profiles. * The **login page** has an updated layout and displays the Hologram system status. * The /devices GET endpoints return intended\_zone, intended\_plan\_name, intended\_plan\_data, sim\_format, and whenclaimed for each SIM (on the device), and profile\_name for each profile (on the cellular link). ### **What's improved** * **System status alerts** are filtered to the carrier profiles your organization uses so that you only get notified of updates that matter to your fleet. * **Home page SIM counts** no longer subtract Connected SIMs from Ready as this is a separate count. * **Connected SIMs can be filtered separately from Ready or In testing** statuses in the SIMs tables. ### **What's fixed** * **SIM counts on the Tags page** no longer hide tags that have not been applied to any SIM. * **Phone number pricing** when purchasing a phone number was truncating fractional amounts and could show incorrect rounded values monthly phone number prices. * **Collapsing the main menu** once again uses the correct styling for nav items. * The **Keep me logged in checkbox** has been removed from the login page until it's working again. * **Invoice due dates** are calculated based on the date the invoice was sent rather than when it was created. * **SIM renewals could sometimes be duplicated** in rare cases where states changed incorrectly. * Profile-level state changes no longer override the **SIM's intended network state**. The SIM's intended state changes once every profile on it is in, or moving to, the requested state. * **A manual profile switch** on a SIM with no open data session now queues the enable against the profile's carrier instead of showing no queue activity. ### What's new We've updated our [REST API documentation](/api/v1) categorization, descriptions, and examples to better reflect what you see in your dashboard and when working with our documentation. * **Field descriptions** are more comprehensive, with better descriptions for fallback and usage limit fields * **Bulk and Single-SIM actions** are categorized appropriately * **Descriptions** are more consistent across related endpoints * **Endpoint labels and categories** are more closely aligned with what you see daily in our product and documentation * **OpenAPI file overviews** have been updated with more recent information from our docs ### What's fixed * **"Cloud messaging" endpoints** have been correctly recategorized to either "Events and Alerts" or "SIM bulk actions". * **Data usage reports** would display missing profile names for some carriers. This should now match what you see in your dashboard. ### What's new * **Bulk [data limit](/dashboard/sim-actions/set-usage-limits) and [data warning](/dashboard/sim-actions/set-data-warning-threshold) updates** can now be performed on any number of SIMs. Updates are made in 2,000 SIM batches with progress indicators. * **Bulk data warning updates** can now check and pre-fill already set warning thresholds for up to 500 SIMs, and better match the bulk update data limit action. * **Bulk data limit updates** now match the behavior in activation, with a recommended default of 10 GB. They can check and pre-fill already set data limits for up to 500 SIMs, and better match the bulk update data warning thresholds action. * **SIM SKUs and manufactured profile ICCIDs** are now displayed for all SIMs in the [Activation](/dashboard/activation/activation-overview) and [Change Plan](/dashboard/sim-actions/change-data-plans) workflows. ### What's improved * **Errors when adding SIMs** in the Activation and Change Plan workflows are now clearer for both SIMs and profiles. ### What's fixed * **0 B data limits** can no longer be set on data plans without included data, as intended. ### What's new * The **bulk rename SIMs** endpoint `POST /devices/names` now accepts a `names` array of `deviceid`s and `name`s to batch apply individual names to SIMs. * Get **summarized usage for a SIM's current billing period** using `GET /usage/billing/simcard/{simcardid}`, supplying the SIM ID. This call is different from `GET /usage/data/billing` in that it is SIM-level for a specific billing period. ### What's fixed * The **bulk rename SIMs** endpoint `POST /devices/names` could sometimes assign incorrect ICCID suffixes to device names. This could surface in the dashboard rename bulk action in certain cases. * **Data plan SIM counts** now check SIM-level network states instead of profile-level network states. SIMs that have removed bootstrap profiles could affect this number. This check now also includes zone to support legacy multi-zone plans. ### What's fixed * Filters in the **data usage by day report** for active SIMs now work as expected. It may perform slightly more slowly until we can make additional updates. * The **data usage by day report** total SIMs with usage counts were counting profiles with usage instead of SIMs with usage. * The **single SIM data usage by day report** now shows days without usage. * The **single SIM data usage by day report** no longer shows inaccurate usage when SMS messages occurred in a day. ### What's new * **Profile change events** show why a profile changed, via a Manual, Conductor, System, or Fallback event. * **Legacy alerts have been deprecated for unsupported systems** like Losant, IFTTT, deprecated Slack webhooks, and Amazon S3. Old alerts relying on these systems will no longer generate events or notifications. Consumers will need to migrate to webhook or email notifications. Deprecation notices were sent to affected accounts in December 2025. * **Profile change events** are now created for all profile changes including manual profile changes, fallback events through Outage Protection, and Conductor configuration changes. ### What's improved * **Unrecognized event tags** display as a warning instead of a “not supported” error for explicitly unsupported tags. ### What's fixed * **Async change requests** permissions have been fixed for the `GET /asyncchangerequests` endpoint. * **Data sessions that close within the same second** in some cases could be overwritten by the most recent record. * **User-paused SIM states are preserved during billing renewal** instead of converting it into a system billing pause. * **System-paused SIMs** no longer display a resume data usage action that cannot succeed. ### What's fixed * **Transactions** would not appear for some prepaid customers until the first day of the month after they had used data. ### What's new **Deprecation notice:** We are moving away from "bootstrap" and "operational" profile fields and terminology and your API references will need to be updated. Our APIs have new manufactured ICCID fields to identify manufactured profiles on SIMs. If your consumers rely on the `euicc_type` field's BOOTSTRAP or OPERATIONAL values within profiles (`link` objects) you will need to update your systems to use the new `manufactured` field on the `link`. * **Manufactured profiles** are the profiles installed on a SIM at the time the SIM is manufactured, and are noted by the new manufactured property. These are printed on our triple-cut cards. * **Installed profiles** are the profiles currently installed on a SIM. * A SIM's network state and intended data plan should now be derived from `intended_network_state` and `intended_plan_id` on the `/device return` (a SIM object), not from individual profiles. * The manufactured profile that was enabled during manufacturing is the profile printed on the smallest size triple-cut card (4FF size) and our embedded SIMs (MFF2). * Manufactured profiles can be deleted and deactivated from the physical SIM, but do remain linked in our systems for discovery purposes. These profiles will have a deactivated/deactivating status (`DEAD`/`DEAD-PENDING` network state), and a profile state of `UNAVAILABLE`. * A **Manufactured profile ICCIDs** column has been added to the Active, Pre-deployment, and Deactivated SIMs pages, and displays in exports. These ICCIDs are permanently associated with your SIM. This column is not yet sortable. * The **Profiles tab** for a SIM now lists all associated manufactured profiles in the footer of the Profiles card. * Bootstrap profiles can now be deleted from SIMs and are reflected correctly in the UI to match. * The local SIM **profile-level delete** indicator is now available on `links` objects with the `delete_restricted` property. ### What's improved * **Search** now identifies manufactured and installed profile ICCIDs, and searches on all manufactured profiles. * **Deactivated profiles** are now hidden from display on a SIM unless the SIM is also deactivated. * **Deactivated profiles** have more useful descriptions. * **Manufactured profile** references have been added to documentation. ### What's fixed * **SIMs paused by the system** now disable the resume action instead of erroring out when attempting the action. * The **Tags page** correctly displays tags that have not been applied to any SIMs yet. ### What's new * [Triple-cut SIM datasheets](/guides/sims/hologram-iot-sim-datasheets) now include a **manufacturing testing and tolerances section** with dimensional tolerances, extraction force, materials, and more. ### What's fixed * **SIM Write endurance** for SGP.32 G3-R SIMs updated to the correct “>2M cycles” from “>1.5M cycles”. ### What's new **Breaking change:** USA-2 CAT1+ (US2+) and USA-2 CATM1 (US2M) profiles are both now labeled as **US2** profiles. We were able to distinguish these profiles based on IMSI prefixes, but the prefixes have changed and we are now unable to do so. Cat 1+ and Cat M1 SIMs and devices will need to be identified based on modem type instead. * **Global-4 (G4), Global-5 (G5), and Global-6 (G6) profiles** are now supported in your dashboard. ### What's new * **Recent events** are now summarized on your Home page for a selectable date range. Events link to the matching [Event history table](/dashboard/event-monitoring/event-history). You can [create Alerts](/dashboard/event-monitoring/alerts-and-notifications) to then be notified of these events via email or webhooks. * Data usage limits reached * Data warning thresholds reached * IMEI TAC changes * IMEI changes * First IMEI recognized * Conductor EUICC operation updates * SIMs currently paused by system * The [REST API overview page](/api/v1) now links directly to **OpenAPI JSON and Swagger UI**. ### What's improved * **Table row** heights are more consistent across the UI. * **Alerts that are invalid** because of deleted tags or SIMs can now be edited for easier updates. ### What's fixed * **Newly created tags** no longer disappear from the Manage tags modal when the tag doesn't apply to any SIMs. * **Button loading states** display correctly again. * Checkbox labels for the Coverage and RAT filters in Coverage Explorer display correctly. ### Known issues * **Newly created tags** disappear from the Tags page when the tag doesn't apply to any SIMs. **Deprecation reminder:** Our legacy `/alerts` API endpoints used by Fleet events (also referred to as "Action Items" or "Inflight") as well as the **Fleet events page** in your dashboard are considered deprecated and are no longer supported. Event acknowledgements are no longer supported. We recommend you manage alerts in external systems using webhooks or email integrations. This functionality has been replaced by Alerts and Events. Those features are unaffected by this change. ### What's new * Launched our [Glossary](/guides/get-started/glossary) to cover Hologram-specific terminology. This is a companion to our [Connectivity overview](/guides/get-started/sim-connectivity-overview). **Deprecation notice:** Legacy Alerts for unsupported systems like Losant and Amazon S3 will be deprecated shortly and alerts relying on these systems will be removed. Moving forward, only email or webhook notifications will be supported. Advance notice of this change was sent to affected accounts in December 2025. ### What's improved * You can now check whether you have an outstanding account balance to resolve and whether you own other organizations before requesting an account deletion. ### What's fixed * We introduced a bug in an update last week that broke the tag management visual layout. Tags appeared broken in activation and when editing tags in bulk or for a single SIM. This now displays as expected. * Deprecated plans with multiple zones now display correct information in Coverage Explorer when viewing coverage and rates. * Default sort indicators for table columns with timestamps show an accurate description of the sort behavior. ### What's improved * Hover over more date fields to see **local time** converted from default UTC times. ### What's fixed * Coverage Explorer now correctly shows custom rates for organizations with certain network-level billing configurations. ### What's new * **Event variable documentation** now has a [dedicated guide](/guides/cloud-and-tools/use-event-variables-in-alerts) with better details and return examples. * **Recent session reports** and **recent usage reports** consistently include data plan name, country, tower location lat/long, and profile name fields where appropriate. Recent usage 90-day reports are displayed for self-service organizations only, full historical reports are unchanged. * **Recent session reports** and **recent usage reports** exports also contain data plan ID. * **Tables** now have default sort indicators. ### What's improved * **Toast notifications** now dismiss after 7s by default rather than staying around permanently. ### What's fixed * **Event variable documentation links** in the create and edit alert pages have been fixed and point to the correct guide. * **Date filters** in the SIMs pages are back to their expected width. * Visual alignment on some icons is now more consistent. * URLs with IDs or parameters no longer break inline documentation links. ### What's new * Datasheets and details about Hologram's upcoming SGP.32 Hyper SIMs are now available. View [Hologram Hyper SIM software and hardware specifications](/guides/sims/hologram-iot-sim-datasheets). ### What's fixed * Transaction report CSV exports for customers with custom billing format ICCIDs correctly. ### What's improved * **All feature access in your dashboard is now based on individual permissions**, not on roles. Roles apply a preselected list of permissions. ### What's fixed We've updated a number of role and permission checks in your dashboard to align with intended feature access: * **Alerts** and **Events** are gated to Editor roles and above since event contents can contain billing details. * **SIM webhook creation** is limited to Admin and Manager roles. * **Contracted account negotiated rate indicators** are only visible to Admin users. * The **purchase phone number** link on the SIM and device tab does not display if you can't purchase a phone number. * **New user invitations** can be sent to roles lower than your own. * **Data plan names and IDs** are hidden from exports for Editor Limited roles in the SIMs and Coverage pages. ### What's new **Breaking API change:** Affected legacy endpoints will still work for a time, but contain a warning field in the response. * **We are deprecating legacy endpoints that allow changing network state or plans on individual SIM profiles.** These changes can lead to mismatches between profiles on SIMs. Use endpoints that modify all profiles on the SIMs going forward. * **To change profile states**, instead of `/links/cellular/{linkId}/state` or `/links/cellular/state`, use **`/devices/state`** or **`/devices/batch/state`**. * **To change plans**, instead of `/links/cellular/{linkId}/changeplan` or `links/cellular/changeplan`, use **`/devices/changeplan`**. * **`BOOTSTRAP` profile types should no longer treated the default profile for a SIM.** This was an assumption made on a few fields throughout the API. * **True SIM-level details have been moved from profile (`/links`) to SIM (`/simcards` and `/devices`) top level objects.** * `plan`, `network_state`, `when_expires` and `when_claimed` values are now SIM level. Assuming these states from a single profile will eventually lead to out of date data. * Integrations will need to be updated to use these new fields: 1. Profile-level: `delete_restriction` and `manufactured` flags. Before, this was inferred via the `BOOTSTRAP` profile type. 2. SIM-level: `intended_plan` . Before any plan assigned to the `BOOTSTRAP` was assumed to be the intended plan. 3. SIM-level: `intended_network_state`. Before, the state of the `BOOTSTRAP` was assumed to be the intended sim card state. 4. SIM-level: `when_expires` and `when_claimed`. Before, the `whenexpires` and `whenclaimed` values on the `BOOTSTRAP` were assumed to apply to all profile links. 5. SIM-level: `eid`. Before, the EID (eUICC ID) was assigned to just the `BOOTSTRAP` profile on a device, but is a SIM identifier and available to all profile links. * **Event lists now auto-refresh**. Both the Event history page and SIM events pages now auto-refresh and can be paused. ### What's improved * The **Deactivate SIMs bulk action** has a more informative description, and now uses a checkbox instead of a press-and-hold action for confirmation. * The **v3 announcement card** has been removed from the Home page. ### What's fixed * **“Undefined” locations** in a SIM's Recent connection card should now display correctly with a real location or empty state. ### What's new * Organizations with access to detailed historical reporting will now find the **Description** field available in transaction reports. ### What's new * **Dynamic size data pools** now have descriptions to explain included data calculations. ### What's improved * **Dynamic data pools** have more detailed information in a SIM's Pricing tab. *For customers with access to historical data usage reporting:* * **The Active and Pre-deployment reports should now run faster.** * **Overage usage** is now displayed on by SIM reports for Active SIMs, and in single SIM data usage reporting. **Breaking API change:** The following timestamp fields that currently return “0000-00-00 00:00:00” for their unset state will start returning `null` instead: | Endpoint Group | Fields | | - | - | | `/devices` | `whenclaimed`, `whenexpires` | | `/links/cellular` | `whenclaimed`, `whenexpires` | | `/links/cellular/:id/history` | `end_timestamp` | | `/alerts` | `acked_at` | ### What's new * `/devices` endpoints now return `delete_restricted` and `manufactured` flags. These values track profiles manufactured on a SIM that can't be easily removed. These profiles are most often printed on triple-cut SIMs on the 1FF and 4FF form factors, and are linked to a SIM permanently for search purposes. * Added new guides: * [Conductor](/guides/sims/conductor) overview * [Migrating from 1NCE to Hologram](/guides/migrations/1nce-to-hologram) * [Connect a Raspberry Pi to the internet using a Hologram SIM](/guides/troubleshooting/connect-a-raspberry-pi-to-the-internet-via-cellular-modem) * [Send SMS using mmcli](/guides/communication/send-and-receive-sms-via-mmcli) ### What's improved * **Alert JSON messages** now have formatting and error handling. * **Conductor endpoint** descriptions are clearer. * **Exposed optional `orgid` parameters** for a variety of API calls where they were missing. * The async tasks endpoint `/asyncchangerequests` now includes a **device ID filter**. * Added in progress async task information to `/device` GET endpoints. ### What's fixed * **Transactions and sessions no longer show old tags** if the SIM was transferred and tagged in the old organization. ### Known issues * **Dynamic size data pool included data totals** are not 100% accurate and are only based on the current active SIM count. The total size of a dynamic pool is based on the number of active SIMs on the plan at any point during the month, so any SIMs moved deactivated, transferred, or changed to a new plan will impact the pool count but aren't reflected in your dashboard. ### What's new * Create **data usage warnings** to get notified when your SIMs reach a usage threshold. * Add data warning thresholds using the **Manage SIMs** menu on the SIMs page or from a SIM's details page. This information also displays on the SIM's Pricing tab. * An **[event](/guides/cloud-and-tools/event-types-and-tags)** will be created after the close of a data session when your SIM reaches the amount of usage you set ( this is `datathreshold` in the API). These events will have the tag `_DATAWARNING_`. * You can then create an **[alert](/dashboard/event-monitoring/alerts-and-notifications)** for those events to be notified of unexpected data usage via email or notifications. * [Read more about setting up data usage warnings](/dashboard/sim-actions/set-data-warning-threshold) * **NB-IoT and 5G RATs** now show on data sessions. **Deprecation notice:** The **Fleet events** page containing legacy "Inflight" and "Action Items" functionality is now considered deprecated and will be removed in a future release. This includes old `/alerts` endpoints, which are an unrelated system to the Alerts in your dashboard and cannot generate notifications. ### What's improved * The **Create alert** page now has descriptions of each type of alert. ### What's improved * Better error handling for **alert creation and editing**. ### What's fixed * **Editing, updating, or deleting Alerts** like SMS alerts should now be working as expected. If you continue to run into issues, please [contact support](/guides/get-started/contact-support). ### What's new * **Async change requests endpoints** * When you take an action that requires an asynchronous update to be made to your device—for example a Conductor configuration change, or a plan change that results in coverage changes—you will get an async change request record `id`. This record ID lets you track the status of the device update while it processes. * The new [`/asyncchangerequests`](/api/1/asyncchangerequests/get) endpoint lists all processing change requests for your organization. * The [`/asyncchangerequests/{requestId}`](/api/1/asyncchangerequests/requestid/get) endpoint returns detailed information about a particular async change request, including child requests if there are any, letting you track a large operation with one call. ### What's improved * **Rest API documentation** has been updated to more comprehensively cover available endpoints and parameters with examples and descriptions. ### What's fixed * **Dynamic data pools** now display as expected during activation and when changing data plans. ### What's fixed * **Emailed notifications for alerts** will now be sent as expected. Existing alerts affected by this bug should be fixed by the end of the day on 2026-05-29. ### What's new * The **Event details** modal now formats JSON responses. You can toggle between message formatting, including Base64 decoded messages. * **Refresh** event lists in the Event history and SIM details pages. Creating or updating an alert now also refreshes the events list automatically. * Recent usage reports now all support **CSV**, **XLSX**, and **JSON downloads.** * The **Home page** now breaks out **Connected Pre-deployment SIMs** as a separate metric from Connected Active SIMs. ### What's improved * **Coverage Explorer** now shows a message when no matching networks are found. This usually happens before a plan is fully configured and does not affect coverage or billing. * Coverage explorer now labels coverage as **“Countries and territories”** instead of “Countries”. * **Add a new tag** prefills the new tag name with whatever you had typed in the tag search. * **Bulk send message** to SIMs now preserves your message when you switch between SMS and Data message types. * The **Activity History details** page now has a breadcrumb back to Activity History. * **Activation** and **Change plan** now **retain your ICCID input after a validation error** so you can fix typos without re-entering IDs. * **Phone number purchase** error messaging. * **Managers** in organizations with **Editor Limited** roles can now choose roles when sending invitations. * The **Settings → My organizations** tab now correctly labels the organization owner as “Owner”. ### What's fixed * The **change plan** workflow now correctly keeps and displays set data limits when changing plans for a single SIM. * The **change plan** workflow shows the correct warning when no other plans in your organization have coverage for the SIM(s). * **Toast messages** now time out and dismiss automatically. * **Purchase phone number** options are properly restricted for Editor users. * **Rename tag** in the tag manager now works even if the name has not changed. ### Known issues * **Fixed in v3.4.1** ~~**Email notifications** are not being sent for the following alert types. We've identified a root cause but are still investigating a fix.~~ * ~~Subscriptions to all events for a device or tag~~ * ~~SMS and TCP/UDP messages and responses~~ * ~~API responses to messaging~~ * ~~Simulate message events (limited access)~~ * ~~Socket API messages (limited access)~~ ### What's fixed * When **changing data plans** from a custom data plan and only standard plans are available, you now correctly see available standard plans. ### What's new * **Legacy and deprecated data plans** now have a label so that you can take action and move to plans with better pricing or coverage. * To change data plans for a SIM, click the SIM count for a plan, select your SIMs in the SIMs page, and use the **Manage SIMs menu** to **Change plans**. * **Data limits are now recommended for all SIMs.** We recommend a minimum limit of 10 GB to protect against runaway data usage from theft or device misconfiguration. When activating SIMs or changing data plans, you will now have better options for selecting data limits. * Data plans now display the **plan type** in the Plan details page header. **Hologram standard plans** use our standard rates. **Custom plans** are plans for contracted organizations with negotiated rates. * Added a new **SIM status** diagram to the SIM statuses and states page. ### What's fixed * **Deprecated data plans** are now listed in the Data Plans page along with messaging about how to take action. * The **Activation button** on the Home page is hidden for users without activation permissions. * The Hologram brand **blue color** for interactive elements has been adjusted to match upcoming website changes. ### What's new * **Simulate message to API** functionality is no longer available to new organizations, and has been restricted to organizations that have used it in the past year. ### What's improved * Entering a device ID when **creating an Alert** now verifies the device ID as expected after the field loses focus. Better validation messages have been a dded to the field. * **Alerts that are no longer supported** now show the full description to make it clearer what is no longer working. ### What's fixed * **First IMEI** alerts can now be created and events filtered as expected. * Organizations generating events through the **SIM socket API** can now manage Events and Alerts as expected. This functionality is still supported, but is now considered a legacy feature. * **Alerts that are no longer supported** can now be disabled instead of only deleted. ### What's improved * **Overall API performance** has been improved across both direct API usage and your dashboard. * **Long-running pending tasks** that appear in the top menu now link to support and next steps. ### What's fixed * **Event monitoring and filtered event loading times** are significantly faster and can now handle any size fleet. * **Profile descriptions** for multi-core SIMs in a single SIM's Profiles tab now display the correct descriptions in all cases. SIMs with Outage Protection would incorrectly describe some profiles as requiring a manual change. ### Known issues * **First IMEI events** are still being created correctly, but are not displaying correctly in Event monitoring or Alerts and should be fixed in the next release. Alerts created for first IMEI events may not trigger correctly. ### What's new * The **Hologram socket API** is no longer supported. * Events and alerts with the tags `_JSONSTRING_`, `_SOCKETAPI_` , `_SIMPLESTRING_` should be considered deprecated and will be marked with warnings in a future release. ### What's improved * **Data plans in activation** for contracted organizations are categorized as standard vs custom plans in activation to match the Data Plans page * **Plan SIM counts** in Activation have been reverted to the pre-v3.2.0 style. ### What's fixed * Contracted organizations activating SIMs that had coverage on Hologram standard plans but not on custom data plans with negotiated rates would not see any options for navigation. Standard plans now display as expected with warning notes. ### What's fixed * The **Data usage thresholds bulk action** no longer shows a duplicate message about Alerts integration. * The **Invoices page** would display an error in a specific configuration before an invoice was published. ### What's improved * Organizations with custom data plans now see more **explicit messaging for Hologram standard plans** during Activation and in the Data plans screen. These data plans may be more expensive than plans with negotiated rates, and we're trying to make it easier to identify when SIMs may be unintentionally activated onto the wrong plan. ### What's fixed * **Bookmarks** to certain URLs from the previous dashboard version now redirect to the correct pages. * **Changing data plans** would not work in specific cases when a SIM was on an inactivated data plan and only had one new plan it could change to. * **Credit card warnings** for organizations with monthly invoicing have been fixed and no longer prevent SIM activation. * Descriptions in the **update data limit** bulk action have been fixed for prepaid organizations. ### Known issues * Standard plan warnings are not yet available when viewing a single SIM. ### What's fixed * **Network-level billing rates** for a single SIM now display correctly if the SIM has multiple installed profiles. # What's new in Hologram v3.0