API structure has changed
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
-
application/json content type Modified
- Authentication
-
Oauth2 & App identifier authentication method Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
- App identifier authentication method Added
GET /destinations/{iso3}
- Path went from
/destinations/:iso3to/destinations/{iso3}(same operationId)Breaking - Response
-
200 response Modified
-
application/json content type Modified
- regions property Added
-
application/json content type Modified
- 404 response Added
- Query
-
iso3 query parameter Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
- Authentication
-
Oauth2 & App identifier authentication method Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
- 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
-
Removing a resource is always breaking unless it was deprecated before
- 201, 400 responses Added
- Authentication
-
Oauth2 & App identifier authentication method Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
- 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
-
planID property Modified
- Response
- 200 response Removed
- 201, 400 responses Added
GET /subscriptions/{subscriptionID}/activity/latest
- Path went from
/subscriptions/:subscriptionID/activity/latestto/subscriptions/{subscriptionID}/activity/latest(same operationId)Breaking - Response
-
200 response Modified
-
application/json content type Modified
-
Type went from
objecttoobject | null
-
lastUpdatedAt property Modified
-
Type went from
numbertostring(date-time)Breaking
-
Type went from
-
Type went from
-
application/json content type Modified
- 401, 404 responses Added
- Query
-
subscriptionID query parameter Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
- Path
- subscriptionID path parameter Added
GET /subscriptions/{subscriptionID}
- Path went from
/subscriptions/:subscriptionIDto/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
-
Removing a resource is always breaking unless it was deprecated before
- esimID, planID, orderID, userID, accountID, expirationDate, createdAt, plan, activity, cancelAtPeriodEnd, cancelEffectiveDate properties Added
-
iccid, matchingID, smdpPlus, msisdn, qrCodeLink properties Removed
-
application/json content type Modified
- 401, 404 responses Added
- Query
-
subscriptionID query parameter Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
- 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]toobjectBreaking
- data, meta properties Added
-
Type went from
-
application/json content type Modified
- 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
-
destination property Modified
-
application/json content type Modified
- Authentication
-
Oauth2 & App identifier authentication method Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
- 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
-
destination property Modified
-
application/json content type Modified
- Authentication
-
Oauth2 & App identifier authentication method Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
- 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
-
regular property Modified
-
application/json content type Modified
- Authentication
-
Oauth2 & App identifier authentication method Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
- 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
-
Removing a resource is always breaking unless it was deprecated before
-
plan property Modified
-
application/json content type Modified
- 401, 403 responses Added
GET /esims/{esimID}
- Path went from
/esims/:esimIDto/esims/{esimID}(same operationId)Breaking - Response
-
200 response Modified
-
application/json content type Modified
-
matchingId property Modified
-
Name went from
matchingIDtomatchingIdBreaking
-
Name went from
- userID, accountID, providerID, subscriptions properties Added
-
matchingId property Modified
-
application/json content type Modified
- 401, 404 responses Added
- Query
-
esimID query parameter Removed
-
Removing a resource is always breaking unless it was deprecated before Breaking
-
Removing a resource is always breaking unless it was deprecated before
- Path
- esimID path parameter Added
GET /esims
- Response
-
200 response Modified
-
application/json content type Modified
-
matchingId property Modified
-
Name went from
matchingIDtomatchingIdBreaking
-
Name went from
- userID, accountID, providerID, subscriptions properties Added
-
matchingId property Modified
-
application/json content type Modified
- 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