subscription_events

Resource: subscription_event

This link relationship returns a collection of subscription events. 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_event

Actions

GET View a list of subscription_events
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_events[] — array of subscription_event 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_events
Available via fx:subscription_events on store·fx:subscription_events on subscription

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/stores/123/subscription_events",
      "title": "This Collection"
    },
    "first": {
      "href": "https://api.foxycart.com/stores/123/subscription_events?offset=0",
      "title": "First Page of this Collection"
    },
    "prev": {
      "href": "https://api.foxycart.com/stores/123/subscription_events?offset=0",
      "title": "Previous Page of this Collection"
    },
    "next": {
      "href": "https://api.foxycart.com/stores/123/subscription_events?offset=20",
      "title": "Next Page of this Collection"
    },
    "last": {
      "href": "https://api.foxycart.com/stores/123/subscription_events?offset=20",
      "title": "Last Page of this Collection"
    }
  },
  "_embedded": {
    "fx:subscription_events": [
      {
        "_links": {
          "curies": [
            {
              "name": "fx",
              "href": "https://api.foxycart.com/rels/{rel}",
              "templated": true
            }
          ],
          "self": {
            "href": "https://api.foxycart.com/subscription_events/456",
            "title": "This Subscription Event"
          },
          "fx:store": {
            "href": "https://api.foxycart.com/stores/456",
            "title": "This Store"
          },
          "fx:subscription": {
            "href": "https://api.foxycart.com/subscriptions/321",
            "title": "This Subscription"
          },
          "fx:customer": {
            "href": "https://api.foxycart.com/customers/789",
            "title": "This Customer"
          },
          "fx:transaction": {
            "href": "https://api.foxycart.com/transactions/999",
            "title": "Related Transaction"
          }
        },
        "event_type": "billing_failed",
        "event_source": "mit_recurring",
        "changes": null,
        "error_message": "Subscription Transaction Failed: Card declined.",
        "details": {
          "order_total": 29.99
        },
        "date_created": "2026-03-01T08:00:00-0700"
      }
    ]
  },
  "total_items": 1,
  "returned_items": 1,
  "limit": 20,
  "offset": 0
}