v1.0.0 OpenAPI 3.0 All Systems Operational

Roambit API

Public and Authenticated API endpoints for the eSIM platform. Build powerful integrations with our comprehensive REST API.

OAuth 2.0
99.9% Uptime
Real-time Webhooks
190+ Countries
Base URL
https://api.roambit.io/api/v1
Bearer Token Authentication
56
API Endpoints
11
Categories
190+
Countries
24/7
Support
HTTP Methods
GET Retrieve data
POST Create resource
PUT Update resource
DELETE Remove resource

Quick Navigation

Public Authentication Orders & Usage eSIM Profiles Plans Credits Notifications Reseller Usage Insights User Profile Webhooks

Public

8 endpoints Operational
GET /health Health Check
POST /contact Contact Support
POST /auth/register Register Reseller
POST /auth/login Login (Reseller)
POST /auth/resend-verification Resend Verification
GET /auth/verify-email?token={token} Verify Email
POST /auth/forgot-password Forgot Password
POST /auth/reset-password Reset Password

Auth Helpers

4 endpoints Operational
POST /auth/refresh-token Refresh Token
POST /auth/logout Logout Session
GET /auth/sessions List Sessions
DELETE /auth/sessions/{sessionId} Terminate Session

Orders & Usage

7 endpoints Operational
POST /orders Create Order
GET /orders List Orders
GET /orders/{orderId} Get Order
GET /orders/{orderId}/usage Order Usage (v1)
POST /orders/{orderId}/usage/refresh Refresh Usage
GET /api/v2/order-usage/{orderId} Order Usage (v2)
POST /api/v2/order-usage/bulk Bulk Usage (v2)

eSIM Profiles

5 endpoints Operational
GET /profiles/{orderNumber} Get Profile
POST /profiles/{orderNumber}/suspend Suspend Profile
POST /profiles/{orderNumber}/unsuspend Unsuspend Profile
POST /profiles/{orderNumber}/revoke Revoke Profile
POST /profiles/{orderNumber}/topup Profile Top-up

Plans

5 endpoints Operational
GET /plans?limit=20&page=1 List Plans
GET /plans/{planId} Get Plan
GET /plans/countries Supported Countries
GET /plans/changes Plan Changes
GET /plans/stats/coverage Coverage Stats

Credits & Deposits

6 endpoints Operational
GET /credits/balance Credit Balance
GET /credits/transactions Transactions
POST /credits/topup Top-up Credits
POST /deposit/initiate Initiate Deposit
POST /deposit/capture Capture Deposit
GET /deposit/history Deposit History

Notifications

5 endpoints Testing
GET /orders/{orderId}/notifications List Notifications
POST /notifications Send Notification
GET /notification-preferences Get Preferences
PUT /notification-preferences Update Preferences
POST /notification-preferences/reset Reset Preferences

Reseller Profiles

6 endpoints Operational
GET /reseller/profile List Profiles
POST /reseller/profile Create Profile
PUT /reseller/profile/{profileId} Update Profile
GET /reseller/pricing Get Pricing
POST /reseller/pricing Pricing Override
GET /dashboard Reseller Dashboard

Usage Insights

3 endpoints Operational
GET /usage/balance/{providerId} Provider Balance
POST /usage/check Usage Check
GET /usage/order/{orderId} Usage By Order

User Profile

3 endpoints Operational
GET /users/me Get Current User
PUT /users/me Update Profile
PUT /users/me/password Change Password

Webhook Subscriptions

4 endpoints Operational
GET /webhook-subscriptions List Subscriptions
POST /webhook-subscriptions Create Subscription
PUT /webhook-subscriptions/{id} Update Subscription
DELETE /webhook-subscriptions/{id} Delete Subscription

Need Help Getting Started?

Our developer support team is here to help you integrate our API into your platform.

Contact Developer Support