Dedicated Rentals

Browse available rentals (public)

No authentication required. Merges live slot inventory with catalog pricing so you can browse both Full Access and Platform rentals by country before creating an account.

Availability is banded for anonymous callers. Where the supply is our own SIM estate, an unauthenticated response carries availability (in_stock, low_stock or out_of_stock) per country and total_availability for the whole response, instead of the integer available_count / total_available. The band answers "can I rent this right now" completely.

Send a valid X-API-Key to receive integers. Counts of our own supply are then capped at 50 per country, with stock_capped: true set when the cap applied, and total_available is the sum of the capped values. Supplier-sourced supply (?provider=network) is not affected and always returns exact counts.

get/api/v1/rentals/available

Request

  • Base URL: https://virtualsms.io
  • URL: https://virtualsms.io/api/v1/rentals/available
  • Auth: none required

Query parameters

countrystring

ISO 3166-1 alpha-2 country code filter

Response

Available rentals for the given country (or all countries if omitted)

countriesobject[]
total_availableinteger

Sum of the per-country counts, capped. Present only for API-key callers; anonymous responses carry total_availability instead.

total_availability'in_stock' | 'low_stock' | 'out_of_stock'

Coarse band for the whole response. Present only for anonymous callers, in place of total_available.

stock_cappedboolean

True when the 50-per-country cap changed a returned figure.

Changes

No recorded changes to this operation across all 1 revision of this API.