View as Markdown Open in Claude Open in ChatGPT

Platform API

The Seamless OS Platform API for a partner or a backend: billing, subscriptions, payments, and telecom services

With the Seamless OS Platform API your backend sells telecom services, manages customers, and bills them. An application that acts for one signed-in user calls the End-User API instead. The pages that follow cover the integration styles, the API conventions, and the customer journey from an order to an invoice.

Getting started

Get started

Place your first order with the API.

Choose your integration

Pick the integration style that fits your business model.

API fundamentals

Conventions

The design principles and the naming patterns of the API.

Authentication

API keys, user tokens, and how to keep them safe.

Errors

The structure of an error response, and what each status code means.

Rate limiting

The request limits, and how to retry when you reach one.

Browse the endpoints

AuthAuthenticate users and obtain access tokens.CustomersManage customers.InventoryManage phone number inventory, SIM cards, and reservations.InvoicesInspect invoice payments and their provider lifecycle.LicensesManage licenses.OrdersManage orders and line items.Payment IntentsInspect the amounts the platform is collecting, including attempts, refunds, and billed items.Payment LinksCreate and manage payment links for orders and invoices.Payment Profile SessionsCreate sessions for setting up payment profiles.Payment ProfilesManage customer payment profiles and methods.Payment SessionsCreate and manage payment sessions for orders.PortingManage number porting for subscriptions.Product CatalogsBrowse product catalogs.Product DiscountsDiscounts and promotions.Product OfferingsBrowse product offerings.ReportsRetrieve generated reports and download their files.SubscribersManage subscribers.Subscription ActionsInspect scheduled and completed subscription actions.Subscription AddonsManage subscription addons.Subscription UsageGet subscription usage.SubscriptionsManage subscriptions and subscription.ToolsTools for address validation, number porting, device info, and network coverage.UsersManage users.WorkflowsDynamic processing of customer journeys and events.Webhook eventsEvery event the API sends, grouped by the resource that emits it.SchemasEvery request, response and webhook payload schema in the API.