Do not miss any eSIM API changes, ever again

Subscribe to the eSIM API changelog to be up to date on recent changes.

RSS

Changelog

Last update:
Compare
1 structure change including:
1 Modification
Modified 1 Breaking
POST /v2/orders
  • Body
  • application/json content type Modified
    • paymentMethod, quantity properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
3 structure changes including:
3 Modifications
Modified 3 Breaking
GET /plans
  • Query
  • searchProfile query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /plans/search
  • Body
  • application/json content type Modified
    • payload property Modified
      • searchProfile, recurring properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /plans/search/domestic
  • Body
  • application/json content type Modified
    • searchProfile property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
5 structure changes including:
5 Breaking changes
5 Removals
Removed 5 Breaking
DELETE /accounts/{accountID}/api-keys/{keyID}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /accounts/{accountID}/api-keys
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /accounts/{accountID}/api-keys
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /stripe/helpers/cancel-domestic-subscription-item
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /stripe/helpers/create-domestic-subscription-item
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
33 structure changes including:
6 Breaking changes
18 Additions
13 Modifications
2 Removals
Modified 13 Breaking
GET /destinations/supported_destinations
  • Response
  • 200 response Modified
    • application/json content type Modified
      • regions, scopes properties Added
  • Authentication
  • Oauth2 & App identifier authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • App identifier authentication method Added
GET /destinations/{iso3}
  • Path went from /destinations/:iso3 to /destinations/{iso3} (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • regions property Added
  • 404 response Added
  • Query
  • iso3 query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Authentication
  • Oauth2 & App identifier authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • App identifier authentication method Added
  • Path
  • iso3 path parameter Added
POST /plans/search
  • Response
  • 200 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 201, 400 responses Added
  • Authentication
  • Oauth2 & App identifier authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • App identifier authentication method Added
  • Body
  • application/json content type Added
POST /orders/with-wallet
  • Operation is now deprecated
  • Body
  • application/json content type Modified
    • planID property Modified
      • Property is now required
    • accountID, quantity properties Removed
    • activationDate property Added
  • Response
  • 200 response Removed
  • 201, 400 responses Added
GET /subscriptions/{subscriptionID}/activity/latest
  • Path went from /subscriptions/:subscriptionID/activity/latest to /subscriptions/{subscriptionID}/activity/latest (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Type went from object to object | null
      • lastUpdatedAt property Modified
        • Type went from number to string(date-time)
          Breaking
  • 401, 404 responses Added
  • Query
  • subscriptionID query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Path
  • subscriptionID path parameter Added
GET /subscriptions/{subscriptionID}
  • Path went from /subscriptions/:subscriptionID to /subscriptions/{subscriptionID} (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • iccid, matchingID, smdpPlus, msisdn, qrCodeLink properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • esimID, planID, orderID, userID, accountID, expirationDate, createdAt, plan, activity, cancelAtPeriodEnd, cancelEffectiveDate properties Added
  • 401, 404 responses Added
  • Query
  • subscriptionID query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Path
  • subscriptionID path parameter Added
GET /subscriptions
  • Path went from /subscriptions/ to /subscriptions (same operationId)
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Type went from array[object] to object
        Breaking
      • data, meta properties Added
  • 400, 401, 403 responses Added
  • Query
  • page, limit, accountNanoID, userNanoID, status, includeActivity query parameters Added
GET /plans/{iso3}/local/unlimited
  • Operation is now deprecated
  • Response
  • 200 response Modified
    • application/json content type Modified
      • destination property Modified
        • regions, scopes properties Added
      • prices property Modified
        • minorExponentUnits property Removed
        • minorUnitsExponent, discountedFrom properties Added
      • name, scope, category, type, isRecurring, recurringInterval, createdAt properties Added
  • Authentication
  • Oauth2 & App identifier authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • App identifier authentication method Added
GET /plans/{iso3}/local/regular
  • Operation is now deprecated
  • Response
  • 200 response Modified
    • application/json content type Modified
      • destination property Modified
        • regions, scopes properties Added
      • prices property Modified
        • minorExponentUnits property Removed
        • minorUnitsExponent, discountedFrom properties Added
      • name, scope, category, type, isRecurring, recurringInterval, createdAt properties Added
  • Authentication
  • Oauth2 & App identifier authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • App identifier authentication method Added
GET /plans/{iso3}/local
  • Operation is now deprecated
  • Response
  • 200 response Modified
    • application/json content type Modified
      • regular property Modified
        • destination, prices properties Modified
        • name, scope, category, type, isRecurring, recurringInterval, createdAt properties Added
      • unlimited property Modified
        • destination, prices properties Modified
        • name, scope, category, type, isRecurring, recurringInterval, createdAt properties Added
  • Authentication
  • Oauth2 & App identifier authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • App identifier authentication method Added
GET /orders
  • Response
  • 200 response Modified
    • application/json content type Modified
      • plan property Modified
        • destination, prices properties Modified
        • name, scope, category, type, isRecurring, recurringInterval, createdAt properties Added
      • subscription property Modified
        • plan property Modified
        • planID, orderID, userID, accountID, expirationDate, createdAt, activity, cancelAtPeriodEnd, cancelEffectiveDate properties Added
      • paymentID, paymentReference, updatedAt properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
  • 401, 403 responses Added
GET /esims/{esimID}
  • Path went from /esims/:esimID to /esims/{esimID} (same operationId)
    Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • matchingId property Modified
        • Name went from matchingID to matchingId
          Breaking
      • userID, accountID, providerID, subscriptions properties Added
  • 401, 404 responses Added
  • Query
  • esimID query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Path
  • esimID path parameter Added
GET /esims
  • Response
  • 200 response Modified
    • application/json content type Modified
      • matchingId property Modified
        • Name went from matchingID to matchingId
          Breaking
      • userID, accountID, providerID, subscriptions properties Added
  • 401, 403 responses Added
  • Query
  • userNanoID, iccid query parameters Added
Removed 2 Breaking
DELETE /orders/:orderID
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /subscriptions/:subscriptionID
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 18
POST /v2/orders
App identifierauthentication method
DELETE /accounts/{accountID}/api-keys/{keyID}
DELETE /orders/{orderID}
DELETE /subscriptions/{subscriptionID}
GET /accounts/{accountID}/api-keys
GET /destinations/supported-destinations
GET /esims/{esimID}/config
GET /esims/{esimID}/qrcode-url
GET /orders/{orderID}
GET /plans
GET /plans/details/{planID}
GET /subscriptions/{subscriptionID}/compatible-plans
POST /accounts/{accountID}/api-keys
POST /plans/search/domestic
POST /stripe/helpers/cancel-domestic-subscription-item
POST /stripe/helpers/create-domestic-subscription-item
POST /subscriptions/{subscriptionID}/cancel
1 structure change including:
1 Modification
Modified 1
POST /orders/with-wallet
  • Body
  • application/json content type Modified
    • orderType, subscriptionID properties Added
2 structure changes including:
2 Breaking changes
2 Modifications
Modified 2 Breaking
DELETE /orders/:orderID
  • Path went from /orders/:orderID/cancel to /orders/:orderID (same operationId)
    Breaking
DELETE /subscriptions/:subscriptionID
  • Path went from /subscriptions/:subscriptionID/cancel to /subscriptions/:subscriptionID (same operationId)
    Breaking
1 structure change including:
1 Modification
Modified 1 Breaking
POST /orders/with-wallet
  • Body
  • application/json content type Modified
    • userNanoIDs property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • usersIDs property Added
17 structure changes including:
1 Breaking change
5 Additions
11 Modifications
1 Removal
Modified 11 Breaking
POST /plans/search
  • Authentication
  • Oauth2 authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Oauth2 & App identifier authentication method Added
POST /orders/with-wallet
  • Authentication
  • Oauth2 authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Oauth2 & App identifier authentication method Added
GET /subscriptions/:subscriptionID/activity/latest
  • Authentication
  • Oauth2 authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Oauth2 & App identifier authentication method Added
GET /subscriptions/:subscriptionID
  • Authentication
  • Oauth2 authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Oauth2 & App identifier authentication method Added
DELETE /orders/:orderID/cancel
  • Authentication
  • Oauth2 authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Oauth2 & App identifier authentication method Added
DELETE /subscriptions/:subscriptionID/cancel
  • Authentication
  • Oauth2 authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Oauth2 & App identifier authentication method Added
GET /destinations/:iso3
  • Authentication
  • Oauth2 authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Oauth2 & App identifier authentication method Added
GET /destinations/supported_destinations
  • Authentication
  • Oauth2 authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Oauth2 & App identifier authentication method Added
GET /esims
  • Authentication
  • Oauth2 authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Oauth2 & App identifier authentication method Added
GET /esims/:esimID
  • Authentication
  • Oauth2 authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Oauth2 & App identifier authentication method Added
GET /subscriptions/
  • Authentication
  • Oauth2 authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Oauth2 & App identifier authentication method Added
Removed 1 Breaking
Oauth2authentication method
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 5
GET /plans/{iso3}/local/unlimited
GET /plans/{iso3}/local/regular
GET /plans/{iso3}/local
GET /orders
Oauth2 & App identifierauthentication method
2 structure changes including:
2 Additions
Added 2
DELETE /orders/:orderID/cancel
DELETE /subscriptions/:subscriptionID/cancel
1 structure change including:
1 Modification
Modified 1
POST /orders/with-wallet
  • Response
  • 200 response Added
1 structure change including:
1 Modification
Modified 1
POST /orders/with-wallet
  • Body
  • application/json content type Modified
    • quantity property Added
8 structure changes including:
1 Addition
7 Modifications
Modified 7 Breaking
GET /destinations/:iso3
  • Response
  • 2XX response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 200 response Added
GET /destinations/supported_destinations
  • Response
  • 2XX response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 200 response Added
GET /esims
  • Response
  • 2XX response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 200 response Added
GET /esims/:esimID
  • Response
  • 2XX response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 200 response Added
GET /subscriptions/
  • Response
  • 2XX response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 200 response Added
GET /subscriptions/:subscriptionID
  • Response
  • 2XX response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 200 response Added
POST /plans/search
  • Response
  • 2XX response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 200 response Added
Added 1
GET /subscriptions/:subscriptionID/activity/latest
5 structure changes including:
4 Additions
1 Modification
Modified 1 Breaking
POST /plans/search
  • Response
  • 2XX response Modified
    • application/json content type Modified
      • nanoID property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • id property Added
Added 4
GET /esims
GET /esims/:esimID
GET /subscriptions/
GET /subscriptions/:subscriptionID