POST
/
cost
/
roi
Calculate ROI for cost sheet
curl --request POST \
  --url https://api.cloud.flexprice.io/v1/cost/roi \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "meter_id": "<string>",
  "period_end": "<string>",
  "period_start": "<string>",
  "price_id": "<string>",
  "subscription_id": "<string>"
}'
{
  "cost": 123,
  "cost_breakdown": [
    {
      "cost": 123,
      "meter_id": "<string>",
      "meter_name": "<string>",
      "usage": 123
    }
  ],
  "markup": 123,
  "markup_percentage": 123,
  "net_margin": 123,
  "net_margin_percentage": 123,
  "net_revenue": 123,
  "revenue": 123
}

Authorizations

x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Body

application/json

ROI calculation request

subscription_id
string
required

SubscriptionID is required to get subscription details

meter_id
string

MeterID references the meter to track usage

period_end
string
period_start
string

Optional time range. If not provided, uses entire subscription period

price_id
string

PriceID references the price configuration

Response

OK

cost
number

Cost and Revenue

cost_breakdown
object[]

Cost breakdown by meter

markup
number

Markup (Revenue - Cost / Cost)

markup_percentage
number
net_margin
number

Net Margin (ROI)

net_margin_percentage
number
net_revenue
number

Net Revenue (Revenue - Cost)

revenue
number