# Welcome
Welcome to the FAQ page! Here you'll find answers to common questions about our platform. Explore the key features and learn how to optimize your telecom management easily.
### **We are Expanding Sales Channels for Our Clients**
Our platform enables you to launch new telecom products and expand your market reach. Here, you can:
* Set up and manage your own eSIM Store
* Offer pre-paid telecom products
* Transition pre-paid services into subscription-based products
This flexibility allows you to enter new markets and grow your customer base.
### Streamlined Operations and Finance
We reduce the time needed to manage multiple operators and financial tasks. Our platform automates invoicing and simplifies financial processes, making operations more efficient, especially when handling a large number of customers.
### Unified Platform for Global Telecom Management
The platform connects multiple telecom services worldwide, managed from a single interface.
**Key Features:**
* **Multi-Tenant:**\
Here you can have a personalized dashboard with real-time data on usage, traffic, and SIM card status, helping them manage telecom services effectively.
* **Multi-White-Label:**\
Customize the platform with your brand, applying logos, colors, and other elements for a cohesive user experience.
* **Data Security:**\
Our platform ensures data protection and compliance with global standards, providing analytics to optimize telecom strategies while keeping your data secure.
### Jump right in
I have a client who is interested in using your platform
We have multiple referral programs. Please contact us at [**info@droam.com**](#user-content-fn-1)[^1]
[^1]:
# Mandatory settings
# 1. Integrate your Telecoms
### **Complete the following steps:**
1. Go to Settings.
2. Select "Operators."
3. The "Operator" page will open —> click the plus (+) button on the right.
4. A page will open where you can choose the operator from the drop-down list.
5. Once you've selected the operator, depending on the integration type, you'll need to fill in the details.
6. Note that you, as an Organization, have the option to use the **Nickname** field for operators.
{% hint style="info" %}
**A Nickname** is an optional alternative name that your Companies and End Users will see instead of the main operator name.
* If you fill it in, the system will display this nickname in the interface
* If left empty, the main operator name will be shown.
{% endhint %}
* To change the nickname, click on the field in the edit form.
* Enter the new nickname and save changes.
Here’s how it appears at the Company level:
***
### Couldn't find the right operator after checking the whole list?
* **Option 1** – **You don't have integration with the Operator**
This means you can add and manage SIMs, but you won’t be able to access real-time data usage information.
**Option 2** – **There is an integration with the operator you would like to add.**
For the integration, the following credentials are required:
* API Documentation
* License key
* API prefix or login, and password
* etc
{% hint style="warning" %}
Credentials can vary based on the integration. For some, a CERT file might be needed, or other information could be required.
{% endhint %}
{% hint style="warning" %}
If an operator is not on the list, please provide us with the API documentation and credentials for integration.
Timeline: That can take us up to 2 weeks to integrate
{% endhint %}
# 2. Create Company
### **Complete the following steps:**
1. Go to the “Companies” button on your left side of the Side navigation menu
2. On your right, press the “plus” button to create a company
3. A wizard will appear, and you will need to fill in all the required information
4. If you wish to invite someone to administer the company, please provide an email address.
# 3. Upload your SIM(s)
### **Complete the following steps:**
1. From the side menu on the left, select '**SIMs**'
2. Then, press the “plus” button on your right
3. A wizard will appear. Choose the **Operator** from the list (obligatory) and the **Company** these SIM(s) belong to (Optional)
4. You can add SIMs (ICCID) **manually** through a comma or by **uploading an XLSX file** (choose the preferred option)
{% hint style="warning" %}
**IMPORTANT!**
Before adding/uploading SIMs, please check with your operator if they are active. Sometimes you need to activate SIM(s) with the operator first.
{% endhint %}
{% hint style="info" %}
“[Activation ready](/menu/publish-your-docs#sim-statuses)” status means that the SIM is active but has never generated any traffic.
{% endhint %}
{% hint style="info" %}
More detailed information about SIM types you may find here:
{% endhint %}
# 4. Create Plan(s)
### **Complete the following steps:**
1. Go to the “Plans” button on your left side of the navigation menu
2. On your right, press the “plus” button and choose the plan type you want to create
3. When a new wizard appears, fill in all essential fields.
* If you want to make this plan available only to specific company(-ies), please activate the '**Company Designated Plan**' toggle.
4. Fill in all the required information in the Billing section.
{% hint style="warning" %}
**IMPORTANT!**
The price must be at least 1.0 when creating a plan.
{% endhint %}
5. If you want the monthly fees and available balance to be prorated at the start and end of the subscription, simply enable the **'Prorated'** toggle.
{% hint style="info" %}
**General plan** – all current and future companies in this organization will have access to it.
{% endhint %}
{% hint style="info" %}
**Company designated** **plan** will be assigned to the selected companies.
{% endhint %}
{% hint style="info" %}
You can find more information about **plan types** here:
{% endhint %}
# 5. Assign the plan to SIM(s)
“Create your product” means that you need to assign a plan or a pool and a company for the SIM(s) that were uploaded as new SIM(s).
To assign a plan (same as assigning in bulk) to SIM(s)
### **Complete the following steps:**
1. Go to the “**SIMs**” on your left side of the navigation menu
2. Select the necessary SIM(s).
3. Click the **PLUS** button on the left in the toolbar.
4. The Modal window will open. Select the corresponding Plan Type, Plan, and other corresponding fields
* The company is already indicated in the **Company** field.
* ICCIDs are automatically uploaded to the **SIMs** field.
* Click the **Confirm** button.
By completing these steps, you have successfully created a "Product" by associating your SIM(s) with a specific company and plan.
# Optional settings
# 1. Account Settings
For invoices and VAT collection, all this information is required to calculate the correct VAT and ensure everything is reflected in the invoicing file
### **Complete the following steps:**
1. Go to Settings
2. Choose “Business”
3. Click on the **Account Details tab** – Fill in all the required fields
4. Click on the **Contact Person tab** – Provide the relevant contact information.
5. Click on the **VAT Configuration tab** – If you would like VAT to be applied to the account, please activate the toggle.
* Enter the VAT number and percentage, then click Save
# 2. User Profile
For the security of the account
### **Complete the following steps:**
1. Go to select the user profile icon.
2. Fill in your personal info, multi-factor authentication, and time zone.
***
### If **you want to change your password:**
1. Click on the password field.
2. A wizard will appear where you can update your password.
3. Follow the instructions.
# 3. PSP Integration
PSP - (Payment Service Provider) - This integration handles payment processing for the following actions: 1) Refilling your account; 2) Purchasing an eSIM from the eStore; 3) Refilling your wallet.
**Complete the following steps:**
1. Go to Settings
2. Choose “Billing”
3. In the newly opened window, choose the PSPs you will use to collect money
### **1) Stripe**
1. Click the **+ button** next to the **PSPs** section and **choose Stripe** from the list of integrations.
2. To set up the integration with Stripe, you will need to enter your **Key** and **Secret**.
3. Follow up on the instructions in the Platform
* Open your Stripe Dashboard and navigate to the "Developers" page. Find "Webhooks" in the tabs list and select it. Click the designed button to add an endpoint URL. Next, follow your unique, personalized link **available on the platform.**
* For the next step, add the events to listen to by selecting the following list of 9 events:
* charge.refunded
* charge.succeeded
* charge.updated
* setup\_intent.succeeded
* source.canceled
* source.chargeable
* payment\_intent.succeeded
* payment\_method.attached
* payment\_method.detached
* Save these settings by clicking the "Add endpoint" button to complete the Stripe webhook setup.
### **2) PayPal**
To integrate with PayPal, you will need to provide the following details:
* Endpoint
* Username
* Password
* Checkout
* Signature
### **3) Cardknox**** (pending)**
To integrate with Cardknox, you will need to provide the **X-key**
### **4) Mollie**
To integrate with Cardknox, you will need to provide the **API Key**
{% hint style="warning" %}
If you plan to use only the Subscription type, PSP is not needed
{% endhint %}
# 4. Invoice Integration
To create Invoices in your Invoicing Software Platform
### **Complete the following steps:**
### **1) Xero**
1. You need to create a Xero account. [https://www.xero.com/ ](https://www.xero.com/)
2. The next step will be to directly create a billing integration on the\
platform (you must have permissions):
3. Select “Xero” from the selection menu:
Enter the previously generated Client ID and Client Secret key, and confirm the action by clicking "Confirm".
With valid credentials and a redirect URI, you will be redirected to the Xero authorization page. There, you will need to confirm access to your organization.
4\. You will be redirected to the Xero authorization page. There, you will need to confirm access to your organization:
5. After confirmation and successful access, you will be returned to the\
billing integration page, where the created billing integration will be\
displayed:
{% hint style="warning" %}
**IMPORTANT!**\
Your billing integration will be valid for 60 days from the moment of\
creation. If you do not perform any actions related to\
this integration during this period, you will have to reconfirm access to the application!
{% endhint %}
**Xero App Creating Guide**
1. This can be done by following the link:\
[https://developer.xero.com/app/manage/ ](https://developer.xero.com/app/manage/)
and selecting “My Apps”, click on the “New app” button:
2. You should see the following window:
3. To correctly create the application, you must enter the following data:
* Integration type: Web app
* App name: \
* Company or application URL:
* Redirect URL:
4. Click on the “Create app” button. After that, you will be redirected to the next page
4. Here you can get your Client ID and Client Secret key, which are necessary to add integration on the platform. To do this, go to the "Configuration" tab
6. Generate your Client Secret key by clicking on the box “Generate a secret” (you can generate a new Client Secret key by performing the same action).
{% hint style="warning" %}
**IMPORTANT!**\
KEEP YOUR CLIENT ID AND CLIENT SECRET!\
This completes the creation of the application.
{% endhint %}
{% hint style="info" %}
You should add this if you want to create documents via WeFact or Xero. However, it's not mandatory, as you can create invoice drafts directly in our platform without using additional integrations.
{% endhint %}
{% hint style="info" %}
As our client, you can submit requests to integrate the platform with new payment systems if the one you need is not listed above.
{% endhint %}
{% hint style="info" %}
If your invoicing software is not integrated, please use the Export feature to transfer all invoices to your invoicing software.
{% endhint %}
# 5. Create Pools
{% hint style="warning" %}
To create pools, you first need to create a plan with the 'Subscription Static Pool' type
{% endhint %}
### **Complete the following steps:**
1. Navigate to the "Pools" section by clicking the corresponding button in the left-hand side navigation menu.
2. On the left side, click the "plus" (+) button, then select the type of pool you wish to create from the options provided.
3. Complete all fields and choose the pool type: [Static or Dynamic](https://faq.droam.com/menu/pools)
* **If you selected the Static pool type**, fill in the following information in the **Billing** section:
* Balance
* Price
* Overage Size
* Overage Price
Review the information in the column on the right, then click **Confirm**.
* **If you selected the Dynamic pool type**, fill in the following information in the **Billing** section:
* **Overage Size**
* **Overage Price**
Review the information in the column on the right, then click **Confirm**.
{% hint style="warning" %}
One pool may be assigned to one company only
{% endhint %}
# 6. Invite Staff
{% hint style="warning" %}
You may invite staff in case not only the account owner will work with SIMs
{% endhint %}
### **Complete the following steps:**
1. Go to **Settings**.
2. Click on **Team and Security**
3. Click the **'+'** button on the right-hand side.
4. In the **'Invite Staff'** wizard, enter the email address of the person you want to invite.
5. The invited staff member will receive an email with instructions on how to create their account.
{% hint style="info" %}
This action can be performed at any point while using the platform.
{% endhint %}
***
## Permissions
The **Staff** page allows the Organization to register team members and manage their access rights on the platform. This functionality ensures that each staff member has the appropriate permissions to perform their tasks while maintaining security and control over sensitive information.
### **Complete the following steps:**
1. Go to **Settings**.
2. Click on **Team and Security**
3. Click on the Staff member you want to edit access for
4. Go to the Permissions tab and check or uncheck the appropriate box next to the relevant field.
# 7. Customize Columns
{% hint style="info" %}
This action can be performed at any point while using the platform.
{% endhint %}
### **Complete the following steps:**
1. Go to the '**SIMs**' button in the left sidebar of the navigation menu
2. Click the **'+'** button in the table header, and a wizard with a list of all column names will appear.
3. Select the columns you want to display in the table. In the same wizard window, you can also choose the order of the columns (press and hold the dots, then drag up or down). Click **Apply** to save your changes.
# 8. Notifications
Our platform provides a few types of notifications, allowing you to stay informed about key updates and service changes. Here's how they work for different service types and how you can customize them to fit your needs.
Type
Levels
Description
Notifications
Organizations
Companies End Users
Automatic alerts are sent to end users or companies. They can be categorized as mandatory and optional
Webhook Notifications
Organizations
Companies End Users
Automatically send real-time updates to your system through webhooks. This allows seamless integration with your internal processes.
### 1. **Prepaid Services Notifications**
For Prepaid services, end users will receive reminders when their balance is about to expire:
* **10 days remaining**: "You have 10 days left, and your balance will expire."
* **5 days remaining**: "You have 5 days left, and your balance will expire."
These notifications help end users avoid service interruptions by giving them enough time to top up their accounts.
### 2. **Subscription and PAYGO Services**
For subscription and PAYGO (pay-as-you-go) services, you can choose where notifications are sent:
* Set a **default email** where notifications will always be delivered.
* Send notifications to specific emails within the company.
* Use the **end user’s email** if needed.
This ensures that both internal teams and customers are informed at the right time.
# 9. Communication
On this page, you, as an organization, can set up direct links to make it easier for your customers to connect with you.
Here’s what you can do:
### 1. **Contact Us**
* Add a link to your external contact page.
* Once you set it up, your customers will see a new menu item that takes them directly to this link.
* You can easily replace or remove the link whenever needed.
### 2. **Report an Issue**
* Provide a link where your customers can report any issues.
* This could be a Google Form, a page on your website that sends requests to your email, or any other platform you prefer.
* After you set it up, your customers will see a new menu item directing them to this link.
* You’re free to change or delete the link at any time.
### 3. **Order New SIM**
* Add a link where customers can request a new SIM card.
* Once added, your customers will see a menu item that points them to this link.
* You can update or remove this link whenever you want.
***
### 4. Google Tag Manager (GTM)
**Step 1: Sign up for Google Tag Manager**
* Go to [https://tagmanager.google.com](https://tagmanager.google.com/).
* Sign in with your Google account or create a new account.
**Step 2: Create a Container**
**Step 3: Add a Script to the Container**
* In the container dashboard, click **Add a new tag**.
* Choose the tag type you want to use (e.g., Reamaze).
* Save the tag
**Step 4: Get the Container ID**
* On the container dashboard, copy the **GTM-XXXXXX** ID.
**Step 5: Add the Container ID to the Platform**
* Go to your account settings on the platform.
* Navigate to **Communication** → **GTM** tab.
* Paste the GTM container ID.
* Save the settings.
# Roles on the platform
### 1. Organization
An Organization is the level at which contracts with operators are signed and SIM cards are issued. At this level, you can include one or multiple Companies, and it is responsible for managing all the Companies within its structure.
On this level, an Organization can:
* Add SIM cards
* Holds contracts with operators
* Adds its payment systems (Stripe, PayPal)
* Integrate SIM cards with operators or simply store information about them
* Create appropriate plans, although SIM cards do not necessarily have to be integrated with operators
An Organization can also add SIM cards without integrations. This means Organizations can use our platform as a place to store all their SIM cards.
**Example:**
if an Organization has 1,000 SIM cards, but the operator does not have integration with our platform or the integration has not been implemented yet, the Organization can still:
* View all their SIM cards
* Assign them to their clients
* Track which clients are using these SIM cards and which Company they belong to
***
### 2. Company
* Belongs to an Organization
* Created for business clients or virtual Companies
* Can be used to sell SIM cards to end consumers
* End Users are associated with the Company
* Can switch to the level: End User
A Company **always belongs to an Organization**. We cannot create a Company without an Organization. This means that a Company is a business client that belongs to an Organization.
Each Company can have its own settings, plans, and users. Even if the Organization does not have business clients (companies) and wants to sell SIM cards directly to end consumers, it still needs to create a virtual Company that will not be visible to customers but will represent, for example, a point of sale.
**Example:**
* An Organization has a prepaid product and wants to sell it through Amazon. To do this, the Organization needs to create a Company and name it, for instance, “Amazon Band.” Thus:
* The SIM cards sold on Amazon will be linked to this Company.
* End consumers who purchase these SIM cards will register on our platform and automatically be associated with the created Company “Amazon Band.”
***
### 3. End User
* Has login credentials (username, password, can set up 2FA)
* Is associated with a Company, which in turn is associated with an Organization
* End Users cannot configure or use rules. SIM card management rules can only be configured at the Organization or Company level
End Users are linked to a Company, and the Company is linked to an Organization.
This structure is immutable. We cannot link an end user directly to an Organization. The End User is only linked to a Company, which in turn is linked to an Organization.
{% hint style="warning" %}
**Important**
The platform has a clear hierarchy: there is an admin, which branches into Organizations, each Organization can see its Companies, and each Company can have End Users. This structure does not change!
**Example:**
An End User cannot be linked directly to an Organization. The end user is linked to a Company, and the Company is linked to an Organization.
* Organizations can see their companies
* Companies can have end users
{% endhint %}
# SIMs
The **SIMs** page provides convenient access to essential information about each SIM card, including their statuses, SIM types, operators, associated companies, and end users.
This enables to easily tracking of data usage, remaining days on active plans, and viewing detailed information for each card, such as ICCID, operator, plan, company, and other relevant details.
# SIM Types
## SIM Types:
### **1.**[ **Prepaid**](/menu/plans/prepaid)
* A SIM card with a certain balance. When the balance runs out, you can refill it yourself or through auto-refills, and the SIM card will continue to work.
### **2.** [**Subscription**](/menu/plans/subscription)
* A subscription is a product type where the SIM card is used for a month, and at the end of the month, an invoice is issued for all expenses according to the plan (usage). Payment for the usage is deducted at the end of the month.
**Types of Subscription:**
* [**Static Pool**](https://faq.droam.com/menu/publish-your-docs/pages/JZRWnnRzP0JkYZSyOTU7#id-4.-static-pool)
* [**Dynamic Pool**](https://faq.droam.com/menu/publish-your-docs/pages/JZRWnnRzP0JkYZSyOTU7#id-5.-dynamic-pool)
* [**Unlimited**](https://faq.droam.com/menu/publish-your-docs/pages/JZRWnnRzP0JkYZSyOTU7#id-3.-unlimited)
* [**Monthly Bundle**](https://faq.droam.com/menu/publish-your-docs/pages/JZRWnnRzP0JkYZSyOTU7#id-1.-monthly-bundle)
* [**Pay per Megabyte**](/menu/plans/subscription#pay-per-megabyte)
### **3.** [**PAYGO**](/menu/plans/paygo)
* PAYGO (pay-as-you-go in real time) is a flexible data billing product that charges users per megabyte of data used, offering advanced features and seamless integration. Unlike standard pay-per-megabyte models, PAYGO allows operators to set prices not only based on total data consumption but also for specific countries.
# SIM Statuses
### SIM Statuses:
1. **Not available** – No integration.
2. **Pending** – Being checked by the integrator because it was just added to the platform, or operations are being performed on it.
3. **Invalid** – Something went wrong with the integration.
4. **Active** – Operating in normal mode - stored for record-keeping or historical reference.
5. **Suspended** – Manually or systemically suspended (e.g., expired).
6. **Blank** - The physical SIM without MSISDN. Needs to be swapped before use.
7. **Archived** – The SIM card is no longer in use.
# General Terms
### General terms in the SIMs section:
* **ICCID -** The unique identifier for each SIM card. For eSIMs, the number is displayed along with a QR code, making it easy to distinguish between physical SIMs and eSIMs.
* **In session:**
* Yes - the SIM is currently online and in use.
* No - the SIM is currently offline and not in use.
* N/A - the status of the SIM is undetermined because the integration does not support it.
* **Operator -** The mobile network provider associated with the SIM, such as Telefonica, Vodafone UK, HOT Mobile, Odido, Orange France, Partner, Plus, WWS.
* **Plan -** Shows the name of the current plan, which is automatically generated but can be customized if needed
* **Company -** Company name to which the SIM card is assigned.
* **End User -** The email address of the end user linked to the SIM.
* **Data left (MB) -** Remaining data allowance for the SIM.
* **Days left -** The remaining days before the plan or SIM expires.
* **This month (MB) -** Data usage for the current month.
* **Note -** A field for any additional notes or comments.
* **Rules -** Customizable rules applied to the SIM
* **Labels -** Customizable labels for organizing SIMs.
* **SIM type -** Indicates whether the SIM is Prepaid, Subscription, or PAYGO.
# Key Features
###
# Dynamic Table
You can adjust the order of displayed data, add new columns from the existing list, or hide columns that are not needed. This flexibility allows you to customize the interface to meet your specific needs.
[**Step-by-Step Instruction**](/onboarding-guide/optional-settings/7.-customize-columns)
2. **By clicking the "+" button, you can** Upload new SIM card(s) into the system
# Bulk Operations
You can perform bulk actions such as:
* **Copy:** Copy selected ICCID(s) for easy access or later use.
***
* **Manage Traffic:**
Here you can easily change the status to:
* **Active:** Quickly activate multiple SIMs at once.
* **Suspend:** Suspend a group of SIMs, temporarily halting their services.
* **Send SMS:** Send text messages to multiple SIMs simultaneously for notifications, alerts, or updates.
* **Sync with Operator:** Synchronizes the selected SIMs with the operator to ensure the latest network data and settings are reflected.
***
* **Manage Company:** Assign multiple SIMs to a company for better organization.
* **Manage Labels:** Add or modify labels to categorize and organize multiple SIMs at once.
* **Manage Rules:** Apply or modify automation rules for the selected SIMs, such as data limits or notifications.
* **Manage Notes:** Modify or update notes for multiple SIMs to include new information or instructions.
***
* **Activate Plan:** Assign the plan for several SIMs simultaneously to streamline plan management.
* **Change Plan:** Apply a new plan to multiple SIMs simultaneously.
{% hint style="warning" %}
The remaining balance will be erased and unavailable for use.
{% endhint %}
* **Cancel Plan:** Terminate the selected plan on the chosen execution date, define operator status, and specify which associated data and labels should be retained after cancellation.
***
* **Import:** Import SIM information from a file to update or add records for further management or analysis.
* **Export:** Export the information of selected SIMs to a file for further analysis or reporting.
# SIM Swap
A **SIM Swap** is the action of reassigning a phone number (MSISDN) from its current SIM card (ICCID) to a different SIM.
To initiate the SIM swap process, the user must select the setup SIM card and locate the ‘**Swap SIM**’ option in the actions menu.
To make a SIM swap process user needs to select the setup SIM card and find the ‘Swap SIM' action in the actions menu.
{% hint style="warning" %}
Users can only perform this action on operators that offer this feature.
{% endhint %}
### Two **SIM cards are required for the swap process:**
* **FROM**: The setup SIM (with MSISDN)
* **TO**: A blank SIM (without MSISDN)
Once the SIM swap process is successfully completed, users can select the appropriate status for the new SIM.
{% hint style="warning" %}
During the confirmation phase, both SIMs will remain in *PENDING* status until the transfer is finalized.
{% endhint %}
Users can check the SIM cards that are in the swap process. After one hour of starting the process, users may retry the swap up to **5 times**, with a minimum interval of **20 minutes** between each attempt.
### When **the process is complete:**
**✅ Successful Swap:**
* The original **(FROM)** SIM card is moved to *ARCHIVE*.
* The NEW **(TO)** SIM card is set to the status selected by the user.
**❌ Failed Swap:**
* Both SIMs return to their previous states, based on the operator’s system.
# Q\&A
Why can't I see any usage?
There could be a couple of reasons for this.
1. The product has not been created (attach the SIM to a plan and a company)
2. Your SIM hasn't generated any usage so far.
What does the Activation Ready status mean?
This status means that the SIM is active with the operator, but there has been no usage yet. Once the SIM card is used, the status will change to "Active."
How do I refill?
You have two options for refilling your balance:
1. **Manual Refill**\
You can refill your balance manually through your account page on the Platform. Simply log in to your account and follow the prompts to add funds.
2. **Auto-Refill**\
Alternatively, you can set up an auto-refill option. This allows for automatic balance top-ups when your data falls below a specified threshold. To use this feature, you will need to provide a credit card on your account page.
Regardless of the method you choose, your data will be added immediately in real-time upon successful completion of the refill.
# Satellite
# Terminal Statuses
### Terminal Statuses:
1. **Pending** – Being checked by the integrator because it was just added to the platform, or operations are being performed on it.
2. **Invalid** – Something went wrong with the integration.
3. **Available -** Terminal is functional and available for next steps (e.g., linking to Company, Plan).
4. **Active** – Operating in normal mode - stored for record-keeping or historical reference.
5. **Suspended** – Manually or systemically suspended (e.g., expired).
6. **Archived** – The terminal is no longer in use.
# Upload Terminals
As an organization, you can upload SIMs to the platform by following these steps:
1. Go to the **Satellite** from the menu on the left.
2. Click the **plus (+)** button.
3. A modal window will open. Select the **Operator** Starlink and the **Company** (optional).
4. Click on **"File"** to upload your `.xlsx` file, then click **"Create."**
* A **template file** is also available for download to check which fields are needed for each Terminal.
The XLSX file can contain 10,000 Terminals or more. However, we recommend starting with a test upload of around 100 Terminals to ensure everything works as expected before uploading the full list.
# Key Features
# Dynamic Table
You can adjust the order of displayed data, add new columns from the existing list, or hide columns that are not needed. This flexibility allows you to customize the interface to meet your specific needs.
1. Go to the '**Satellite**' in the left sidebar of the navigation menu
2. Click the **'+'** button in the table header, and a wizard with a list of all column names will appear.
3. Select the columns you want to display in the table. In the same wizard window, you can also choose the order of the columns (press and hold the dots, then drag up or down). Click **Apply** to save your changes.
# Bulk Operations
You can perform bulk actions such as:
* **Copy:** Copy the IDs of the selected Terminals for easy access or later use
***
* **Sync with Operator:** Synchronizes the selected terminals with the operator to ensure the latest network data, configurations, and status are up to date.
***
* **Manage Company:** Assign multiple Terminals to a company for better organization.
* **Manage Labels:** Add or modify labels to categorize and organize multiple terminals at once.
* **Manage Rules:** Apply or modify automation rules for the selected terminals, such as usage limits, alerts, or notifications.
* **Change Notes:** Modify or update notes for multiple Terminals to include new information or instructions.
***
* **Activate Plan:** Assign a plan to multiple terminals simultaneously to streamline plan management and ensure consistent configuration.
* **Cancel Plan:** Deactivate selected Terminals and remove them from active use. This action unlinks the Terminal from its service line
***
* **Export:** Export the information of selected SIM cards to a file for further analysis or reporting.
# Terminal Swap
# Telemetry
The Telemetry page provides an interactive view to monitor and manage terminals, with a list, filters, and a map showing device locations and status.
### General View
1. **Search Bar**
* Located at the top-left of the page.
* Allows users to quickly search for a specific terminal or SIM by ID or name.
***
2. **Filter Panel**
* Provides advanced filtering options to narrow down the displayed terminals.
* Available filters include:
* **Alert:** Filter devices by current alerts or notifications.
* **Connection:** Filter based on network connection status.
* **Company:** Filter devices associated with a specific company.
* **Throttle:** Filter by data usage limits or throttling status.
* Buttons:
* **Clear All:** Reset all applied filters.
* **Submit:** Apply the selected filters.
***
3. **Terminal List**
* Displayed on the left side of the page.
* Shows all terminals matching the current search or filter criteria.
* Each Terminal entry includes:
* **Terminal ID:** Unique identifier for each terminal or SIM.
* **Status Indicator:** Online (green dot) or offline (gray dot).
* **Alert Count Badge:** Numeric badge indicating the number of active alerts for the device.
***
4. **Map View**
* Located on the right side of the page.
* Provides a geographic overview of all devices.
* Key features:
* **Device Status Markers:** Green for online, gray for offline.
* **Hexagonal Clusters:** Indicate regions with multiple devices for simplified visualization.
* Interactive map with zoom and pan capabilities to focus on specific regions.
***
5. **Sync Button**
* Allows users to refresh the displayed data to ensure up-to-date terminal statuses and locations.
***
### Telemetry Details
The page is divided into several sections: **Alerts**, **General**, a location map, and a set of telemetry charts.
1. Go to the Satellite page
2. Click on the terminal to view its telemetry details
3. Open the Telemetry tab
***
1. **Alerts Section**
* Shows active warnings or system issues related to the terminal.
* If no alerts are present, the interface displays: *“You don’t have any alerts.”*
***
**3. General Section**
Provides essential information about the terminal’s connectivity:
* **Connection:** Online / Offline
* **Last updated:** Timestamp of the latest telemetry received
* **Location:** A map showing the approximate position of the terminal
***
**4. Time Range Selector**
Above the charts, users can choose the time interval for displayed telemetry:
* **15 minutes**
* **3 hours**
* **1 day**
* **7 days**
* **30 days**
{% hint style="info" %}
Changing the interval updates all charts simultaneously.
{% endhint %}
5. **Data Export**
A **Download** button located above the charts allows users to export telemetry data for offline analysis or reporting.
***
#### **Telemetry Charts**
**1. Downlink (Kbps)**
Displays the terminal’s data-receive average download speed from the satellite:
* **Min** — Minimum value during the selected period
* **Max** — Maximum value
* **Last** — Most recent value
* The chart visualizes the fluctuation of downlink speeds over time.
**2. Uplink (Kbps)**
Shows the data transmission average download speed to the satellite:
* Contains the same metrics as Downlink
* The chart reflects uplink performance trends
**3. Latency (ms)**
Average latency measured to the Starlink point of presence:
* **Min**, **Max**, **Last**
* The chart shows variation in latency over time.
**4. Ping Drop Rate (%)**
Indicates the percentage of pings that are dropped:
* A healthy connection typically shows 0%
* The chart displays packet-loss occurrences within the selected timeframe
**5. Signal Quality (%)**
Represents the quality of the received signal:
* Ranges from 0–100%
* Visualizes overall link stability
**6. Obstruction (%)**
Shows the percentage of time the terminal’s view of the satellite was obstructed:
* Very low values (e.g., 0.005%) indicate minimal interference
* Useful for diagnosing signal blockages from trees, buildings, etc.
***
# Pools
On the **Pools** page, you can manage data pools. You can also add preset configurations to ensure consistent data pool management.
### Static Pool
* **Purpose:** This pool has a fixed price, along with a fixed allowed balance and overage rate, regardless of the number of terminals or SIMs included. The total data usage of all Terminals/SIMs within the pool is aggregated.
* **Validity Period:** 1 calendar month
* **Payment Terms:** Monthly Fee
* **Payment Type:** Pre-Billing, Advanced Billing, Post-Billing, or Manual Invoice Creation. The system does not validate or enforce payment status (paid/unpaid)
* **Overage:** Yes - you can define a fixed rate that applies when usage exceeds the included balance.
* **Activation Fee:** Yes. It is applied when a terminal or SIM is added, and included in the invoice at the start of the next billing period. Payment status is not tracked by the platform.
* **Prorate:** disabled
* **MRC:** No
***
### Dynamic Pool
* **Purpose:** Every new Terminal/SIM added to the dynamic pool adds to the total amount of data and increases the pool price.
* **Validity Period:** 1 calendar month
* **Payment Terms:** Monthly Fee
* **Payment Type:** Pre-Billing, Advanced Billing, Post-Billing, or Manual Invoice Creation. The platform does not validate or enforce payment status (paid/unpaid)
* **Overage:** Yes - you can define a fixed rate that applies when usage exceeds the included balance.
* **Activation Fee:** Yes. It is applied when a terminal or SIM is added, and included in the invoice at the start of the next billing period. Payment status is not tracked by the platform.
* **Prorate:** enabled (optional)
* **MRC:** No
# Plans
On the **Plans** page, you can create and customize data bundles, assign SIM cards to Plans, and monitor Plan details. The table presents essential information about each Plan, including its name, type, associated operator, company, details, labels, and whether the Plan is prorated. You can also add preset configurations for quick and consistent Plan setup.
## Q\&A
Why can't I select a company when creating a PAYGO plan?
The company list includes only companies that have Wallet enabled. PAYGO plans work exclusively with the Wallet feature, so if you don't have any companies with Wallet enabled, the company list will be empty when creating a PAYGO plan.
# Prepaid
### Prepaid
* **Purpose**: A fixed balance valid for a defined period and monitored in real-time. Once the balance is used, the Terminal can be refilled manually or automatically.
* **Validity Period:** The validity period is set by the specific prepaid product (for example, 365 days), based on the validity days of the chosen plan.
* **Payment Terms:** One-time payment / Refill
* **Payment Type:** Transactions via Stripe or Invoice
* **Overage:** No – usage stops when the balance or remaining days reach zero.
* **Activation Fee:** No
* **Re-fill:** Yes, different balance with different price
* **Auto refill of Terminal/SIM:** Yes. Available for Companies
* **Manual Refill of Terminal/SIM:** Yes. Available for Organizations
* **Refill/Autorefill with wallet:** Yes
(Each refill extends the validity period of the prepaid product within the plan's validity days.)
* **Prorate:** No
* **MRC:** No
* **Billing start date:** The billing cycle starts when the first usage occurs, and days are counted from that point.
### **Additional Info**
* **Usage Terms**:
Prepaid SIM cards have specific terms based on the operator’s contract. For example, if a SIM card remains inactive (no refills) for three years, it may be deactivated. These details vary and are specified in the operator's contract.
* **Auto-Refill**:
This feature automatically tops up the balance when it falls below a certain threshold (e.g., below 100 MB). The system charges either the company's card or the end user's card to the organization's account, and upon successful payment, the balance is updated instantly.
* **Wallet Balance**:
This option allows the client to store a larger sum in advance for auto-refills. For instance, instead of topping up multiple SIM cards frequently with small amounts, the client can deposit $1,000 to cover auto-refills as needed.
* **Product Expiry**:
Each Prepaid product comes with a usage term. For example, 1 GB of data may be valid for 365 days. If the balance is not refilled within that period, any remaining balance will expire. However, with every refill, the validity period extends from the refill date, ensuring the product can be used for a longer time as long as the balance is regularly topped up.
***
### **How to Create a Prepaid Plan**
### **Complete the following steps:**
1. Go to the “Plans” button on your left side of the navigation menu
2. On your right, press the “plus” button and choose the plan type you want to create
3. When a new wizard appears, fill in all essential fields.
* If you want to make this plan available only to specific company(-ies), please activate the '**Company Designated Plan**' toggle.
4. Fill in all the required information in the Billing section.
{% hint style="warning" %}
**IMPORTANT!**
The price must be at least 1.0 when creating a plan.
{% endhint %}
# Subscription
A subscription is a Plan type where the SIM card is used for a month, and at the end of the month, an invoice is issued for all expenses according to the Plan (usage). Payment for the usage is deducted at the end of the month.
The subscription is designed for companies rather than end consumers. The end consumer may be linked to the SIM card and see the usage, but cannot manage the SIM card. Management and payment are handled by the company responsible for the SIM card.
### **Types of Subscription Plan:**
## 1. Monthly Bundle
* **Purpose:** A single Termina / SIMl controls this bundle. It includes a fixed amount of data per month. fixed price
* **Validity Period:** 1 calendar month
* **Payment Terms:** Monthly Fee
* **Payment Type:** Pre-Billing, Advanced Billing, Post-Billing, or Manual Invoice Creation. The platform does not validate or enforce payment status (paid/unpaid)
* **Overage:** Yes - you can define a fixed rate that applies when usage exceeds the included balance.
* **Activation Fee:** Yes. It is applied when a terminal or SIM is added, and included in the invoice at the start of the next billing period. The platform does not track payment status.
* **Prorate:** enabled (optional)
* **MRC:** Yes
* **Billing start date:** is either the date when the SIM/Terminal is assigned or the date of the first usage, whichever occurs first.
***
## 2. Pay per Megabyte
* **Purpose:** The user pays based on actual usage — the more you use, the more you pay.
* **Validity Period:** 1 calendar month – ongoing until manually stopped
* **Payment Terms:** Usage-based billing
* **Payment Type:** Pre-Billing, Advanced Billing, Post-Billing, or Manual Invoice Creation. The platform does not validate or enforce payment status (paid/unpaid)
* **Overage:** No
* **Activation Fee:** Yes. It is applied when a terminal or SIM is added, and included in the invoice at the start of the next billing period. The platform does not track payment status.
* **Prorate:** No
* **MRC:** Yes (applied either to all SIMs/Terminals or only to active ones)
***
## 3. Unlimited
* **Purpose:** Unlimited data usage for a fixed monthly cost.
* **Validity Period:** 1 calendar month (renewed monthly)
* **Payment Terms:** Monthly Fee
* **Payment Type:** Pre-Billing, Advanced Billing, Post-Billing, or Manual Invoice Creation. The platform does not validate or enforce payment status (paid/unpaid)
* **Overage:** No — unlimited usage
* **Activation Fee:** Yes. It is applied when a terminal or SIM is added, and included in the invoice at the start of the next billing period. The platform does not track payment status.
* **Recurring fee:** Yes
* **Prorate:** enabled (optional)
* **MRC:** Yes
* **Billing start date:** is either the date when the SIM/Terminal is assigned or the date of the first usage, whichever occurs first.
***
## 4. Static Pool
* **Purpose:** This pool has a fixed price, along with a fixed allowed balance and overage rate, regardless of the number of terminals or SIMs included. The total data usage of all Terminals/SIMs within the pool is aggregated.
* **Validity Period:** 1 calendar month
* **Payment Terms:** Monthly Fee
* **Payment Type:** Pre-Billing, Advanced Billing, Post-Billing, or Manual Invoice Creation. The system does not validate or enforce payment status (paid/unpaid)
* **Overage:** Yes - you can define a fixed rate that applies when usage exceeds the included balance.
* **Activation Fee:** Yes. It is applied when a terminal or SIM is added, and included in the invoice at the start of the next billing period. The platform does not track payment status.
* **Prorate:** No
* **MRC:** No
***
## 5. Dynamic Pool
* **Purpose:** Every new Terminal/SIM added to the dynamic pool adds to the total amount of data and increases the pool price.
* **Validity Period:** 1 calendar month
* **Payment Terms:** Monthly Fee
* **Payment Type:** Pre-Billing, Advanced Billing, Post-Billing, or Manual Invoice Creation. The platform does not validate or enforce payment status (paid/unpaid)
* **Overage:** Yes - you can define a fixed rate that applies when usage exceeds the included balance.
* **Activation Fee:** Yes. It is applied when a terminal or SIM is added, and included in the invoice at the start of the next billing period. The platform does not track payment status.
* **Prorate:** enabled (optional)
* **MRC:** Yes
# PAYGO
PAYGO is a real-time product that charges users for data on a per-megabyte basis. While it operates similarly to pay-per-megabyte systems, it provides advanced features and supports seamless integrations.
Operators can set prices not only for total data usage but also specifically for different countries.
If the operator supplies country-specific information or imposes restrictions in certain regions, corresponding pricing can be established.
* **Purpose:** A real-time prepaid product that charges users based on data usage (per MB/GB). Requires a positive balance in the Wallet to remain active.
* **Validity Period:** 1 calendar month and continues as long as the balance stays positive.
* **Payment Terms:** Payment within the Wallet
* **Payment Type:** Transactions via Stripe or Invoice
* **Overage:** No — service stops when balance reaches zero
* **Activation Fee** (one time): No
* **Re-fill:** Yes, you can refill with varying balances, each associated with a different price.
* **Auto refill with wallet:** Yes. For Company
* **Manual Refill with wallet:** Yes. For Organization
* **Prorate:** No
* **MRC:** Yes, applied from either the first usage or the assignment date.
* **Billing start date:** The count starts from the first usage date
# Key Features
Change Plan
# Q\&A
On the **Plans** page, you can create and customize data bundles, assign SIM cards to Plans, and monitor Plan details. The table presents essential information about each Plan, including its name, type, associated operator, company, details, labels, and whether the Plan is prorated. You can also add preset configurations for quick and consistent Plan setup.
Why can't I select a company when creating a PAYGO plan?
The company list includes only companies that have Wallet enabled. PAYGO plans work exclusively with the Wallet feature, so if you don't have any companies with Wallet enabled, the company list will be empty when creating a PAYGO plan.
# Companies
The **Companies** page is designed to meet the administrative needs of managing multiple Companies within the platform.
{% tabs %}
{% tab title="Dictionary" %}
General Terms from **Companies** page:
* **Name -** The name of the Company.
* **End Users -** Number of end users associated with the Company.
* **Prepaid -** Number of prepaid SIM cards.
* **Subscription -** Number of subscription SIM cards.
* **PAYGO -** Number of PAYGO SIM cards.
* **Staff -** Total number of staff members.
* **Pool -** Number of pools associated with the Company.
* **Wallet -**The balance of the Company’s wallet.
* **Labels -** Tags or categories for easy identification.
{% endtab %}
{% tab title="Key Features" %}
1. **Detailed Information (Clicking on a row):** Provides additional details about the selected Company:
* **General:** Overview of prepaid SIMs, subscription SIMs, PAYGO SIMs, end user information, and financial data, including the amount paid this month and lifetime payments.
* **Wallet:** Detailed wallet information, including the starting balance, total refilled amount, total spent, and the ending balance. A table with transaction data is also provided, showing the date, description, and amount of each transaction.
* **Staff:** List of staff members associated with the Company, including first name, last name, email, and type.
* **Company Details:** Information about the Company name, owner, email, notification settings, and currency preferences.
The **Companies** page provides a clear and organized view of each Company’s SIM card usage, financial transactions, and associated staff, helping administrators maintain control and oversight.
{% endtab %}
{% endtabs %}
# End Users
Here you as an Organization can manage information about End Users, including their associated Companies, SIM cards, and financial details. This page is intended to streamline user management by offering detailed insights into End User accounts, SIM usage, and payment settings.
{% tabs %}
{% tab title="Dictionary" %}
General Terms from **End Users** page:
* **Name -** For end users, the name is shown if available; otherwise, the email is displayed when the name is not provided.
* **Company -** The company associated with the end user.
* **Prepaid -** Number of prepaid SIM cards assigned to the end user.
* **Subscription -** Number of subscription SIM cards assigned.
* **PAYGO -** Number of PAYGO SIM cards assigned.
* **Wallet -** Current wallet balance of the end user.
* **Labels -** Tags or categories for easy identification and filtering.
{% endtab %}
{% tab title="Key Features" %}
1. **Detailed Information (Clicking on a row):** Provides further details about the selected End User:
* **General:** Overview of SIM card assignments (prepaid, subscription, PAYGO), wallet information including paid amounts (monthly and lifetime), and general settings such as notification preferences and whether the End User pays for new purchases.
* **Permissions:** Defines the actions the End User can perform, such as adding, deleting, editing, or viewing information. This includes managing payment methods, staff-related actions, and SIM card management (e.g., updating notes, auto-refill options, refilling).
* **Log:** Displays a history of changes with date, modified fields, old and new values, and the user who made the changes. This is useful for auditing and tracking adjustments.
The **End Users** page allows for efficient management of SIM card assignments, tracking of wallet balances, and configuration of End User permissions and settings.
{% endtab %}
{% endtabs %}
# Automation - Rules
The **Automation Rules** page allows you to create and manage rules that automate various processes. This functionality helps streamline operations, improve efficiency, and ensure that specific actions are triggered automatically based on predefined criteria.
Rules are used to automate processes and consist of the following components:
* Rule Type
* Trigger
* Period
* Condition
* Value
* Actions
Each rule type comes with its own set of available triggers. Every trigger, in turn, is linked to a specific set of periods, conditions, and values. The available actions depend on the selected trigger, the account level, and user permissions.
***
### Trigger list
| Trigger | Applies to | Triggered when |
| --------------------- | ------------------------- | ----------------------------------------------------------------------- |
| **Status** | SIM and Satellite | the status changes to the selected value (e.g., Activate/Suspend) |
| **IMEI** | SIM only | the IMEI changes |
| **Date** | SIM and Satellite | the specific date is reached (e.g., activation date, contract end date) |
| **Data left** | Prepaid | the remaining data balance falls to or below the specified threshold |
| **Data used** | Subscription, PAYGO, Pool | total data usage reaches the defined limit |
| **Voice used** | SIM only | voice usage reaches the specified number of minutes |
| **Funds used** | PAYGO only | the user has spent the defined amount of funds |
| **Remaining balance** | Wallet only | the wallet balance drops to the specified amount or lower. |
The rule should be triggered once the condition for the trigger is met. After that, it should perform all actions specified in the rule.
{% hint style="success" %}
The rule should check the trigger immediately after assignment.
{% endhint %}
***
### Action list
* **Change status** – Change the status of the entity to the specified one
* **Suspended** – Only applicable to the IMEI trigger
* **Activate/Suspended**
* **Email notifications:**
* **Default account email** – Send a notification email to the default account email
* **Staff** **email** – Send a notification email to the selected staff email
* **Company email**– Send a notification email to the default company email
* **End user** **email**– Send a notification email to the owner’s email
* **Custom email(s)** – Sends a notification to one or more manually specified email addresses (maximum of 5).
* **Enable throttle** – Sends a request to the Integrator to activate throttling (if supported by the operator).
* **Push API** – Send a webhook to the specified API endpoint.
# Billing
The Billing section provides an overview and management tools for financial operations within the platform. It consists of three key subsections: Transactions, Invoices, and Pre-bills.
# Transactions
The Transactions page provides a detailed view of all transaction records within the system, allowing to track, manage, and filter transaction data.
The page consists of several key areas that facilitate user interaction with the transaction information.
#### Key Areas on the Transactions Page:
#### **1. Transaction List**
* Displays a table of all transactions with the following columns:
* **Date**: The timestamp of the transaction.
* **Type**: Indicates the type of transaction (e.g., SIM refill, eSIM purchase, etc.).
* **Destination**: Identifies the target associated with the transaction (e.g., a specific account or service).
* **Amount**: The value of the transaction.
* **Currency**: The currency of the transaction (e.g., EUR).
* **Payment Method**: The method used for the transaction (e.g., Stripe, Invoice).
* **End User**: The user associated with the transaction.
* **Billing Cycle**: The billing cycle linked to the transaction.
* **Labels**: Any tags associated with the transaction.
#### **2. Filters**
A set of filtering options that allow users to refine their search and view specific transactions based on the following criteria:
**1) Status**
Defines the current state of the transaction or operation. Available options:
* **Pending** – The process has been initiated but is not yet completed.
* **Failed** – The process was attempted but did not succeed.
* **Completed** – The process was successfully finished.
**2) Payment Method**
Specifies the method used for payment. Available options:
* Credit Card (Stripe)
* iDEAL
* Manual
* PayPal
* Wallet
* Company Wallet
**3) Company**
Allows filtering by the associated company.
**4) Currency**
Filters records based on the currency used for the transaction.
**5) Type**
Defines the category of the transaction. Available options:
* **(e)SIM refill**
* **Refill wallet**
* **eSIM Purchase**
**6) Billing Cycle**
Filters records according to the billing cycle associated with the transaction.
**7) Labels**
Supports filtering by assigned labels.
#### **3. Transaction Details**
* When a user clicks on a specific transaction, detailed information about that transaction is shown in a separate panel. This includes:
* **General Information**: Displays key details such as the transaction ID, type, destination, amount, payment method, and associated end-user.
* **Transaction Reason**: If available, an explanation or reason for the transaction can be displayed.
* **Company Information**: Information about the company involved in the transaction (e.g., company name, relevant contacts).
* **Labels**: Displays any tags associated with the transaction, which may help classify or provide further context.
#### 4. Additional Features
* **Export Function**:
* The page includes an export function that allows users to download the transaction data in a suitable format (e.g., CSV or Excel). This is useful for offline analysis or reporting purposes.
* The export function typically considers any applied filters, ensuring that only the relevant transactions are exported.
* **Manage Labels**:
* A "Manage Labels" function is available to allow users to categorize or tag transactions with specific labels. This feature helps in organizing transactions and making them easier to search and report.
* Labels can be added, removed, or modified as necessary.
# Invoices
The Invoices page provides a centralized interface for viewing, filtering, inspecting, and exporting all invoices generated within the system.
It is part of the **Billing** module and is accessible via **Billing → Invoices** in the navigation menu.
The page consists of three main components:
1. **Invoices List**
2. **Filters Panel**
3. **Invoice Details View**
4. **Export Function**
***
### **1. Invoices List**
The main section displays a tabular list of all invoices generated across companies and end users.\
Each row includes the following key fields:
* **Number** – the unique invoice identifier.
* **Created At** – date of invoice creation.
* **Company** – the company to which the invoice belongs.
* **End User** – the specific end-customer (if applicable).
* **Total Amount** – total charge amount.
* **Currency** – currency in which the invoice was issued.
Additional functions:
* **Row selection** for bulk actions.
* **Search bar** for quick filtering by invoice number or related data.
* **Quick action menu** (⋮) for accessing the invoice preview or exporting the document.
***
### **2. Filters Panel**
The **Filters** panel allows users to narrow down the list of invoices based on specific parameters.\
It opens via the **Filter** button located next to the main search bar.
#### **Available Filter**
* **Company**\
Dropdown list containing all available companies.\
Selecting a company limits the results to invoices associated with that entity.
#### **Controls**
* **Submit**\
Applies the selected filters and refreshes the list.
* **Clear All**\
Resets all applied filters, returning the list to its unfiltered state.
The filter panel provides a compact way to focus on specific billing records without leaving the page.
***
### **3. Invoice Details View**
Clicking any invoice number opens the **Invoice Details** panel on the right side of the screen.\
This view contains all invoice-specific information structured in a three-section layout:
#### **3.1 General**
Displays the primary invoice metadata:
* Invoice Number
* Creation Date
* Status
* Linked End User
* Company information (if applicable)
#### **3.2 Billed To**
Contains billing recipient information:
* Company or end user name
* Contact email
* Address (if available)
#### **3.3 From**
Shows the issuing organization’s details:
* Organization name
* Address
* VAT/Tax identifiers (if applicable)
#### **3.4 Item List**
A detailed breakdown of all items included in the invoice:
* **Item** – product or service name
* **Qty** – quantity
* **Unit Price** – price per unit
* **Amount** – line total
A summary line shows the overall **Total** amount.
The Details view helps users quickly audit, verify, or share invoice information.
***
### **4. Export Function**
The system supports exporting invoices directly from the Invoices list or from the Invoice Details view.
#### **Capabilities**
* Export a **single invoice** in CSV format.
* Export **multiple invoices** by selecting the desired rows and choosing the export option.
* Downloaded files adhere to standard invoice formatting, including company data, itemized charges, and totals.
# Pre-bills
The Pre-bills page allows users to view, filter, and analyze preliminary billing records generated by the system based on tariffs, usage, and other billing events.
{% tabs %}
{% tab title="Overview" %}
The main screen consists of several key sections:
#### **1. Statistics Panel**
Located at the top of the page, displaying key aggregated information:
* **Pre-bills (All):** total number of pre-bills.
* **Statuses:** number of pre-bills in each status:\
– *Pending*\
– *Approved*
* **Companies:** list of companies associated with pre-bills.
* **Bill-cycles:** available billing cycles.
#### **2. Search and Filters**
* Global search field for searching by pre-bill number or other parameters.
* Filter icon for advanced filtering options.
#### **3. Pre-bills Table**
Displays a list of pre-bills with columns:
* **Number** — unique pre-bill number.
* **Created at** — creation date.
* **Company** — company associated with the pre-bill.
* **Total amount** — total amount of the pre-bill.
* **Currency code** — currency (USD, EUR, etc.).
Each row can be opened to view detailed information.
{% endtab %}
{% tab title="Details" %}
The **Details** tab provides key attributes of the pre-bill and a breakdown of billing items.
#### **1. General Information**
Contains key document parameters:
* **Status** — current status (*Pending*, *Approved*).
* **Business type** — type of billing operation.
* **Currency** — document currency.
* **Reference** — additional reference or identifier.
* **Created at** — date the pre-bill was created.
#### **2. Item List**
Shows detailed billing items, including:
* **Item** — name or type of billing event (e.g., "Starter PayWhat SIMC").
* **Qty** — quantity of units.
* **Unit price** — price per unit.
* **Amount (local)** — amount in local currency.
At the bottom:
* **Total excl. VAT** — total amount excluding VAT.
This tab is used for manual verification of billing components before approval.
{% endtab %}
{% tab title="Usage" %}
The **Usage** tab shows detailed resource usage that contributed to the pre-bill calculation.
#### **1. General Information**
* **Billing cycle** — billing cycle for which usage was calculated.
* **Created at** — date usage data was generated.
#### **2. Usage Table**
Displays detailed usage records:
* **Destination** — target resource or identifier.
* **Usage (MB / min / units)** — quantity of resources consumed.
* **Plan name** — plan or service bundle applied.
* **Pool name** — pool or group associated with the usage.
* **Calculation date** — date the usage was calculated.
* **Nickname**
* **Labels**
Pagination and page controls are available at the bottom.
This tab enables the analysis of usage details.
#### 3. Export
The Usage tab also provides the ability to **export these details in CSV format** for further analysis or record-keeping.
{% endtab %}
{% endtabs %}
# VAT \[Tax]
### VAT Application Hierarchy: Organization → Company → End User
The system supports VAT configuration at three levels:
1. **Organization level**
2. **Company level**
3. **End user level**
{% hint style="warning" %}
Each participant is charged **their own VAT rate if one exists**.\
If the participant does not have a VAT rate, the system uses the **Organization’s VAT rate** as the fallback.
{% endhint %}
***
### 1. Organization VAT Only
**Input values:**
* Organization VAT: *e.g., 21%*
* Company VAT: none
* End user VAT: none
**Application logic:**
* The company is charged using **21%** (the organization’s VAT rate).
* The end user is also charged using **21%** (the organization’s VAT rate).
**Result:**
* All transactions use the **Organization-level VAT**.
***
### 2. Organization VAT + Company VAT
**Input values:**
* Organization VAT: *e.g., 21%*
* Company VAT: *e.g., 18%*
* End user VAT: none
**Application logic:**
* The company is charged using **18%** (the company’s VAT rate overrides the organization’s rate).
* The end user is charged using **21%** (falls back to the organization’s VAT rate because the end user does not have its own rate).
**Result:**
* Company pays: **18% VAT**
* End user pays: **21% VAT**
***
### 3. All Three Levels Have VAT
**Input values:**
* Organization VAT: *e.g., 21%*
* Company VAT: *e.g., 18%*
* End user VAT: *e.g., 22%*
**Application logic:**
* The company is charged using **18%** (company-level VAT takes priority).
* The end user is charged using **22%** (end-user-level VAT takes priority).
**Result:**
* Company pays: **18% VAT**
* End user pays: **22% VAT**
# Wallet
The Wallet page comprehensively overviews your company's financial transactions and wallet management.
**1. General**
* **Enable Wallet**: This toggle feature allows users to turn the wallet functionality on or off, providing flexibility based on the company’s financial management preferences.
* **Minimum Balance**: Сan either be ***positive*** or ***negative***. A positive minimum balance indicates that a certain amount must be maintained in the account, while a negative minimum balance allows for a deficit, meaning the account can go below zero up to a specified limit.
**2. Overview of Transactions**
* **Starting Balance**: Displays the initial amount available in the wallet before any transactions are made, providing a baseline for financial tracking.
* **Total Refilled**: This shows the total amount added to the wallet over a specified period, helping users monitor funding activity.
* **Total Spent**: Indicates the cumulative amount spent from the wallet, allowing users to track expenditures efficiently.
* **Ending Balance**: Reflects the current wallet balance after accounting for all refills and expenditures, ensuring users have an accurate picture of their financial status.
**3. Transaction History**
* **Date**: Lists the date of each transaction, providing a timeline for financial activities.
* **Description**: Offers a brief summary of each transaction, such as refills or payments made, to help users understand the context of each entry.
* **Amount**: Displays the monetary value of each transaction, allowing users to assess their financial movements at a glance.
# Webhooks
This section briefly describes the concept of webhooks and how to use them with the platform. It provides basic terms and definitions related to the topic of webhooks, as well as the main entities and examples of payloads that your application can receive.
# Terms used
This page uses generally accepted and newly coined terms. Definitions of the most commonly used terms in this document are provided below.
**Push API** – is the tool that allows websites to send instant messages (webhooks) to your Endpoint URL, on something triggers like creating a new account, changing SIM usage, etc. This tool sends a webhook from one application to another application when something event was triggered. For example, you can set up your endpoint URL to send a webhook notification when something Prepaid SIM Card has 200 MB of usage remaining.
All webhooks described in this docs use the standard JSON syntax.
**Webhook** – is the HTTP POST request to your endpoint URL, called in Push API process.
**Endpoint URL** – is a URL link to your-side web server that implements a handler of webhook with different payloads. For example, a handler of the "echo" webhook payload is necessarily required to work with Push API (for more details, see section 2).
**Webhook Payload** – is a body of Webhook. This docs define the set of default payloads that may occur in webhooks (for more information about webhook payloads, see section 5).
**Webhook Payload Model** – is a typical JSON that can occur in different webhook payloads. Models have required and optional fields, and are designed to unify sets of parameters of default objects like SIM Card, Account, etc. (for more information about webhook payload models, see section 4).
# Endpoint validation
A prerequisite for using Push API is the validation of your endpoint URL. You must implement a webhook request handler of the “echo” type for this.
To validate your endpoint URL, the System will send an "echo" type request, with the “echo\_data” parameter containing some short pseudo-random text. The size of the text will not exceed 50 characters. The text can include Latin letters, Arabic numbers, and the special character “:”.
In the response, the System will expect to receive a response of the “echo” type, with the “echo\_data” parameter, the content of which is identical to what was in the request. You can simply copy the request body into your response, without any additional operations.
You can see examples of HTTP requests and responses (Listing 2.1, 2.2).
**Listing 2.1 – Example of webhook HTTP request**
```
POST /your_endpoint HTTP/1.1
Host: example.your_host.com
User-Agent: GuzzleHttp/7
Content-Type: application/json
Content-Length: 53
{"type":"echo","echo_data":"something:Echo:data:123"}
```
\
**Listing 2.2 – Example of HTTP response**
```
HTTP/1.1 200 OK
...
Content-Type: application/json
{"type":"echo","echo_data":"something:Echo:123"}
```
\
\
The implementation of this handler is required for working with the Push API.
Validation of the endpoint URL is carried out when it is created on the platform, and may also be repeated periodically during its use.
If you do not have the opportunity to implement a handler for the "echo" webhook payload, you can use the manual endpoint URL validation feature. This action is extremely undesirable and is permissible only in special cases!
If you use the manual validation feature, your endpoint URL will continue to be marked as "Invalid", but webhooks will still try to be sent to it. You also assume responsibility for any incorrect URL links. We reserve the right to block invalid URLs
# Authentication
To enhance security against potential attacks like spam and DDoS on your endpoint, we recommend implementing authentication for all incoming requests. For this purpose, we include a hash and timestamp in the headers of webhooks. The hash is generated using the SHA256 cryptographic algorithm, following the format:
*`api_secret``:``timestamp``,`*
where:
*api\_secret* – is a secret key that you can get by sending us a request for it,
*timestamp* – is a UNIX timestamp in seconds.
**Listing 3.1 – Example of auth hash calculating (pseudocode)**
```
var apiSecret = "96f3fbc76a921307f1c90d42a2203c9d";
var timestamp = 1704067200; // 2024-01-01 00:00:00
var hash = sha256(apiSecret + ":" + timestamp);
// hash = "68361c09cc50993ca6e0486e1f530c1d4e36a8aca9c8d20eb0d3aafbe47d2d5d"
```
It is recommended to always authenticate all incoming webhooks.
# Webhook Payload Models
Account Balance ModelWebhook Payload Models are unified JSON objects that can occur in different webhook payloads.
Models have required and optional fields. Required fields always exist in the model. Optional fields are parameters that may be absent for different reasons.
Below are defined all the models that can be found in webhook payloads.
# Account Model
Account Model - is a base model for show platform account parameters. The fields of the Account model are presented in the table (Table 4.1), with an example below (Listing 4.1). There are the following types of this model (Table 4.2).
**Table 4.1 - Fields of Account Model**
Has more rules than Companies and End Users and manages them
3
Company
Has more rules than End Users and manages them
4
End User
Main account of user with basic rules
# End User Model
End User Model - is an extended model from Account Model for show platform end user parameters. The fields of the End User model are presented in the table (Table 4.3), with an example below (Listing 4.2).
**Table 4.3 - Fields of End User Model**
**Listing 4.2 - Example of End User Model (JSON)**
```
{
"uuid": "ff472de7-59b2-425d-96ec-9d1ff4bab684",
"name": "Example End User",
"status": {...//Status Model},
"currency_code": "EUR",
"email_for_notification": "email.notif@gmail.com",
"vat_number": "1234567890",
"address": {...//Account Address Model},
"owner": {...//User Model},
"company": {...//Account Model}
}
```
# Account Address Model
The Account Address Model is the model that is most often found within the Account Model and contains information about its contact address. Its fields are presented in the table (Table 4.4), with an example (Listing 4.3).
**Table 4.4 – Fields of Account Address Model**
№
Key
Type
Exists
1
house_number
string
optional
2
street
string
optional
3
addition
string
optional
4
city
string
optional
5
state
string
optional
6
country_code
string
optional
7
postal_code
string
optional
**Listing 4.3 – Example of Account Address Model (JSON)**
```
{
"house_number": "52/1",
"street": "Green Street",
"addition": "Office 23",
"city": "Example City",
"state": "Example State",
"country_code": "US",
"postal_code": "17000"
}
```
# Wallet Model
The Wallet Model is a model that displays the wallet balance and currency of a specific account. Its fields are presented in the table (Table 4.5), with an example below (Listing 4.4).
**Table 4.5 – Fields of Wallet Model**
№
Key
Type
Exists
Description
1
remaining_balance
float
required
Remaining founds, 2 decimals
2
currency_code
string
required
Balance currency. “EUR”, “USD”, etc.
**Listing 4.4 – Example of Wallet Model (JSON)**
```
{
"remaining_balance": "52.99",
"currency_code": "EUR"
}
```
# Plan Model
The Plan Model – is a base model for showing platform plan parameters. Model fields are presented in the table (Table 4.6), with an example below (Listing 4.5). There are the following types of this model (Table 4.7).
**Table 4.6 – Fields of Plan Model**
№
Key
Type
Exists
Description
1
uuid
uuid v4, string
required
Main identifier of plan
2
type
string
required
Type of the plan
3
name
string
required
Public name of the plan
4
operator_title
string
optional
Title of operator with integration, if it exists
5
prepaid_refills
array
optional
Available refills for this plan
**Listing 4.5 – Example of Plan Model (JSON)**
```
{
"uuid": "271295c0-2019-470d-b7d9-b79bc2686cfd",
"type": "prepaid",
"name": "Plan Name",
"operator_title": "Test Operator (Integration)"
"prepaid_refills": [
{...//Refill Model},
{...//Refill Model},
...other refills
]
}
```
**Table 4.7 – Plan Types**
№
Title
Description
1
Monthly bundle
Pay after using. One of subscription subtype
2
Pay per MB
There is static price for MB. One of subscription subtype
3
Unlimited
Usage is unlimited. One of subscription subtype
4
Dynamic pool
Pool usage can change. One of subscription subtype
5
Static pool
Pool usage can’t change. One of subscription subtype
6
Prepaid
Need to pay before using
7
PAYGO
One of subscription subtype
# Pool Model
The Pool Model – is a base model for showing platform pool parameters. Models fields are presented in the table (Table 4.8), with an example below (Listing 4.6).
**Table 4.8 – Fields of Pool Model**
№
Key
Type
Exists
Description
1
uuid
uuid v4, string
required
Main identifier of pool
2
name
string
required
Public name of pool
3
current_usage_kb
integer
optional
Current pool usage Listing
**Listing 4.6 – Example of Pool Model (JSON)**
```
{
"uuid": "34160e3a-3492-4f6f-bbf6-c9a9be15ea55",
"name": "Pool Name",
"current_usage_kb": "51200"
}
```
# SIM Card Model
The SIM Card Model – is a base model for show platform SIM card parameters. Model fields are presented in the table (Table 4.9), with an example below (Listing 4.7). There are the following types of this model (Table 4.10).
**Table 4.9 – Fields of SIM Card Model**
№
Key
Type
Exists
Description
1
iccid
string
required
Identifier of SIM Card
2
sim_card_type
string
optional
Type of SIM, if it exists
3
msisdn
string
optional
Identifier of SIM line
4
imei
string
optional
Identifier of SIM device, if it exists
5
is_e_sim
boolean
optional
Shows whether it is an eSIM card
6
status
Status Model
optional
Current SIM Card status
7
plan
Plan Model
optional
SIM Plan, if it exists
8
company
Account Model
optional
Assigned SIM Company
9
end_user
Account Model
optional
Assigned SIM End User
10
details
array
optional
Details about SIM Card like usage, etc.
**Listing 4.7 – Example of SIM Card Model (JSON)**
# Status Model
The Status Model – is a model for show platform status parameters. Model fields are presented in the table (Table 4.11), with an example below (Listing 4.8). There are the following types of this model (Table 4.12).
**Table 4.11 – Fields of Status Model**
№
Key
Type
Exists
Description
1
id
id, integer
required
Status identifier
2
title
string
required
Status title
**Listing 4.8 – Example of Status Model (JSON)**
{
"id": "1",
"title": "pending",
}
**Table 4.12 – Status Types**
№
Title
Description
1
Pending
Waiting for activation
2
Invalid
Broken
3
Active
In use
4
Suspended
I pause for some reason. Waiting for reactivation.
5
Not Available
Some problems with SIM
6
Blank
Need to assign one of the Plans
7
Activation
Ready Active, wait for first usage
8
Archived
Deleted or SIM Swaped
# User Model
The User Model – is a base model for showing platform user parameters. Models fields are presented in the table (Table 4.13), with an example below (Listing 4.9).
**Table 4.13 – Fields of User Model**
№
Key
Type
Exists
Description
1
uuid
uuid v4, string
required
Main identifier of user
2
email
string
required
User email
3
first_name
string
optional
User first name, if it set
4
last_name
string
optional
User last name, if it set
5
status
Status Model
optional
Current user status
6
company
Account Model
optional
If End User does not exist
7
end_user
End User Model
optional
Main account for user
8
is_two_factor_enabled
boolean
optional
Shows user 2FA state
9
timezone
string
optional
Shows user setting timezone
10
format_date_time
string
optional
User format for date and time
11
format_number
string
optional
User format for numbers
**Listing 4.9 – Example of User Model (JSON)**
```
{
"uuid": "b528bcb9-86cf-2d72834d02ab",
"email": "user_email@gmail.com",
"first_name": "John",
"last_name": "Johnson",
"status": {...//Status Model},
"company": {...//Account Model},
"end_user": {...//End User Model},
"is_two_factor_enabled": true,
"timezone": "UTC",
"format_date_time": "Y-m-d H:i:s",
"format_number": "fr-CA"
}
```
# Prepaid Refill Model
The Prepaid Refill Model – is a model for showing platform plan prepaid refill parameters. Model fields are presented in the table (Table 4.14), with an example below (Listing 4.10).
**Table 4.14 – Fields of Refill Model**
№
Key
Type
Exists
Description
1
uuid
uuid v4, string
required
Main identifier of refill
2
amount_mb
integer
required
MB amount for refill
3
price
float
required
Price for refill (with VAT if it exists)
4
currency_code
string
required
“EUR”, “USD”, etc.
**Listing 4.10 – Example of Refill Model (JSON)**
```
{
"uuid": "b528bcb9-86cf-2d72834d02ab",
"amount_mb": "315",
"price": "90.95",
"currency_code": "USD"
}
```
# Date Time Model
The Date Time Model – is a model for showing date time parameters like timestamp, time, date, and timezone. Model fields are presented in the table (Table 4.15), with an example below (Listing 4.11).
**Table 4.15 – Fields of Date Time Model**
№
Key
Type
Exists
Description
1
unix_timestamp
integer
required
Current date time timestamp
2
human_time
string
required
Time in format ‘H:i:s’
3
human_date
string
required
Date in format ‘Y-m-d’
4
timezone
string
required
Always UTC
**Listing 4.11 – Example of Date Time Model (JSON)**
```
{
"unix_timestamp": "1711929600",
"human_time": "17:25:11",
"human_date": "2024-06-12",
"timezone": "UTC"
}
```
# Rule Model
Rule Model – is a model for showing platform rule parameters. Model fields are presented in the table (Table 4.16), with an example below (Listing 4.12).
**Table 4.16 – Fields of Rule Model**
№
Key
Type
Exists
Description
1
uuid
string
required
Identificator of current rule
2
name
string
required
Rule name
3
description
string
required
Short info about the rule
**Listing 4.12 – Example of Rule Model (JSON)**
```
{
"uuid": "1711929600",
"name": "Rule for refills",
"description": "Send notification to email when usage reaches 100MB"
}
```
# Payment Model
The Payment Model – is a model for show platform payment parameters. Model fields are presented in the table (Table 4.17), with an example below (Listing 4.13). Types of Payment Methods describes in the Table 4.18 and types of Refill Types – in the table 4.19. { "unix\_timestamp": "1711929600", "human\_time": "17:25:11", "human\_date": "2024-06-12", "timezone": "UTC" } { "uuid": "1711929600", "name": "Rule for refills", "description": "Send notif to email when usage reaches 100MB" } Sheets Doc. No. Date Sheet Rev. Push API Documentation 18 3 27 PPAD.01
**Table 4.17 – Fields of Payment Model**
One of Internet payment types. Depends on your payment integration
3
card
Money for payment was used from assigned to the Account credit card
4
cardknox
One of Internet payment types. Depends on your payment integration
5
ideal
One of Internet payment types. Depends on your payment integration
6
manual
Payment was made by admin manually
7
paypal
One of Internet payment types. Depends on your payment integration
8
stripe
One of Internet payment types. Depends on your payment integration
**Table 4.19 – Refill Types**
№
Title
Description
1
Refill SIM
SIM Card MB amount was refilled
2
Refill eSIM
eSIM Card MB amount was refilled
3
Refill Wallet
Wallet money amount was refilled
4
Buying an eSIM
eSIM Purchase
# Credit Card Model
The Credit Card Model – is a model for show platform credit card parameters. Model fields are presented in the table (Table 4.20), with an example below (Listing 4.14).
**Table 4.20 – Fields of Credit Card Model**
№
Key
Type
Exists
Description
1
uuid
string
required
Identificator of current rule
2
name
string
required
Rule name
3
description
string
required
Short info about the rule
**Listing 4.14 – Example of Credit Card Model (JSON)**
```
{
"uuid": "1711929600",
"name": "Rule for refills",
"description": "Send notification to email when usage reaches 100MB"
}
```
# Webhook Payload Types
Payload Types are data arrays with defined keys and data, some of which are required and others are not.
You need to be prepared to process different payload types and know which data they contain.
"Optional" marks fields that must not be present in the body of the webhook that is sent. Fields without ‘optional’ marks are required.
The listed types may change, and new ones may be added. Please follow the latest revisions of this documentation.
Technical Payloads
Event Payloads
Rule Payloads
# Technical Payloads
These payloads are designed to perform certain system operations, such as endpoint validation, for example.
**echo** – a payload that is sent to an endpoint for validation. The endpoint must respond with the same payload (Listing 5.1).
**Listing 5.1 – Example of echo Payload (JSON)**
```
{
"type": "echo",
"data": {
"echo_data": "echo:Ariel:1715854344"
},
"created_at": {...//Date Time Model}
}
```
# Event Payloads
vent Payloads are payloads that are sent to the endpoint when a certain event occurs, such as a user being deleted or company data being changed.
# Company Events
Company Events are triggered by certain actions aimed at the company or elements related to it.
**company.added** – occurs when an Organization adds a company to itself and its owner completes registration, not only invited (Listing 5.2).
**Listing 5.2 – Example of company.added payload (JSON)**
```
// Some code
```
**company.deleted** – occurs when the Organization deletes its own company. The company must be confirmed and has a confirmed owner, not only invited (Listing 5.3).
**Listing 5.3 – Example of company.deleted Payload (JSON)**
```
{
"type": "company.added",
"data": {
"company": {...//Account Model}
},
"created_at": {...//Date Time Model}
}
```
**company.updated** – occurs when certain data is updated in an organization's Company, such as a name or currency, for example (Listing 5.4).
**Listing 5.4 – Example of company.updated Payload (JSON)**
```
{
"type": "company.updated",
"data": {
"company": {...//Account Model}
},
"created_at": {...//Date Time Model}
}
```
# Company Staff Events
Company Staff Events are triggered by certain actions aimed at the company’s employees (staff).
**company.staff.added** – occurs when the Company adds a Staff user to itself. The staff user must be registered, not only invited (Listing 5.5).
**Listing 5.5 – Example of company.staff.added Payload (JSON)**
```
{
"type": "company.staff.added",
"data": {
"user": {...//User Model}
},
"created_at": {...//Date Time Model}
}
```
**company.staff.deleted** – occurs when Company deletes its own Staff user. The user must be registered, not only invited (Listing 5.6).
**Listing 5.6 – Example of company.staff.deleted Payload (JSON)**
```
{
"type": "company.staff.deleted",
"data": {
"user": {...//User Model}
},
"created_at": {...//Date Time Model}
}
```
**company.staff.updated** – occurs when certain data is updated in an company’s Staff user, such as a name or email, for example (Listing 5.7).
**Listing 5.7 – Example of company.staff.updated Payload (JSON)**
# End User Events
End User Events are triggered by certain actions aimed at the End User or elements related to it.
**end\_user.added** – occurs when Company or Organization adds an End User to themselves and the end user confirms registration, not only be invited (Listing 5.8).
**Listing 5.8 – Example of end\_user.added Payload (JSON)**
```
{
"type": "end_user.added",
"data": {
"end_user": {...//End User Model}
},
"created_at": {...//Date Time Model}
}
```
**end\_user.deleted** – occurs when Company or Organization deletes their own End User. The end user must be registered, not only invited (Listing 5.9).
**Listing 5.9 – Example of end\_user.deleted Payload (JSON)**
```
{
"type": "end_user.deleted",
"data": {
"end_user": {...//End User Model}
},
"created_at": {...//Date Time Model}
}
```
**end\_user.updated** – occurs when certain data is updated in an organization's/company’s End User, such as a name or email, for example (Listing 5.10).
**Listing 5.10 – Example of end\_user.updated Payload (JSON)**
```
{
"type": "end_user.updated",
"data": {
"end_user": {...//End User Model}
},
"created_at": {...//Date Time Model}
}
```
# SIM Card Events
SIM Card Events are triggered by certain actions aimed at the SIM Card.
**sim\_card.assigned\_to\_end\_user** – occurs when a blank SIM Card has been assigned to the End User. There are two situations: the end user registers on the platform with a bought SIM Card or the Organization / Company assigns its own SIM card to its end user (Listing 5.11).
**Listing 5.11 – Example of sim\_card.assigned\_to\_end\_user Payload (JSON)**
**sim\_card.first\_usage** – occurs when the SIM was first used (Listing 5.12).
**Listing 5.12 – Example of sim\_card.first\_usage Payload (JSON)**
```
{
"type": "sim_card.first_usage",
"data": {
"sim_card": {...//Sim Card Model}
},
"created_at": {...//Date Time Model}
}
```
# Payment Payloads
**payment.created** – occurs when some payment has been made (Listing 5.13). The payload contains only either the company or the end user.
Listing 5.13 – Example of payment.created Payload (JSON)
```
{
"type": "payment.created",
"data": {
"payment": {...//Payment Model}
},
"created_at": {...//Date Time Model}
}
```
# Rule Payloads
These payloads are sent to the endpoint when certain rules that have been created for the account are triggered.
# SIM Card Rule Payloads
It occurs when certain rules related to the SIM have been triggered.
**rule.sim\_card.current\_usage.triggered** – occurs when SUBSCRIPTION SIM Card current usage has been changed (Listing 5.14).
**Listing 5.14 – Example of rule.sim\_card.current\_usage.triggered Payload (JSON)**
**rule.sim\_card.status.changed** – occurs when SIM Card status has been changed. SIM Card has been activated for example (Listing 5.15).
**Listing 5.15 – Example of rule.sim\_card.status.changed Payload (JSON)**
```
{
"type": "rule.sim_card.status.changed",
"data": {
"rule": {...//Rule Model},
"sim_card": {...//Sim Card Model}
},
"created_at": {...//Date Time Model}
}
```
**rule.sim\_card.remaining\_usage.triggered** – occurs when PREPAID SIM Card remaining usage has been changed (Listing 5.16).
**Listing 5.16 – Example of rule.sim\_card.remaining\_usage\_triggered Payload (JSON)**
# SIM Pools Payloads
Occurs when certain rules related to the SIM Pool has been triggered.
**rule.pool.usage.triggered** – occurs when Pool usage has been changed (Listing 5.19).
**Listing 5.19 – Example of rule.pool.usage.triggered Payload (JSON)**
# Wallet Payloads
rule.company.wallet.triggered – occurs when the Wallet has been refilled or spent (Listing 5.20). The payload contains only either the company or the end user.
**Listing 5.20 – Example of rule.company.wallet.triggered Payload (JSON)**
# Copy of SIMs
The **SIMs** page provides convenient access to essential information about each SIM card, including their statuses, SIM types, operators, associated companies, and end users.
This enables to easily track data usage, and remaining days on active plans, and view detailed information for each card, such as ICCID, operator, plan, company, and other relevant details.
{% tabs %}
{% tab title="Dictionary" %}
## SIM Types:
### **1.**[ **Prepaid**](/menu/plans/prepaid)
* A SIM card with a certain balance. When the balance runs out, you can refill it yourself or through auto-refills, and the SIM card will continue to work.
* The client pays for the balance top-up, and the amount is added to the SIM card, making it usable.
* SIM cards have usage terms defined by operator contracts. For example, if there are no refills for three years, the SIM card may be deactivated. This is just an example, as details are always specified in contracts with operators.
### **2.** [**Subscription**](/menu/plans/subscription)
A subscription is a product type where the SIM card is used for a month, and at the end of the month, an invoice is issued for all expenses according to the plan (usage). Payment for the usage is deducted at the end of the month.
**Types of Subscription:**
* [**Static Pool**](https://faq.droam.com/menu/pages/JZRWnnRzP0JkYZSyOTU7#id-4.-static-pool)
* [**Dynamic Pool**](https://faq.droam.com/menu/pages/JZRWnnRzP0JkYZSyOTU7#id-5.-dynamic-pool)
* [**Unlimited**](https://faq.droam.com/menu/pages/JZRWnnRzP0JkYZSyOTU7#id-3.-unlimited)
* [**Monthly Bundle**](https://faq.droam.com/menu/pages/JZRWnnRzP0JkYZSyOTU7#id-1.-monthly-bundle)
* [**Pay per Megabyte**](/menu/plans/subscription#pay-per-megabyte)
### **3.** [**PAYGO**](/menu/plans/paygo)
Pay GO (pay-as-you-go in real time) is a product that charges for data per megabyte.
PAYGO is a flexible data billing product that charges users per megabyte of data used, offering advanced features and seamless integration. Unlike standard pay-per-megabyte models, PAYGO allows operators to set prices not only based on total data consumption but also for specific countries.
***
### SIM Statuses:
1. **Not available** – No integration.
2. **Pending** – Being checked by the integrator because it was just added to the platform, or operations are being performed on it (e.g., SIM swap).
3. **Blank** – SIM without a line.
4. **Activation ready** – Has a line and a plan (linked to a company if not for store use).
5. **Active** – Operating in normal mode.
6. **Suspended** – Manually or systemically suspended (e.g., expired).
7. **Invalid** – Something went wrong with the integration
***
### General terms in the SIMs section:
* **ICCID -** The unique identifier for each SIM card. For eSIMs, the number is displayed along with a QR code, making it easy to distinguish between physical SIMs and eSIMs.
* **In session:**
* Yes - the SIM is currently online and in use.
* No - the SIM is currently offline and not in use.
* N/A - the status of the SIM is undetermined because the integration does not support it.
* **Operator -** The mobile network provider associated with the SIM, such as Telefonica, Vodafone UK, HOT Mobile, Odido, Orange France, Partner, Plus, WWS.
* **Plan -** Shows the name of the current plan, which is automatically generated but can be customized if needed
* **Company -** Company name to which the SIM card is assigned.
* **End User -** The email address of the end user linked to the SIM.
* **Data left (MB) -** Remaining data allowance for the SIM.
* **Days left -** The remaining days before the plan or SIM expires.
* **This month (MB) -** Data usage for the current month.
* **Note -** A field for any additional notes or comments.
* **Rules -** Customizable rules applied to the SIM
* **Labels -** Customizable labels for organizing SIMs.
* **SIM type -** Indicates whether the SIM is Prepaid, Subscription, or PAYGO.
{% endtab %}
{% tab title="Key features" %}
### Key features of the page include:
1. **Dynamic Table:**
You can adjust the order of displayed data, add new columns from the existing list, or hide columns that are not needed. This flexibility allows you to customize the interface to fit your specific needs.
2. **By clicking the "+" button, you can perform 5 actions:**
1. Upload new SIM card(s) into the system
2. Create New Prepaid SIM card(s)
3. Create New Subscription SIM card(s)
4. Create New PAYGO SIM card(s)
5. Prepare an eSIM(s) for the store
6. **Bulk Operations -** You can perform bulk actions such as:
* **Activate:** Quickly activate multiple SIM cards at once.
* **Suspend:** Suspend a group of SIM cards, temporarily halting their services.
* **Replace Plan:** Update the data plan for several SIMs in one go.
* **Send SMS:** Send a message to the end users associated with the selected SIM cards.
* **Change Note:** Modify or update notes for multiple SIM cards to include new information or instructions.
* **Refresh Usage:** Refresh the usage data for all selected SIMs to ensure up-to-date statistics.
* **Rules:** Apply or modify automation rules for the selected SIMs, such as data limits or notifications.
* **Assign Company:** Assign multiple SIM cards to a company for better organization.
* **Unassign Company:** Remove the company association from selected SIM cards.
* **Labels:** Add or modify labels to categorize and organize multiple SIM cards at once.
* **Cancel SIM:** Cancel the selected SIM cards and remove them from the system.
* **Upload Details:** Upload specific details or configurations in bulk for selected SIM cards.
* **Export:** Export the information of selected SIM cards to a file for further analysis or reporting.
7. **Detailed SIM Card Information:** Here you can click on any SIM card number (ICCID) to access more detailed information, organized into three main tabs:
* **Details:** Manage the SIM card status, view data left, add labels for bulk management, assign the SIM to an end user, set up specific rules, send SMS messages, and more.
* **Usage:** Check daily data usage and see information about the countries where the SIM is being used.
* **Log:** Displays a history of changes with date, modified fields, old and new values, and the user who made the changes. This is useful for auditing and tracking adjustments.
It helps track the status and usage of SIM cards, ensuring full control over mobile connections. This is crucial for maintaining seamless operations, avoiding overages on mobile expenses, and responding promptly to any issues or changes.
{% endtab %}
{% endtabs %}
## Q\&A
Why can't I see any usage?
There could be a couple of reasons for this.
1. The product has not been created (attach the SIM to a plan and a company)
2. Your SIM hasn't generated any usage so far.
What does the Activation Ready status mean?
This status means that the SIM is active with the operator, but there has been no usage yet. Once the SIM card is used, the status will change to "Active."
Why can't I add SIM Card to the eSIM store?
You are unable to add a SIM card to the eSIM store due to the following reasons:
* The necessary integration for the SIM is missing.
* The SIM card is not an eSIM. Only eSIMs can be added to the eSIM store, so please ensure you are adding an eSIM and not a regular SIM card.
How do I refill?
You have two options for refilling your balance:
1. **Manual Refill**\
You can refill your balance manually through your account page on the Platform. Simply log in to your account and follow the prompts to add funds.
2. **Auto-Refill**\
Alternatively, you can set up an auto-refill option. This allows for automatic balance top-ups when your data falls below a specified threshold. To use this feature, you will need to provide a credit card on your account page.
Regardless of the method you choose, your data will be added immediately in real-time upon successful completion of the refill.
# Copy of Plans
On the **Plans** page, you can create and customize data bundles, assign SIM cards to Plans, and monitor Plan details. The table presents essential information about each Plan, including its name, type, associated operator, company, details, labels, and whether the Plan is prorated. You can also add preset configurations for quick and consistent Plan setup.
{% tabs %}
{% tab title="Dictionary" %}
### Plan types:
### **1. Prepaid**
A Prepaid Plan for a SIM card comes with a set balance, and once that balance is depleted, the client can refill it manually or through auto-refills.
#### **How It Works:**
* **Balance Tracking**: the balance is monitored in real-time. When the balance reaches zero, the SIM card is deactivated.
* **Refilling**: The organization can configure/create refills.
#### **Usage Terms**:
Prepaid SIM cards have specific terms based on the operator’s contract. For example, if a SIM card remains inactive (no refills) for three years, it may be deactivated. These details vary and are specified in the operator's contract.
#### **Additional Prepaid Options**:
* **Auto-Refill**: This feature automatically tops up the balance when it falls below a certain threshold (e.g., below 100 MB). The system charges either the company's card or the end user's card to the organization's account, and upon successful payment, the balance is updated instantly.
* **Wallet Balance**: This option allows the client to store a larger sum in advance for auto-refills. For instance, instead of topping up multiple SIM cards frequently with small amounts, the client can deposit $1,000 to cover auto-refills as needed.
#### **Product Expiry**:
Each Prepaid product comes with a usage term. For example, 1 GB of data may be valid for 365 days. If the balance is not refilled within that period, any remaining balance will expire. However, with every refill, the validity period extends from the refill date, ensuring the product can be used for a longer time as long as the balance is regularly topped up.
### **2. Subscription**
A subscription is a Plan type where the SIM card is used for a month, and at the end of the month, an invoice is issued for all expenses according to the Plan (usage). Payment for the usage is deducted at the end of the month.
The subscription is designed for companies rather than end consumers. The end consumer may be linked to the SIM card and see the usage, but cannot manage the SIM card. Management and payment are handled by the company responsible for the SIM card.
### **Types of Subscription Plan:**
#### **1) Static Pool**
A static pool is a pool with a fixed price, independent of the amount of SIM cards in the pool.
#### **2) Dynamic Pool**
Dynamic pool - every new sim added to the pool adds to the total amount of data and increases the pool price. Also known as "SIM cards with pooled data between them
#### **3) Unlimited**
This is a subscription with no usage limits. After paying a fixed cost you can have access to unlimited usage without additional fees.
#### **4) Monthly Bundle**
This bundle is controlled by only one SIM card. You will pay for a fixed amount of data per month. If the entire amount is not used, the funds are not refunded.\
If usage exceeds the bundle limit, additional charges for the extra data apply.
#### **5) Pay per Megabyte**
In this product, the user pays for each megabyte of data used. The more megabytes the user consumes, the more they pay.
### **3. PAYGO**
PAYGO is a real-time product that charges users for data on a per-megabyte basis. While it operates similarly to pay-per-megabyte systems, it provides advanced features and supports seamless integrations. Operators can set prices not only for total data usage but also specifically for different countries. If the operator supplies country-specific information or imposes restrictions in certain regions, corresponding pricing can be established.
**Product Classification**\
PAYGO is classified as a Prepaid service, which means it operates based on a balance. Users must maintain a positive balance to utilize the service; it cannot be accessed if the balance is zero.
PAYGO plans work exclusively with the [Wallet ](/menu/wallet)feature, so if you don't have any companies with Wallet enabled, the company list will be empty when creating a PAYGO plan.
#### **How It Works**
1. **Data Collection**
* The system gathers information from the SIM card, including:
* **The amount of megabytes used**
* **The country in which the card was utilized**
2. **Pricing Determination**
* The system identifies the applicable price based on the collected data and the specific country.
3. **Balance Deduction**
* The necessary amount is instantly deducted from the user's balance.
#### **Real-Time Processing**
As new information is received, the system performs calculations and deducts funds, ensuring that the balance decreases continuously in real time.
{% endtab %}
{% tab title="Key Features" %}
Key features of the page include:
1. **Dynamic Table:** The table is fully customizable, enabling you to add new columns or hide existing ones based on your preferences. This flexibility allows for a more personalized and efficient management experience.
2. **Bulk Operations:** You can perform bulk actions to streamline plan management, such as applying changes to multiple SIM cards simultaneously.
3. **Detailed SIM Card Information:** By clicking on a SIM card number (ICCID), you can access detailed information organized into two main tabs:
* **Details:** View and manage the SIMs assigned to each plan, track refill history, manage labels, and see lifetime refill statistics. This tab provides a comprehensive view of how each SIM card is using its data plan.
* **Log:** Displays a history of changes with date, modified fields, old and new values, and the user who made the changes. This is useful for auditing and tracking adjustments.
This page meets the needs of businesses and organizations that require efficient control over their mobile data plans. By allowing customization and real-time monitoring of data plans, it ensures that mobile data resources are allocated and used effectively.
The ability to track changes and manage multiple SIM cards simultaneously helps to maintain oversight, prevent data overages, and optimize costs, making it an essential tool for managing mobile connectivity.
{% endtab %}
{% endtabs %}
## Q\&A
Why can't I select a company when creating a PAYGO plan?
The company list includes only companies that have Wallet enabled. PAYGO plans work exclusively with the Wallet feature, so if you don't have any companies with Wallet enabled, the company list will be empty when creating a PAYGO plan.
# Prepaid
### Prepaid
* **Purpose**: A fixed balance valid for a defined period and monitored in real-time. Once the balance is used, the Terminal can be refilled manually or automatically.
* **Validity Period:** The validity period is set by the specific prepaid product (for example, 365 days), based on the validity days of the chosen plan.
* **Payment Terms:** One-time payment / Refill
* **Payment Type:** Transactions via Stripe or Invoice
* **Overage:** No – usage stops when the balance or remaining days reach zero.
* **Activation Fee:** No
* **Re-fill:** Yes, different balance with different price
* **Auto refill of Terminal/SIM:** Yes. Available for Companies
* **Manual Refill of Terminal/SIM:** Yes. Available for Organizations
* **Refill/Autorefill with wallet:** Yes
(Each refill extends the validity period of the prepaid product within the plan's validity days.)
* **Prorate:** No
* **MRC:** No
* **Billing start date:** The billing cycle starts when the first usage occurs, and days are counted from that point.
### **Additional Info**
* **Usage Terms**:
Prepaid SIM cards have specific terms based on the operator’s contract. For example, if a SIM card remains inactive (no refills) for three years, it may be deactivated. These details vary and are specified in the operator's contract.
* **Auto-Refill**:
This feature automatically tops up the balance when it falls below a certain threshold (e.g., below 100 MB). The system charges either the company's card or the end user's card to the organization's account, and upon successful payment, the balance is updated instantly.
* **Wallet Balance**:
This option allows the client to store a larger sum in advance for auto-refills. For instance, instead of topping up multiple SIM cards frequently with small amounts, the client can deposit $1,000 to cover auto-refills as needed.
* **Product Expiry**:
Each Prepaid product comes with a usage term. For example, 1 GB of data may be valid for 365 days. If the balance is not refilled within that period, any remaining balance will expire. However, with every refill, the validity period extends from the refill date, ensuring the product can be used for a longer time as long as the balance is regularly topped up.
***
### **How to Create a Prepaid Plan**
# Subscription
A subscription is a Plan type where the SIM card is used for a month, and at the end of the month, an invoice is issued for all expenses according to the Plan (usage). Payment for the usage is deducted at the end of the month.
The subscription is designed for companies rather than end consumers. The end consumer may be linked to the SIM card and see the usage, but cannot manage the SIM card. Management and payment are handled by the company responsible for the SIM card.
### **Types of Subscription Plan:**
1. #### Monthly Bundle
* **Purpose:** A single Termina / SIMl controls this bundle. It includes a fixed amount of data per month. fixed price
* **Validity Period:** 1 calendar month
* **Payment Terms:** Monthly Fee
* **Payment Type:** Pre-Billing, Advanced Billing, Post-Billing, or Manual Invoice Creation. The platform does not validate or enforce payment status (paid/unpaid)
* **Overage:** Yes - you can define a fixed rate that applies when usage exceeds the included balance.
* **Activation Fee:** Yes. It is applied when a terminal or SIM is added, and included in the invoice at the start of the next billing period. The platform does not track payment status.
* **Prorate:** enabled (optional)
* **MRC:** No
* **Billing start date:** is either the date when the SIM/Terminal is assigned or the date of the first usage, whichever occurs first.
***
#### 2. Pay per Megabyte
* **Purpose:** The user pays based on actual usage — the more you use, the more you pay.
* **Validity Period:** 1 calendar month – ongoing until manually stopped
* **Payment Terms:** Usage-based billing
* **Payment Type:** Pre-Billing, Advanced Billing, Post-Billing, or Manual Invoice Creation. The platform does not validate or enforce payment status (paid/unpaid)
* **Overage:** No
* **Activation Fee:** Yes. It is applied when a terminal or SIM is added, and included in the invoice at the start of the next billing period. The platform does not track payment status.
* **Prorate:** enabled (optional)
* **MRC:** Yes (applied either to all SIMs/Terminals or only to active ones)
***
#### 3. Unlimited
* **Purpose:** Unlimited data usage for a fixed monthly cost.
* **Validity Period:** 1 calendar month (renewed monthly)
* **Payment Terms:** Monthly Fee
* **Payment Type:** Pre-Billing, Advanced Billing, Post-Billing, or Manual Invoice Creation. The platform does not validate or enforce payment status (paid/unpaid)
* **Overage:** No — unlimited usage
* **Activation Fee:** Yes. It is applied when a terminal or SIM is added, and included in the invoice at the start of the next billing period. The platform does not track payment status.
* **Recurring fee:** Yes
* **Prorate:** enabled (optional)
* **MRC:** No
* **Billing start date:** is either the date when the SIM/Terminal is assigned or the date of the first usage, whichever occurs first.
***
#### 4. Static Pool
* **Purpose:** This pool has a fixed price, along with a fixed allowed balance and overage rate, regardless of the number of terminals or SIMs included. The total data usage of all Terminals/SIMs within the pool is aggregated.
* **Validity Period:** 1 calendar month
* **Payment Terms:** Monthly Fee
* **Payment Type:** Pre-Billing, Advanced Billing, Post-Billing, or Manual Invoice Creation. The system does not validate or enforce payment status (paid/unpaid)
* **Overage:** Yes - you can define a fixed rate that applies when usage exceeds the included balance.
* **Activation Fee:** Yes. It is applied when a terminal or SIM is added, and included in the invoice at the start of the next billing period. The platform does not track payment status.
* **Prorate:** disabled
* **MRC:** No
***
5. #### Dynamic Pool
* **Purpose:** Every new Terminal/SIM added to the dynamic pool adds to the total amount of data and increases the pool price.
* **Validity Period:** 1 calendar month
* **Payment Terms:** Monthly Fee
* **Payment Type:** Pre-Billing, Advanced Billing, Post-Billing, or Manual Invoice Creation. The platform does not validate or enforce payment status (paid/unpaid)
* **Overage:** Yes - you can define a fixed rate that applies when usage exceeds the included balance.
* **Activation Fee:** Yes. It is applied when a terminal or SIM is added, and included in the invoice at the start of the next billing period. The platform does not track payment status.
* **Prorate:** enabled (optional)
* **MRC:** No
# PAYGO
PAYGO is a real-time product that charges users for data on a per-megabyte basis. While it operates similarly to pay-per-megabyte systems, it provides advanced features and supports seamless integrations. Operators can set prices not only for total data usage but also specifically for different countries. If the operator supplies country-specific information or imposes restrictions in certain regions, corresponding pricing can be established.
* **Purpose:** A real-time prepaid product that charges users based on data usage (per MB/GB). Requires a positive balance in the Wallet to remain active.
* **Validity Period:** 1 calendar month and continues as long as the balance stays positive.
* **Payment Terms:** Payment within the Wallet
* **Payment Type:** Transactions via Stripe or Invoice
* **Overage:** No — service stops when balance reaches zero
* **Activation Fee** (one time): No
* **Re-fill:** Yes, you can refill with varying balances, each associated with a different price.
* **Auto refill with wallet:** Yes. For Company
* **Manual Refill with wallet:** Yes. For Organization
\
Prorate: No
MRC: Yes, applied from either the first usage or the assignment date.
Billing start date: The count starts from the first usage date
# Q\&A
On the **Plans** page, you can create and customize data bundles, assign SIM cards to Plans, and monitor Plan details. The table presents essential information about each Plan, including its name, type, associated operator, company, details, labels, and whether the Plan is prorated. You can also add preset configurations for quick and consistent Plan setup.
Why can't I select a company when creating a PAYGO plan?
The company list includes only companies that have Wallet enabled. PAYGO plans work exclusively with the Wallet feature, so if you don't have any companies with Wallet enabled, the company list will be empty when creating a PAYGO plan.
# Copy of Automation - Rules
The **Automation Rules** page allows you to create and manage rules that automate various processes. This functionality helps streamline operations, improve efficiency, and ensure that specific actions are triggered automatically based on predefined criteria.
{% tabs %}
{% tab title="Dictionary" %}
General Terms from the **Automation** page:
* **Name -** The identifier for the rule.
* **Type -** The type of entity the rule applies to (e.g., SIM, Pool, Account).
* **Period -** The timeframe or cycle during which the rule is active (e.g., billing cycle, permanent, refill cycle).
* **Trigger -** The event or condition that activates the rule (e.g., status change, specific date, remaining balance).
* **Plan Type -** The type of plan to which the rule applies.
* **Condition -** The specific criteria that must be met for the rule to trigger.
* **Action -** The action that will be taken when the rule is triggered (e.g., suspend, activate, send email notification).
* **Created By -** The initiator of the rule.
{% endtab %}
{% tab title="Key Features" %}
1. **Detailed Information:** Clicking on a specific row provides additional details:
* **SIMs:** Displays the number of SIMs affected by the rule.
* **General:** Provides an overview including the rule’s name, period, type, plan type, and description.
* **Condition:** Details the trigger, condition, value, and specific action to be taken.
* **Action:** Specifies what actions will be performed when the rule is triggered, including email and push notifications. Includes options for email notifications (on/off), push API notifications (on/off), and additional email settings for end users and companies.
#### 2. Rule Logs
Tracks the history of rule executions with:
* **Date:** When the action was triggered.
* **Destination:** The recipient of the notification or action.
* **Trigger:** The condition or event that activated the rule.
* **Rule:** The name or identifier of the rule. This field is available only when the transaction was made manually.
* **Action:** The action is taken when the rule is triggered.
Rules can help to automate repetitive tasks and ensure timely responses based on specific conditions. By setting up automation rules, you can efficiently manage operations, reduce manual effort, and ensure that actions and notifications are handled consistently and automatically.
This helps in optimizing workflow, maintaining operational efficiency, and ensuring that critical processes are executed without manual intervention.
{% endtab %}
{% endtabs %}
# Settings
The **Settings** page provides access to essential configuration options for managing your account and platform functionality.
# Account Settings
The **Account Settings** page serves as a comprehensive hub for managing essential information related to your account. This section is organized into four key areas: Billing Info, Address Info, Contact Info, and Default Settings.
### 1. Billing Info
In the **Billing Info** section, users can enter and update their company’s financial details. This includes:
* **Company Name**: The official name of your organization as it appears on billing statements and legal documents.
* **VAT Number**: A unique identification number assigned to your business for value-added tax purposes, necessary for invoicing and tax compliance.
This information is crucial for ensuring accurate billing and compliance with financial regulations.
### **2. Address Info**
The **Address Info** section allows users to provide their organization's physical address for billing and communication purposes. The fields include:
* **Postal Code**: The postal code for your business location, ensuring accurate mail delivery.
* **Country**: The country where your organization is located.
* **Street**: The street address of your business.
* **House Number / Apartment**: Specific house or apartment number to pinpoint your location.
* **City**: The city where your organization operates.
* **State**: The state or region of your business address, if applicable.
Having accurate address information is essential for effective communication and service delivery.
### **3. Contact Info**
The **Contact Info** section is designed to maintain up-to-date contact information for the primary point of contact within your organization. This includes:
* **Contact Name**: The name of the person responsible for managing account-related inquiries.
* **Contact Email**: The email address for the primary contact, ensuring prompt communication regarding account matters.
* **Phone Number**: The primary phone number for reaching the contact person.
* **Phone Number 2**: An optional secondary phone number for additional contact methods.
This section ensures that communication is streamlined and that support can be provided efficiently.
### **4. Default Settings**
The **Default** section allows users to set preferences for their account. This includes:
* **Currency**: The default currency is set so that you don't have to select it repeatedly when creating a plan.
* **Email for Notifications**: The email address designated to receive notifications related to account activity, such as billing alerts, service updates, and other important communications.
# Team and Security
The **Staff** page allows the Organization to register team members and manage their access rights on the platform. This functionality ensures that each staff member has the appropriate permissions to perform their tasks while maintaining security and control over sensitive information.
### **Complete the following steps:**
1. Go to **Settings**.
2. Click on **Team and Security**
3. Click on the Staff member you want to edit access for
4. Go to the Permissions tab and check or uncheck the appropriate box next to the relevant field.
### **1. Automation**** (Allow / Restrict)**
This section governs the automation rules for staff. Administrators can set permissions for various actions related to automation:
* **Rule**: Control access to automation rules by allowing or restricting staff from:
* **Add**: Create new automation rules.
* **View**: Access existing rules.
* **Edit**: Modify existing rules.
* **Delete**: Remove rules from the system.
### **2. Company**** (Allow / Restrict)**
This section focuses on permissions related to company management:
* **Payment Method**: Manage payment methods for the company by allowing or restricting actions to:
* **Add**: Introduce new payment methods.
* **View**: Access current payment methods.
* **Delete**: Remove existing payment methods.
* **Staff**: Control access to staff management features:
* **Add**: Create new staff profiles.
* **View**: Access staff information.
* **Edit**: Modify staff profiles.
* **Delete**: Remove staff members.
* **Log**: View action logs of staff activities.
* **Permissions**: Manage individual permissions for staff.
* **Reset**: Reset staff passwords.
* **Webhook**: Set permissions for webhook management:
* **View**: Access existing webhooks.
* **Update**: Modify webhook settings.
### **3. eSIM Store**** (Allow / Restrict)**
In this section, administrators can control access to the eSIM store:
* **View**: Allow or restrict staff from viewing eSIM offerings.
* **Update**: Enable or disable staff from updating eSIM inventory or pricing.
### **4. End-User**** (Allow / Restrict)**
This section manages permissions related to end-user management:
* **Add**: Create new end-user profiles.
* **View**: Access end-user details.
* **Edit**: Modify existing end-user profiles.
* **Delete**: Remove end-users from the platform.
* **Permissions**: Manage permissions for end-users.
* **Payment Method**: Control access to end-user payment methods:
* **Add**: Create new payment methods.
* **View**: Access current payment methods.
* **Delete**: Remove payment methods.
* **Staff**: Manage staff assigned to specific end-users with similar permission controls as listed above.
### **5. SIM Card**** (Allow / Restrict)**
This section governs the management of SIM cards:
* **Add**: Create new SIM card entries.
* **View**: Access details of existing SIM cards.
* **Edit**: Modify SIM card information.
* **Delete**: Remove SIM cards from the system.
* **Actions**: Control various SIM card actions, including:
* **Assign/Unassign Company**: Manage company assignments for SIM cards.
* **Assign/Unassign End-User**: Manage end-user assignments.
* **Assign/Unassign Plan**: Link SIM cards to specific plans.
* **Assign/Unassign Rule**: Apply automation rules to SIM cards.
* **Assign/Unassign Label**: Tag SIM cards for better organization.
* **Cancel Location**: Manage location settings for SIM cards.
* **Change Status**: Modify the status of SIM cards.
* **Send SMS**: Control SMS functionality for SIM cards.
* **SIM Swap**: Manage SIM swapping procedures.
* **Update Note**: Add notes to SIM card records.
* **Manual Refill**: Perform manual refills for prepaid SIM cards.
### **6. Satellite**** (Allow / Restrict)**
T
his section governs the management of Terminals:
* **Add**: Create new invoice templates.
* **View**: Access existing invoices.
* **Edit**: Modify invoice details.
* **Delete**: Remove invoices from the system.
* **Actions**: Control various SIM card actions, including:
* **Assign/Unassign Company**: Manage company assignments for Terminals.
* **Assign/Unassign Plan**: Link Terminals to specific plans.
* **Assign/Unassign Label**: Tag Terminals for better organization.
* **Change Status**: Modify the status of Terminals.
* **Update Note**: Add notes to Terminal records.
### **7. Invoice Software**** (Allow / Restrict)**
This section controls access to invoice management features:
* **Add**: Create new invoice templates.
* **View**: Access existing invoices.
* **Edit**: Modify invoice details.
* **Delete**: Remove invoices from the system.
* **Parameters**: Set permissions for viewing and editing invoice parameters.
### **7. Operator**** (Allow / Restrict)**
Manage telecom operator details:
* **Add**: Create new operator profiles.
* **View**: Access information about existing operators.
* **Edit**: Modify operator details.
* **Delete**: Remove operators from the system.
### **8. Organization**** (Allow / Restrict)**
This section allows control over organizational settings:
* **View**: Access organization details.
* **Edit**: Modify organizational information.
* **Staff**: Manage staff related to the organization with similar permissions as outlined in previous sections.
* **Webhook**: Manage webhooks specific to the organization.
### **9. Payment**** (Allow / Restrict)**
This section controls access to payment management:
* **View**: Allow or restrict staff from accessing payment details.
### **10. Billing**** (Allow / Restrict)**
Manage billing settings and permissions:
* **View**: Access billing information.
* **Edit**: Modify billing settings.
* **Advance Billing Enable**: Control whether advance billing options are available.
* **Create**: Allow or restrict staff from creating billing entries.
### **11. Plan**** (Allow / Restrict)**
Control access to service plans:
* **Add**: Create new service plans.
* **View**: Access details of existing plans.
* **Edit**: Modify plan information.
* **Delete**: Remove plans from the system.
### **12. Pool**** (Allow / Restrict)**
Manage access to resource pools:
* **Pool**: Control permissions for adding, viewing, editing, and deleting resource pools.
### **13. PSP**** (Allow / Restrict)**
Manage Payment Service Provider settings:
* **Add**: Create new PSP entries.
* **View**: Access details of existing PSPs.
* **Edit**: Modify PSP information.
* **Delete**: Remove PSPs from the system.
# Operators
The Operators section is dedicated to managing telecom operators associated with the platform.
A centralized management approach simplifies the oversight of multiple operators, ensuring efficient operations and easy adaptation to changing business requirements.
Operator Name
Status
FloLive
Integrated ✅
HOT Mobile
Integrated ✅
KPN
Integrated ✅
Odido
Integrated ✅
Partner
Integrated ✅
Pelephone
Integrated ✅
Plus
Integrated ✅
Rogers
Integrated ✅
Tele2 Sweden
Integrated ✅
Telefonica
Integrated ✅
Vodafone
Integrated ✅
WWS
Integrated ✅
## Q\&A
How to add new operators?
1. Navigate to **Settings**.
2. Select **"Operators"** from the menu.
3. Click the **"+"** button on the right side of the page to add a new operator.
4. On the **"Add a New Operator"** page, select an operator from the provided list.
5. Enter any additional details, if required.
6. Click the **Create** button to finalize.
If the operator you need isn't listed, please reach out to our manager for assistance.
# Billing Integrations
The **Billing Integrations** page is designed to manage and monitor financial transactions through integrated payment service providers (PSPs) and invoicing systems.
[**1. PSPs (Payment Service Providers)**](/onboarding-guide/optional-settings/3.-psp-integration)
This section provides an overview of transaction data from various payment service providers integrated into the platform. For each PSP, you can view both monthly and total transaction details, presented in EUR and transaction count.
*
```
**1) Stripe**
```
```
* To set up the integration with Stripe, you will need to enter your **Key** and **Secret**.
* Follow up on the instructions below
* Open your Stripe Dashboard and navigate to the "Developers" page. Find "Webhooks" in the tabs list and select it. Click the designed button to add an endpoint URL, then enter the following URL: [https://platform.droam.com/webhook/d813177c-51af-4836-8ab7-0c146ad6a886/stripe](https://platform.droam.com/webhook/d813177c-51af-4836-8ab7-0c146ad6a886/stripe)
* For next step, add the events to listen to by selecting the following list of 9 events:
* charge.refunded
* charge.succeeded
* charge.updated
* setup\_intent.succeeded
* source.canceled
* source.chargeable
* payment\_intent.succeeded
* payment\_method.attached
* payment\_method.detached
* Save these settings by clicking the "Add endpoint" button to complete the Stripe webhook setup.
**2) PayPal**
To integrate with PayPal, you will need to provide the following details:
* Endpoint
* Username
* Password
* Checkout
* Signature
**3) Cardknox**** (pending)**
To integrate with Cardknox, you will need to provide the **X-key**
**4) Mollie**
To integrate with Cardknox, you will need to provide the **API Key**
If you plan to use only Subscription - PSP is not needed
```
***
**2. Invoice Integration**
This section allows you to add and manage third-party invoicing systems to streamline your billing process. By clicking the “+” button, you can integrate with supported invoicing platforms:
* **WeFact**: A cloud-based invoicing system.
* **Xero**: A popular accounting software for small businesses.
Once integrated, these systems allow for automated invoice generation and management, enhancing billing efficiency on the platform.
You as an Organization can connect all your products there and on the platform using SKU, and customers using Identifier.
{% hint style="info" %}
**Important**
If a Company or End User wants to make a payment, they can only use the payment methods linked by the organization. If the organization has not linked any payment systems, it means that the company and end user cannot make any payments (it all depends on the product type being used).
{% endhint %}
# VAT
You can set a default VAT percentage to apply to all external transactions, with the flexibility to customize it for individual customers as needed.
**To update a customer's VAT percentage:**
1. Navigate to the **Companies** or **End Users** tab in the main Menu.
2. Select the relevant company/customer
3. In the **General** tab, navigate to **Billing Details** and click **Edit**.
4. Adjust the VAT percentage under **Billing Details**, or specify it when creating a new company.
{% hint style="warning" %}
**Important**
* VAT is calculated and added to the amount being refilled.
* *For example, when a client refills a wallet, VAT is applied based on the set percentage.*
* **If VAT is set to 0%**, VAT will not be collected on any transaction or refill, and the system will not apply VAT to platform prices.
* *For example, If the default VAT is 0%, prices will be shown without VAT, and no VAT will be charged on transactions.*
{% endhint %}
{% hint style="success" %}
**VAT Application on Platform Prices**
* By default, all platform prices are displayed **excluding VAT**.
* Once VAT is configured in the **organization settings**, it is automatically applied to platform prices unless a different VAT percentage is specified for a specific company.
{% endhint %}
# Self-SIM Activation
Below you can find a step-by-step guide on how to request the activation of the SIM(s) via the platform. For any questions about the process or if you have any suggestions, please contact your account manager or mail us at
**Single SIM activation**
1. Go to the SIMs menu and enter the ICCID in the search field;
2. Click on the SIM and find the “Activate” button;
3. Fill in the fields by setting up the activation date, SIM type, and Plan (optionally, set the End-user and Note)\*;
4. You will receive an automatic email confirmation once the SIM is activated
**Bulk SIM activation**
1. Enter the ICCIDs in the search field separated by a comma. Example:
2. Select all SIMs from the search results;
3. Find the “Plus” button and click on “Activate”
4. Set the Activation Date, SIM type and in the Plan field, choose the plan that is associated with the SIMs operator;
5. All selected SIMs will appear in the “SIMs to activate” field automatically
6. Confirm the action by clicking on “New Activation”
7. You will receive an automatic email confirmation once the SIM is activated
{% hint style="info" %}
Note:
* You can only perform bulk activation for the SIMs from the same operator and with the same plan.
* The described method can only be used for the SIMs in “Available” status on the platform, meaning without a plan.
* All the plans in the list are associated with your account only. Choose the SIM type depending on the plan type: Prepaid, Subscription, or Paygo.
{% endhint %}
We are confident these enhancements will elevate your experience with our products and services. Our commitment to innovation and customer satisfaction remains unwavering, and we are excited to have you on this journey with us.
Thank you for choosing DROAM as your trusted partner.
# Custom Link(s)
Set your custom external links in the account settings and specify who can view them—just you or your company as well.
*How to use:*
*1)* Go to the account settings,
2\) Find the 'Custom Menu'
3\) Enter your external links if you'd like.
4\) The links you add will appear in the top navigation menu.
{% hint style="warning" %}
**Important:**
You can add up to 5 external links, which will be displayed in the header navigation.
{% endhint %}
***
# Upload SIMs
As an organization, you can upload SIMs to the platform by following these steps:
1. Go to the **SIMs** from the menu on the left.
2. Choose either **"Upload SIM Details"** or click the **plus (+)** button.
**Option 1: Upload SIM Details**
* A popup window will appear.
* You’ll be able to upload a `.xlsx` file and click **"Confirm"** to proceed.
* You can also **download a template file** to see the required fields for each SIM.
**Option 2: Plus (+) Button**
* A modal window will open.
* Select the **Operator** (required) and the **Company** (optional).
* Click on **"File"** to upload your `.xlsx` file, then click **"Confirm."**
* A **template file** is also available for download to check which fields are needed for each SIM.
{% hint style="info" %}
The XLSX file can contain 10,000 SIMs or more. However, we recommend starting with a test upload of around 100 SIMs to ensure everything works as expected before uploading the full list.
{% endhint %}
# eSIM Purchase & Activation
### **1. Registered End User** (purchase on the Platform)
1. Go to the **eSIM Store** from the menu on the left.
2. Use the **search bar** to find the country or countries you need.
3. Click on the **plan/package** you’d like to purchase.
4. Review the package details in the popup window. Click **"Buy Now."**
5. Select your **preferred payment method.**
6. Click **"Checkout."**
7. Review the payment details in the **Payment Confirmation** popup. Click **"Pay."**
8. If the payment is successful, a **Thank You** page will appear.
9. Click “Install eSIM” on the Thank You page, or go to the SIMs section from the left-hand menu to find your eSIM.
10. Click **"Details"** next to your eSIM.
11. Find the **"Install eSIM"** section and click **"More Info."**
12. Follow the steps shown to activate your eSIM.
***
### NEW User (purchase on the eStore)
1. On the main page of the **eSIM Store**, use the **search** bar to select the appropriate country or countries.
2. Click on the **plan** you'd like to purchase.
3. Review the details in the popup window. Click **"Buy Now."**
4. Enter your email and click **"Send Email Verification."**
5. Check your inbox for the 6-digit verification code and enter it. Then click **"Verify."**
6. Set up your account by entering your **first and last name.** and click **"Continue."**
* If you're creating a business account, check the box **"Set up a business account."**
7. Create a password. Then click **"Continue."**
* To increase security, you can enable Multi-Factor Authentication (MFA) by checking the corresponding box.
8. Enter your **billing address** and click **"Complete."**
* Please make sure to check the box confirming that you agree to the **Terms of Use and the Privacy & Cookies Policy.**
9. Select your **preferred payment method.** Click **"Complete."**
9. Proceed with the payment. (For example: Stripe)
11. If the payment is successful, a **Thank You** page will appear.
12. On the Thank You page, click **"Install eSIM"** to begin the activation process.
# eSIM Store Activation
### To enable the eSIM Store, please **follow these steps:**
1. Ensure that the eSIM Store is available for the company you wish to enable it for. To do this, Navigate to the Companies section.
2. Click on the desired company.
3. Go to the Permissions tab.
4. Check the box next to the eSIM Store.
5. Next, proceed to the “Plans” menu.
6. Filter by the company you need.
7. Filter by the desired operator.
8. Select the plan you wish to enable for the eSIM Store.
9. Choose the appropriate Coverage.
10. Select the Rate Plan.
11. Click the Save button.
To confirm that the eSIM Store is enabled for the company:
12. Go to the company level for which the eSIM Store has been activated and ensure it appears in the menu.
Enjoy using the eSIM Store!
---
[Next Page](/llms-full.txt/1)
.png?alt=media&token=414419ff-b767-4e32-837d-6070336c5813)
.png?alt=media&token=615f0c10-8e57-4e08-89f8-8deed9ae2901)
.png?alt=media&token=df5e9125-667e-455f-ba46-aac5d81643af){kind=link}
.png?alt=media&token=7d179083-26c9-435a-9535-9a1f79a757bc){kind=link}
.png?alt=media&token=0b480833-620e-420f-9daf-7cdc733a145b){kind=link}
.png?alt=media&token=46147eab-f858-49dd-b384-28e469e39ad1){kind=link}
.png?alt=media&token=f4987c3f-cbe6-40d3-908d-67ab1e4a3059){kind=link}
.PNG?alt=media&token=5c67e45b-c4a0-41b6-b599-000ac45e779d)
.png?alt=media&token=ed86d588-236a-4a23-8755-8fc2d3a4d81c)
