Dedicated Rentals

Create a dedicated rental (Full Access or Platform tier)

Creates a Full Access or Platform-tier dedicated rental (distinct from the one-time POST /api/v1/orders activation above). rental_type=full uses local inventory and works for any service for the whole duration; rental_type=service (Platform tier) locks the number to one service, sourced via our global supplier network, for the chosen duration — with an early-cancel refund window right after purchase.

Browse availability first at GET /api/v1/rentals/available (public, no auth) and confirm price at GET /api/v1/rentals/price or /api/v1/rentals/pricing.

post/api/v1/rentals

Request

Base URL: https://virtualsms.io
URL: https://virtualsms.io/api/v1/rentals
Auth: API key in header X-API-Key

Request body

countrystring required

servicestring

Required when rental_type=service (Platform tier)

rental_type'full' | 'service' required

duration_hours24 | 168 | 720 | 2160 required

24=1 day, 168=7 days, 720=30 days, 2160=90 days

auto_renewboolean

Example request

{
  "country": "US",
  "service": "whatsapp",
  "rental_type": "full",
  "duration_hours": 24
}

Response

Rental created

object required

Changes

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