subscription_mrr_snapshot
Description
An MRR snapshot captures pre-aggregated daily subscription metrics for a store. One row is generated per store per day, representing end-of-day state in the store's configured timezone. These snapshots power MRR/ARR dashboards and trend analysis without requiring expensive real-time queries.
All monetary amounts are in the store's configured currency. MRR values are normalized to a monthly equivalent based on each subscription's billing frequency.
Snapshots are read-only and are generated automatically by a nightly job. Access snapshots for a store: GET /stores/{id}/subscription_mrr_snapshots.
Interact with this resource
To interact with this resource and see it in the context of the API, you can utilise Postman or your Terminal/Console to perform requests. If you have a Foxy store, you can also use the API browser in the admin to interact with resources connected to your store.
Actions
- GET
- View a subscription_mrr_snapshot
- HEAD
- Get just the header response
- OPTIONS
- Get a response explaining which HTTP methods are supported
Properties
| Property | Description | Type | Constraints |
|---|---|---|---|
| snapshot_date | The date this snapshot represents, in the store's configured timezone. | Date | Read only. YYYY-MM-DD format. |
| active_count | Total number of active subscriptions at end of day. | Integer | Read only. |
| new_count | Number of new subscriptions created on this day. | Integer | Read only. |
| cancelled_count | Number of subscriptions cancelled or auto-cancelled on this day. | Integer | Read only. |
| past_due_count | Number of active subscriptions with a past-due amount greater than zero at end of day. | Integer | Read only. |
| mrr | Total Monthly Recurring Revenue from all active subscriptions at end of day, normalized to a monthly equivalent. | Decimal | Read only. |
| new_mrr | MRR added from subscriptions created on this day. | Decimal | Read only. |
| churned_mrr | MRR lost from subscriptions cancelled on this day. | Decimal | Read only. |
| expansion_mrr | MRR gained from subscription amount increases (upgrades) on this day. | Decimal | Read only. |
| contraction_mrr | MRR lost from subscription amount decreases (downgrades) on this day. | Decimal | Read only. |
| net_new_mrr | Net change in MRR: new_mrr minus churned_mrr plus expansion_mrr minus contraction_mrr. | Decimal | Read only. |
| collected_amount | Total amount successfully collected from subscription transactions on this day. | Decimal | Read only. |
| failed_amount | Total amount from subscription transactions that failed collection on this day. | Decimal | Read only. |
| past_due_total | Total cumulative past-due balance across all active subscriptions at end of day. | Decimal | Read only. |
| dunning_reattempts | Number of automated dunning reattempt billing attempts on this day. | Integer | Read only. |
| dunning_recovered_count | Number of subscriptions where a dunning reattempt succeeded on this day. | Integer | Read only. |
| dunning_recovered_amount | Revenue recovered via successful dunning reattempts on this day. | Decimal | Read only. |
| dunning_emails_sent | Number of dunning/reminder emails sent to customers on this day. | Integer | Read only. |
| dunning_auto_cancelled | Number of subscriptions automatically cancelled by the dunning system on this day. | Integer | Read only. |
| details | Optional JSON object with additional metric breakdowns (e.g., by frequency, product category, or payment method). Null if no additional breakdowns were computed. Rows backfilled from historical data will include {"backfilled": true}. |
Object (JSON) | Read only. |
| date_created | The date this snapshot record was created. | DateTime | Read only. |
Example Representation
{
"_links": {
"curies": [
{
"name": "fx",
"href": "https://api.foxycart.com/rels/{rel}",
"templated": true
}
],
"self": {
"href": "https://api.foxycart.com/subscription_mrr_snapshots/7890",
"title": "This MRR Snapshot"
},
"fx:store": {
"href": "https://api.foxycart.com/stores/8",
"title": "This Store"
}
},
"snapshot_date": "2026-03-18",
"active_count": 342,
"new_count": 5,
"cancelled_count": 2,
"past_due_count": 12,
"mrr": 8450.00,
"new_mrr": 125.00,
"churned_mrr": 49.99,
"expansion_mrr": 20.00,
"contraction_mrr": 5.00,
"net_new_mrr": 90.01,
"collected_amount": 3210.50,
"failed_amount": 199.98,
"past_due_total": 599.94,
"dunning_reattempts": 3,
"dunning_recovered_count": 2,
"dunning_recovered_amount": 99.98,
"dunning_emails_sent": 4,
"dunning_auto_cancelled": 0,
"details": null,
"date_created": "2026-03-19T01:00:00-0700"
}
Zoomable Resources
This resource has no linked resources which can be "zoomed" in on, filtered and embedded within this resource.