flintDocs

Analytics

Analytics endpoints return pre-aggregated reporting data for your merchant account: summary metrics like gross and net volume, refunds, payment counts, and new customers; bucketed payment volume timeseries; and subscription metrics including MRR, ARR, and subscription status counts. All endpoints are read-only.

Queries take a range (today, last_7_days, last_30_days, last_90_days) and an optional timezone for bucket boundaries. A day range covers that many calendar days ending today, so last_7_days returns 7 daily buckets and today returns 24 hourly ones. The overview and timeseries endpoints can also include previous-period values and change percentages for comparison, and responses flag when multiple currencies are present so you can render per-currency breakdowns correctly.

Pass currency to the overview or timeseries endpoint to scope every amount and count to one currency. The currencies list and has_multiple_currencies still describe the whole window, so you can offer the other currencies as choices.

Note:

For per-event data instead of aggregates, use webhooks or list the underlying resources directly.

Get analytics overview#

GET/v1/analytics/overview

Requires scope analytics.read

Returns high-level merchant analytics for the requested time range.

Query parameters

rangeenumRequired

Requested analytics time range.

  • today
  • last_7_days
  • last_30_days
  • last_90_days
timezonestring

Optional IANA timezone, for example America/New_York.

include_previous_periodboolean

Include previous-period comparison metrics.

currencystring

Restricts amounts and counts to this currency. The currencies list still covers the whole window.

Response · 200

dataobjectRequired
metaobject
request_idstring
curl https://api.withflintpay.com/v1/analytics/overview \
  -H "Flint-Version: 2026-09-07" \
  -H "Authorization: Bearer YOUR_API_KEY"
JSON
{
  "data": {
    "active_subscriptions": {
      "change_percent": 8,
      "current_count": 27,
      "previous_count": 25
    },
    "average_payment": {
      "change_percent": -4.65,
      "current_money": {
        "amount": 2604,
        "currency": "USD"
      },
      "previous_money": {
        "amount": 2731,
        "currency": "USD"
      }
    },
    "currencies": [
      "USD"
    ],
    "gross_volume": {
      "change_percent": 11.61,
      "current_money": {
        "amount": 125000,
        "currency": "USD"
      },
      "previous_money": {
        "amount": 112000,
        "currency": "USD"
      }
    },
    "has_multiple_currencies": false,
    "net_volume": {
      "change_percent": 10.65,
      "current_money": {
        "amount": 119500,
        "currency": "USD"
      },
      "previous_money": {
        "amount": 108000,
        "currency": "USD"
      }
    },
    "new_customers": {
      "change_percent": 50,
      "current_count": 9,
      "previous_count": 6
    },
    "payments_count": {
      "change_percent": 17.07,
      "current_count": 48,
      "previous_count": 41
    },
    "range": "last_7_days",
    "refunds_total": {
      "change_percent": 37.5,
      "current_money": {
        "amount": 5500,
        "currency": "USD"
      },
      "previous_money": {
        "amount": 4000,
        "currency": "USD"
      }
    },
    "timezone": "America/New_York"
  },
  "request_id": "bce56cba-0827-44aa-bb56-4f200ba15ee6"
}

Get payment volume timeseries#

GET/v1/analytics/payment-volume-timeseries

Requires scope analytics.read

Returns merchant payment volume buckets for the requested time range.

Query parameters

rangeenumRequired

Requested analytics time range.

  • today
  • last_7_days
  • last_30_days
  • last_90_days
timezonestring

Optional IANA timezone, for example America/New_York.

include_previous_periodboolean

Include previous-period comparison buckets.

currencystring

Restricts bucket volumes and counts to this currency. The currencies list still covers the whole window.

Response · 200

dataobjectRequired
metaobject
request_idstring
curl https://api.withflintpay.com/v1/analytics/payment-volume-timeseries \
  -H "Flint-Version: 2026-09-07" \
  -H "Authorization: Bearer YOUR_API_KEY"
JSON
{
  "data": {
    "buckets": [
      {
        "label": "Mar 10",
        "payments_count": {
          "change_percent": 16.67,
          "current_count": 7,
          "previous_count": 6
        },
        "period_end": "2026-03-11T05:00:00Z",
        "period_start": "2026-03-10T05:00:00Z",
        "previous_volume_money": {
          "amount": 15000,
          "currency": "USD"
        },
        "volume_money": {
          "amount": 18000,
          "currency": "USD"
        }
      },
      {
        "label": "Mar 11",
        "payments_count": {
          "change_percent": 28.57,
          "current_count": 9,
          "previous_count": 7
        },
        "period_end": "2026-03-12T05:00:00Z",
        "period_start": "2026-03-11T05:00:00Z",
        "previous_volume_money": {
          "amount": 17000,
          "currency": "USD"
        },
        "volume_money": {
          "amount": 22000,
          "currency": "USD"
        }
      }
    ],
    "currencies": [
      "USD"
    ],
    "has_multiple_currencies": false,
    "range": "last_7_days",
    "timezone": "America/New_York"
  },
  "request_id": "bce56cba-0827-44aa-bb56-4f200ba15ee6"
}

Get subscription analytics#

GET/v1/analytics/subscriptions

Requires scope analytics.read

Returns windowed subscription metrics plus current subscription snapshot metrics.

Query parameters

rangeenumRequired

Requested analytics time range.

  • today
  • last_7_days
  • last_30_days
  • last_90_days
timezonestring

Optional IANA timezone, for example America/New_York.

Response · 200

dataobjectRequired
metaobject
request_idstring
curl https://api.withflintpay.com/v1/analytics/subscriptions \
  -H "Flint-Version: 2026-09-07" \
  -H "Authorization: Bearer YOUR_API_KEY"
JSON
{
  "data": {
    "range": "last_30_days",
    "snapshot_metrics": {
      "arr_by_currency": [
        {
          "amount": 1558800,
          "currency": "USD"
        }
      ],
      "mrr_by_currency": [
        {
          "amount": 129900,
          "currency": "USD"
        }
      ],
      "status_counts": {
        "active_count": 42,
        "canceled_count": 18,
        "incomplete_count": 4,
        "past_due_count": 3,
        "paused_count": 2,
        "trialing_count": 5
      }
    },
    "timezone": "America/New_York",
    "window_metrics": {
      "canceled_subscriptions": 3,
      "new_subscriptions": 14,
      "subscription_collected_money_by_currency": [
        {
          "amount": 485000,
          "currency": "USD"
        }
      ]
    }
  },
  "request_id": "bce56cba-0827-44aa-bb56-4f200ba15ee6"
}

Was this helpful?