API Reference

Home API Reference

Getting started

API Reference Get started Choose your integration

Guides

Travel eSIM Orders & Payments

Overview

Conventions Authentication Errors Idempotency Rate limiting Webhooks

Developer guide

Intro to Seamless OS Place an order Order fulfillment Payment processing Product management Customer self-service

API reference

Auth

POST/auth/email/start POST/auth/email/verify

Customers

GET/customers POST/customers GET/customers/{customerId}PUT/customers/{customerId}GET/customers/{customerId}/product-catalog DELETE/customers/{customerId}/users

Inventory

POST/inventory/lease-numbers GET/inventory/sims/{iccid}

Invoices

GET/invoices GET/invoices/{invoiceId}POST/invoices/{invoiceId}/mark-paid

Licenses

GET/licenses POST/licenses GET/licenses/{licenseId}POST/licenses/{licenseId}/cancel PUT/licenses/{licenseId}/product-offering-change GET/licenses/{licenseId}/product-offering-options

Orders

GET/orders POST/orders GET/orders/{orderId}PUT/orders/{orderId}POST/orders/{orderId}/approve POST/orders/{orderId}/calculate-price POST/orders/{orderId}/cancel POST/orders/{orderId}/line-items PUT/orders/{orderId}/line-items/{lineItemId}DELETE/orders/{orderId}/line-items/{lineItemId}POST/orders/{orderId}/submit

Payment Intents

GET/payment-intents GET/payment-intents/{paymentIntentId}

Payment Links

GET/payment-links POST/payment-links GET/payment-links/{paymentLinkId}POST/payment-links/{paymentLinkId}/cancel

Payment Profile Sessions

POST/payment-profiles/sessions GET/payment-profiles/sessions/{paymentProfileSessionId}POST/payment-profiles/sessions/{paymentProfileSessionId}/cancel

Payment Profiles

GET/payment-profiles GET/payment-profiles/{paymentProfileId}DELETE/payment-profiles/{paymentProfileId}

Payment Sessions

POST/payment-sessions GET/payment-sessions/{paymentSessionId}POST/payment-sessions/{paymentSessionId}/cancel

Porting

GET/subscriptions/{subscriptionId}/in-porting POST/subscriptions/{subscriptionId}/in-porting

Product Catalogs

GET/product-catalogs

Product Discounts

GET/discounts/promotions/promo-code/{promoCode}

Product Offerings

GET/product-offerings GET/product-offerings/countries GET/product-offerings/{productOfferingId}

Subscribers

GET/subscribers GET/subscribers/{subscriberId}PUT/subscribers/{subscriberId}

Subscription Addons

GET/subscriptions/{subscriptionId}/addons POST/subscriptions/{subscriptionId}/addons POST/subscriptions/{subscriptionId}/addons/cancel PUT/subscriptions/{subscriptionId}/addons/product-offering-change GET/subscriptions/{subscriptionId}/addons/product-offering-options

Subscription Usage

GET/subscriptions/usage GET/subscriptions/{subscriptionId}/usage

Subscriptions

GET/subscriptions POST/subscriptions GET/subscriptions/{subscriptionId}POST/subscriptions/{subscriptionId}/activate POST/subscriptions/{subscriptionId}/cancel POST/subscriptions/{subscriptionId}/change-icc GET/subscriptions/{subscriptionId}/esim/qrcode GET/subscriptions/{subscriptionId}/in-porting POST/subscriptions/{subscriptionId}/in-porting POST/subscriptions/{subscriptionId}/pause PUT/subscriptions/{subscriptionId}/product-offering-change GET/subscriptions/{subscriptionId}/product-offering-options POST/subscriptions/{subscriptionId}/restore POST/subscriptions/{subscriptionId}/suspend

Taxes

POST/taxes/calculate

Tools

POST/tools/check-network-coverage POST/tools/check-porting-eligibility POST/tools/get-device-info POST/tools/validate-address

Users

GET/users POST/users GET/users/{userId}PUT/users/{userId}

Workflows

POST/workflows/webhook/{path...}

Webhooks

Custom

custom.workflow_triggered

Customers

customer.created customer.deleted customer.updated

Licenses

license.activated license.cancelled license.created license.ended license.renewed license.updated

Orders

order.cancelled order.created order.expired order.lineItemStatusChanged order.statusChanged order.submitted order.updated

Subscription Port-In

subscription.portIn.completed subscription.portIn.created subscription.portIn.failed subscription.portIn.updated

Subscription Usage

subscription.quotaNotification

Subscriptions

subscription.activated subscription.cancelled subscription.created subscription.ended subscription.renewed subscription.subscriber_set subscription.updated

Getting started

API Reference Get started Choose your integration

Guides

Travel eSIM Orders & Payments

Overview

Conventions Authentication Errors Idempotency Rate limiting Webhooks

Developer guide

Intro to Seamless OS Place an order Order fulfillment Payment processing Product management Customer self-service

API reference

Auth

POST/auth/email/start POST/auth/email/verify

Customers

GET/customers POST/customers GET/customers/{customerId}PUT/customers/{customerId}GET/customers/{customerId}/product-catalog DELETE/customers/{customerId}/users

Inventory

POST/inventory/lease-numbers GET/inventory/sims/{iccid}

Invoices

GET/invoices GET/invoices/{invoiceId}POST/invoices/{invoiceId}/mark-paid

Licenses

GET/licenses POST/licenses GET/licenses/{licenseId}POST/licenses/{licenseId}/cancel PUT/licenses/{licenseId}/product-offering-change GET/licenses/{licenseId}/product-offering-options

Orders

GET/orders POST/orders GET/orders/{orderId}PUT/orders/{orderId}POST/orders/{orderId}/approve POST/orders/{orderId}/calculate-price POST/orders/{orderId}/cancel POST/orders/{orderId}/line-items PUT/orders/{orderId}/line-items/{lineItemId}DELETE/orders/{orderId}/line-items/{lineItemId}POST/orders/{orderId}/submit

Payment Intents

GET/payment-intents GET/payment-intents/{paymentIntentId}

Payment Links

GET/payment-links POST/payment-links GET/payment-links/{paymentLinkId}POST/payment-links/{paymentLinkId}/cancel

Payment Profile Sessions

POST/payment-profiles/sessions GET/payment-profiles/sessions/{paymentProfileSessionId}POST/payment-profiles/sessions/{paymentProfileSessionId}/cancel

Payment Profiles

GET/payment-profiles GET/payment-profiles/{paymentProfileId}DELETE/payment-profiles/{paymentProfileId}

Payment Sessions

POST/payment-sessions GET/payment-sessions/{paymentSessionId}POST/payment-sessions/{paymentSessionId}/cancel

Porting

GET/subscriptions/{subscriptionId}/in-porting POST/subscriptions/{subscriptionId}/in-porting

Product Catalogs

GET/product-catalogs

Product Discounts

GET/discounts/promotions/promo-code/{promoCode}

Product Offerings

GET/product-offerings GET/product-offerings/countries GET/product-offerings/{productOfferingId}

Subscribers

GET/subscribers GET/subscribers/{subscriberId}PUT/subscribers/{subscriberId}

Subscription Addons

GET/subscriptions/{subscriptionId}/addons POST/subscriptions/{subscriptionId}/addons POST/subscriptions/{subscriptionId}/addons/cancel PUT/subscriptions/{subscriptionId}/addons/product-offering-change GET/subscriptions/{subscriptionId}/addons/product-offering-options

Subscription Usage

GET/subscriptions/usage GET/subscriptions/{subscriptionId}/usage

Subscriptions

GET/subscriptions POST/subscriptions GET/subscriptions/{subscriptionId}POST/subscriptions/{subscriptionId}/activate POST/subscriptions/{subscriptionId}/cancel POST/subscriptions/{subscriptionId}/change-icc GET/subscriptions/{subscriptionId}/esim/qrcode GET/subscriptions/{subscriptionId}/in-porting POST/subscriptions/{subscriptionId}/in-porting POST/subscriptions/{subscriptionId}/pause PUT/subscriptions/{subscriptionId}/product-offering-change GET/subscriptions/{subscriptionId}/product-offering-options POST/subscriptions/{subscriptionId}/restore POST/subscriptions/{subscriptionId}/suspend

Taxes

POST/taxes/calculate

Tools

POST/tools/check-network-coverage POST/tools/check-porting-eligibility POST/tools/get-device-info POST/tools/validate-address

Users

GET/users POST/users GET/users/{userId}PUT/users/{userId}

Workflows

POST/workflows/webhook/{path...}

Webhooks

Custom

custom.workflow_triggered

Customers

customer.created customer.deleted customer.updated

Licenses

license.activated license.cancelled license.created license.ended license.renewed license.updated

Orders

order.cancelled order.created order.expired order.lineItemStatusChanged order.statusChanged order.submitted order.updated

Subscription Port-In

subscription.portIn.completed subscription.portIn.created subscription.portIn.failed subscription.portIn.updated

Subscription Usage

subscription.quotaNotification

Subscriptions

subscription.activated subscription.cancelled subscription.created subscription.ended subscription.renewed subscription.subscriber_set subscription.updated