Skip to main content
POST
Export rentals to CSV

Overview

Export subscription data to CSV format. Use this for reporting, data analysis, or importing into external systems like spreadsheets or business intelligence tools.

Common Use Cases

Financial Reporting

Export data for revenue analysis and forecasting

Accounting Integration

Import subscription data into accounting software

Business Intelligence

Feed data into BI tools for advanced analytics

Compliance Audits

Generate reports for audit and compliance needs

Request Fields

Example: Export All Active Subscriptions

Example: Export by Date Range

Response

The response includes a download URL for the CSV file:

CSV Columns

The exported CSV includes:

Example: Monthly Revenue Report

Example: Customer Data Export

URL Expiration

Download URLs expire after a short period (typically 15-60 minutes). Download the file promptly after generation.

Large Exports

For very large exports:
  • Consider filtering by date range to reduce size
  • Export in batches by customer or time period
  • Monitor the recordCount to estimate file size

Authorizations

Authorization
string
header
required

API key obtained from FlexPortal dashboard

Headers

Tenant-ID
string
required

Your tenant identifier

Body

application/json
startDate
string<date-time>
endDate
string<date-time>
format
enum<string>
default:csv
Available options:
csv
includeFields
object
status
enum<string>
Available options:
active,
cancelled,
ended_completed,
ended_buyout,
ended_upgrade,
ended_early_return
customerIds
string[]

Response

Export generated

success
boolean
required
filename
string
required
csvData
string
required
totalRecords
number
required
generatedAt
string
required
filters
object
required
totalRentals
number
required
activeRentals
number
required
totalRevenue
number
required
averageMonthlyRevenue
number
required