Breaking changes
GET /subscriptionsis now paginated. The response is no longer a bare array but a{ data, meta }envelope (seePaginatedSubscriptions). Use thepage(default1) andlimit(default10, max20) query parameters and iterate whilemeta.hasNextistrue.GET /planswithout filters (or withpage/limit) returns a paginated{ data, meta }envelope.- Path parameters are now documented as real path segments
(
/esims/{esimID}instead of/esims/:esimIDwith a query parameter). The URLs called are unchanged. - Field names:
Esim.matchingId(previously documented asmatchingID) andPrice.minorUnitsExponent(previously documented asminorExponentUnits). - All
POSTendpoints return201 Created(previously documented as200). - Unknown request properties (body or query) are rejected with
400. - New Subscription status
CANCEL_PENDING: cancellation is now asynchronous (seePOST /subscriptions/{subscriptionID}/cancel). - Cancelling an Order that was
PROCESSINGorFAILEDmoves it to the new statusREFUNDED(notCANCELLED).REFUNDEDOrders can no longer be cancelled, and cancelling anIN_BASKETOrder removes it. GET /plansaccepts at mostlimit=1000.POST /plans/searchwithoutpayloadis rejected with400.- Orders are paid the way your Account's billing is set up, not as
the request chooses:
POST /v2/ordersno longer takes a payment method (see Create an Order). An Account that is not set up to order through the API is refused withPAYMENT_METHOD_NOT_ALLOWED. - An Advance Pay wallet that was never funded is refused with
INSUFFICIENT_BALANCE(previouslyWallet not found for customer), and a refused order no longer leaves aPENDINGOrder behind.
Deprecations — deprecated endpoints keep working until their sunset date and return the headers Deprecation: true, Sunset: Thu, 31 Dec 2026 23:59:59 GMT and Link: <successor>; rel="successor-version".
POST /orders/with-wallet→POST /v2/ordersDELETE /subscriptions/{subscriptionID}→POST /subscriptions/{subscriptionID}/cancelGET /plans/{iso3}/local→GET /plans?destination={iso3}&scope=LOCALGET /plans/{iso3}/local/regular→GET /plans?destination={iso3}&scope=LOCAL&category=REGULARGET /plans/{iso3}/local/unlimited→GET /plans?destination={iso3}&scope=LOCAL&category=UNLIMITEDGET /destinations/supported_destinationsis kept as an alias ofGET /destinations/supported-destinations(not deprecated).
New
POST /v2/orders— unified order creation, one-off and top-up, paid per your Account's billing.POST /plans/search/domestic— UK domestic plans.GET /plans,GET /plans/details/{planID}.GET /esims/{esimID}/config,GET /esims/{esimID}/qrcode-url.GET /subscriptions/{subscriptionID}/compatible-plans(top-up plan discovery).