Retrieves a specific subscription by ID.
| Metric | Description |
|---|---|
acquisitionCost | What you paid for the asset |
listPrice | MSRP/retail price |
totalCollected | Total payments collected so far |
costRecoveryPercent | (Collected / Cost) × 100 |
breakevenMonth | Month when cost will be fully recovered |
monthsActive | How long subscription has been active |
monthsRemaining | Months until contract ends |
projectedTotalCollection | Expected total at contract end |
projectedMargin | Expected profit at contract end |
| Field | Description |
|---|---|
subscriptionId | Unique identifier |
status | Current status |
customerId | Customer ID |
orderId | Original order ID |
sku | Product variant SKU |
productName | Product display name |
serialNumber | Current asset serial number |
startDate | Contract start date |
endDate | Contract end date |
contractLength | Duration in months |
monthlyAmount | Monthly billing amount |
nextBillingDate | Next scheduled payment date |
billingGroupId | B2B billing group (if applicable) |
API key obtained from FlexPortal dashboard
Your tenant identifier
The subscription ID
Subscription details
active, cancelled, ended_completed, ended_buyout, ended_upgrade, ended_early_return variant, manual, order_override, estimated, unknown variant, manual, order_override, list_price, unknown profitable, recovering, at_risk, no_data