Interactive Playground credentials
Enter your Console OAuth credentials to test API requests in the playground below. Select OmaxTelecom Client Credentials as the auth identity before sending.
Plans
Data plan management. List available plans, get plan details, view coverage, and explore regions.
Plans can be global (available to all organizations) or org-specific (custom pricing). Global plans can exclude certain organizations via the excluded_organizations field.
Each plan includes enriched OmaxTelecom Core network data: data amount, validity, sponsor profile, coverage type, regions, and coverage summary.
List plans (combined filters)
List Plans (Combined Filters)
All plan filters can be combined. This example returns multi-country European plans with IR1 sponsor profile.
query Parameters
regionRegion code
coverage_typeCoverage type filter
sponsor_profileSponsor profile filter
Headers
AcceptList plans (combined filters) › Responses
Successful response
Get plan by ID
Get Single Plan
Returns detailed information about a specific plan. Only returns enabled plans that are accessible to your organization.
Same fields as the list response. Global plans that have an org-specific copy (same provider_plan_id) are hidden.
Path Parameter:
| Parameter | Type | Description |
|---|---|---|
id | uuid | Plan UUID |
Response:
Code
Errors:
404 NOT_FOUND– Plan not found (or disabled/excluded for your org)
path Parameters
plan_idHeaders
AcceptGet plan by ID › Responses
Successful response
Get plan coverage
Get Plan Coverage
Returns the full detailed coverage for a specific plan — all countries and their operators with network types.
Use this for displaying a detailed coverage map. For a quick summary, use the coverage field in GET /v1/plans or GET /v1/plans/{id}.
Path Parameter:
| Parameter | Type | Description |
|---|---|---|
id | uuid | Plan UUID |
Response:
Code
Errors:
404 NOT_FOUND– Plan not found (or disabled/excluded for your org)
path Parameters
plan_idHeaders
AcceptGet plan coverage › Responses
Successful response
Get coverage regions
Get Coverage Regions
Returns all available coverage regions with their codes and display labels. Use region codes to filter plans via GET /v1/plans?region=EU.
Response:
Code
Notes:
- Region codes are:
EU,AF,AS,LA,NA,OC - Each region contains a predefined set of ISO 3166-1 alpha-2 country codes
- A plan matches a region if at least one of its coverage countries belongs to that region
Headers
AcceptGet coverage regions › Responses
Successful response