Both permissions default to off. Enable them independently in your dashboard and use the same API key. Amounts are in USD cents.
Number rental
GET/api/v1/products
GET/api/v1/rental/catalog
GET/api/v1/rental/options?country=TR
POST/api/v1/rental/quotes
{"country":"TR","term":"30d"}
eSIM
GET/api/v1/esim/catalog
GET/api/v1/esim/options?location=TR
POST/api/v1/esim/quotes
{"packageCode":"PACKAGE_CODE","quantity":1}
Use a country and term returned by rental options. Add service for a service-specific rental. Send days for per-day eSIM packages. Use the returned quote to purchase either product.
Orders and tracking
POST/api/v1/{rental|esim}/orders
Idempotency-Key: order-0002
{"quote_id":"QUOTE_UUID","max_price_minor":550}
GET/api/v1/{rental|esim}/orders
GET/api/v1/{rental|esim}/orders/{id}
POST/api/v1/{rental|esim}/orders/{id}/refresh
POST/api/v1/rental/orders/{id}/cancel
Order details contain the rental SMS inbox or the eSIM installation profile. Check can_cancel before cancelling a rental.
Balance
GET/api/v1/balance
Available balance. 5000 cents = USD 50.00. Balances round down and quotes round up.
quote_id and max_price_minor are required. Send an 8–100 character Idempotency-Key unique to the order. After a network failure, retry with the same key and body.
Check your own order by ID. A null sms_code indicates no code is available. API orders retain their quoted USD price. Orders without a USD record return null for price. Timestamps use ISO 8601 UTC.
purchasing / waitingProcessing or waiting for SMS.
received / completedCode received or order completed.
reviewThe result is under review. Check the existing order before buying again.
refundedCharge refunded.
Send a new Idempotency-Key for each order. Reuse the key when retrying. With no code, cancellation opens after at least 180 seconds. A supplier may impose a later time. Webhooks are unavailable.
04
Errors and limits
Limit: 60 requests per minute per account. Purchase may return 201 for a new order, 200 for an existing or resolved order, or 202 for an order under review.