Skip to Content
SaaSFlow
DevelopersAPIReferencestripe_mrr_comparisons

Retrieve stripe mrr comparison

Retrieve one MRR comparison run with a row per subscription. Each row carries the Stripe figure under each of Stripe's two discount settings, the reason…

Authentication

Checking whether you're signed in…
GET
/companies/{companyId}/stripe_mrr_comparisons/{id}

Authorization

headerAuthorization<token>

A SaaSFlow API key (format sf_…) or an OAuth bearer token. Paste only the key — the proxy adds the Bearer prefix. Create an API key in Settings → Company settings → API keys — see API keys.

Path Parameters

companyId*string
Formatuuid
id*string
Formatuuid

Response Body

The run, with its rows once it has succeeded.

application/json
  1. response
id*string
integrationId*string

The Stripe connection the run belongs to.

status*string

running until the subscriptions have been read from Stripe, then succeeded or failed. Only a succeeded run has rows.

Value in"running""succeeded""failed"
stripeAccountId*string
stripeMode*string
Value in"live""test"
calculationVersion*integer

The version of the calculation rules that produced the run.

saasflowCutoffTime*|

SaaSFlow MRR and cMRR are read as of this moment.

stripeCollectionStartedTime*|

When reading the subscriptions from Stripe started.

stripeCollectionFinishedTime*|

When reading the subscriptions from Stripe finished. The Stripe figures describe this moment.

subscriptionCount*integer|null
createdTime*string
rows*array<>|

One entry per subscription with a figure on either side, matching or not. Null until the run has succeeded.

Example Request
curl -X GET 'https://api.saasflow.com/companies/497f6eca-6276-4993-bfeb-53cbbbba6f08/stripe_mrr_comparisons/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
{  "id": "string",  "integrationId": "string",  "status": "running",  "stripeAccountId": "string",  "stripeMode": "live",  "calculationVersion": 0,  "saasflowCutoffTime": "string",  "stripeCollectionStartedTime": "string",  "stripeCollectionFinishedTime": "string",  "subscriptionCount": 0,  "createdTime": "string",  "rows": [    {      "stripeSubscriptionId": "string",      "stripeCustomerId": "string",      "customerName": "string",      "saasflowSubscriptionId": "string",      "saasflowCustomerId": "string",      "currency": "string",      "stripe": {        "state": "calculated",        "status": "string",        "exclusion": "trialing",        "unsupported": "tieredPricing",        "mrr": {          "undiscounted": 0,          "permanentOnly": 0,          "recurring": 0,          "oneTime": 0,          "both": 0        },        "hasUsageItems": true,        "approximateInterval": true,        "includedTaxShare": 0,        "cancelAt": "string",        "canceledAt": "string",        "trialEnd": "string",        "latestActivityAt": "string"      },      "saasflow": {        "mrr": 0,        "cmrr": 0,        "importedAt": "string"      }    }  ]}