Skip to main content
GET
List subscriptions

Overview

Retrieve a paginated list of subscriptions with optional filtering and sorting. Each subscription tracks billing, payments, cost recovery, and the complete lifecycle from activation to completion.

Subscription Lifecycle

Subscriptions can end through several paths:
  • Contract completed: Reached end date naturally
  • Buyout: Customer purchased the device
  • Early return: Customer returned before contract end
  • Cancellation: Terminated by operator

Common Use Cases

Active Subscriptions Dashboard

Monitor active subscriptions, MRR, and contract renewals

Operations Management

Track devices in the field, upcoming end dates, and required actions

Customer Support

Look up customer subscriptions during support inquiries

Financial Reporting

Generate reports on revenue, cost recovery, and profitability

Filtering Subscriptions

Subscription Status Values

Response Fields

Key fields in each subscription object:

Cost Recovery Metrics

Each subscription includes profitability data:

Example: Find Subscriptions Ending Soon

Authorizations

Authorization
string
header
required

API key obtained from FlexPortal dashboard

Headers

Tenant-ID
string
required

Your tenant identifier

Query Parameters

limit
string

Items per page (default: 50, max: 100)

startAfter
string

Cursor for pagination

status
string

Filter by status (active, cancelled, ended_completed, ended_buyout, ended_upgrade, ended_early_return)

customerId
string

Filter by customer ID

orderId
string

Filter by order ID

serialNumber
string

Filter by asset serial number

Response

200 - application/json

List of subscriptions

rentals
object[]
required
count
number
required
limit
number
required
hasMore
boolean
required
nextCursor
string | null
required