subscriptions

Resource: subscription

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

Actions

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

Properties (5)

_embedded Object · Read-only

Contains fx:subscriptions[] — array of subscription 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}/subscriptions
Available via fx:subscriptions on customer·fx:subscriptions on payment_method_expiring·fx:subscriptions on store·fx:subscriptions on transaction

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/stores/123/subscriptions",
      "title": "This Collection"
    },
    "first": {
      "href": "https://api.foxycart.com/stores/123/subscriptions?offset=0",
      "title": "First Page of this Collection"
    },
    "prev": {
      "href": "https://api.foxycart.com/stores/123/subscriptions?offset=0",
      "title": "Previous Page of this Collection"
    },
    "next": {
      "href": "https://api.foxycart.com/stores/123/subscriptions?offset=20",
      "title": "Next Page of this Collection"
    },
    "last": {
      "href": "https://api.foxycart.com/stores/123/subscriptions?offset=20",
      "title": "Last Page of this Collection"
    }
  },
  "_embedded": {
    "fx:subscriptions": [
      {
        "_links": {
          "curies": [
            {
              "name": "fx",
              "href": "https://api.foxycart.com/rels/{rel}",
              "templated": true
            }
          ],
          "self": {
            "href": "https://api.foxycart.com/subscriptions/456",
            "title": "This Subscription"
          },
          "fx:attributes": {
            "href": "https://api.foxycart.com/subscriptions/123/attributes",
            "title": "Attributes for This Subscription"
          },
          "fx:store": {
            "href": "https://api.foxycart.com/stores/456",
            "title": "This Store"
          },
          "fx:customer": {
            "href": "https://api.foxycart.com/customers/789",
            "title": "This Customer"
          },
          "fx:original_transaction": {
            "href": "https://api.foxycart.com/transactions/999",
            "title": "Original Transaction"
          },
          "fx:last_transaction": {
            "href": "https://api.foxycart.com/transactions/999",
            "title": "Last Transaction"
          },
          "fx:transactions": {
            "href": "https://api.foxycart.com/stores/456/transactions?subscription_id=123",
            "title": "Transactions for this Subscription"
          },
          "fx:subscription_events": {
            "href": "https://api.foxycart.com/subscriptions/123/subscription_events",
            "title": "Events for this Subscription"
          },
          "fx:subscription_upcoming_items": {
            "href": "https://api.foxycart.com/subscriptions/123/subscription_upcoming_items",
            "title": "Upcoming Items for this Subscription"
          },
          "fx:transaction_template": {
            "href": "https://api.foxycart.com/carts/999",
            "title": "Transaction Template"
          },
          "fx:sub_token_url": {
            "href": "https://mystore.foxycart.com/cart?sub_token=e38b9886405ff668f6d11c129e7fde1f8281f3e00dd34c819e0c9370ccb2bd56",
            "title": "This Sub Token"
          },
          "fx:send_webhooks": {
            "href": "https://api.foxycart.com/subscriptions/123/send_webhooks",
            "title": "Refeed webhooks v2 for this Subscription"
          },
          "fx:charge_past_due": {
            "href": "https://api.foxycart.com/subscriptions/123/charge_past_due",
            "title": "Charge Past Due"
          },
          "fx:sub_modification_url": {
            "href": "https://mystore.foxycart.com/cart?sub_token=e38b9886405ff668f6d11c129e7fde1f8281f3e00dd34c819e0c9370ccb2bd56&redirect=https://www.mydomain.com/subscription_modification.html",
            "title": "URL to modify this subscription"
          }
        },
        "start_date": "2010-09-15T00:00:00-0700",
        "next_transaction_date": "2014-05-01T00:00:00-0700",
        "end_date": null,
        "frequency": "1m",
        "error_message": "",
        "past_due_amount": 0,
        "first_failed_transaction_date": null,
        "is_active": false,
        "third_party_id": "",
        "payment_type": null,
        "cancellation_source": "",
        "date_created": null,
        "date_modified": "2013-08-19T10:58:39-0700"
      }
    ]
  },
  "total_items": 1,
  "returned_items": 1,
  "limit": 20,
  "offset": 0
}