subscription_mrr_snapshots

Resource: subscription_mrr_snapshot

This link relationship returns a collection of subscription mrr snapshots. You can paginate through this collection using the hypermedia links provided and the link relationships of first, prev, next, and last.

Required Scopes

Full store_full_access
Read subscriptions_read
Write subscriptions_write

Collection Resource

subscription_mrr_snapshot

Actions

GET View a list of subscription_mrr_snapshots
HEAD Get just the header response
OPTIONS Get a response explaining which HTTP methods are supported

Properties (5)

_embedded Object · Read-only

Contains fx:subscription_mrr_snapshots[] — array of subscription_mrr_snapshot resources

total_items String · Read-only

Total number of resources in this collection.

returned_items Number · Read-only

Number of resources returned in this page.

limit Number · Read-only

Maximum number of resources per page.

offset Number · Read-only

Number of resources skipped.

Link Relations (5)

self This Collection
first First Page of this Collection
prev Previous Page of this Collection
next Next Page of this Collection
last Last Page of this Collection
https://api.foxycart.com/stores/{store_id}/subscription_mrr_snapshots
Available via fx:subscription_mrr_snapshots on store

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/stores/123/subscription_mrr_snapshots",
      "title": "This Collection"
    },
    "first": {
      "href": "https://api.foxycart.com/stores/123/subscription_mrr_snapshots?offset=0",
      "title": "First Page of this Collection"
    },
    "prev": {
      "href": "https://api.foxycart.com/stores/123/subscription_mrr_snapshots?offset=0",
      "title": "Previous Page of this Collection"
    },
    "next": {
      "href": "https://api.foxycart.com/stores/123/subscription_mrr_snapshots?offset=20",
      "title": "Next Page of this Collection"
    },
    "last": {
      "href": "https://api.foxycart.com/stores/123/subscription_mrr_snapshots?offset=20",
      "title": "Last Page of this Collection"
    }
  },
  "_embedded": {
    "fx:subscription_mrr_snapshots": [
      {
        "_links": {
          "curies": [
            {
              "name": "fx",
              "href": "https://api.foxycart.com/rels/{rel}",
              "templated": true
            }
          ],
          "self": {
            "href": "https://api.foxycart.com/subscription_mrr_snapshots/456",
            "title": "This MRR Snapshot"
          },
          "fx:store": {
            "href": "https://api.foxycart.com/stores/456",
            "title": "This Store"
          }
        },
        "snapshot_date": "2026-03-18",
        "active_count": 342,
        "new_count": 5,
        "cancelled_count": 2,
        "past_due_count": 12,
        "mrr": 8450,
        "new_mrr": 125,
        "churned_mrr": 49.99,
        "expansion_mrr": 20,
        "contraction_mrr": 5,
        "net_new_mrr": 90.01,
        "collected_amount": 3210.5,
        "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"
      }
    ]
  },
  "total_items": 1,
  "returned_items": 1,
  "limit": 20,
  "offset": 0
}