Pagination


By default, the Subscribe Pro API returns 25 entries when a GET request is made to, for instance, the subscription endpoint. To see more than 25 items per request, or to view items on a subsequent 'page', you can supply the following parameters in your request.

Parameters

elementdescription
since_id(int) The entity ID used as a starting point when fetching subscriptions
count(int) The number of entries to display per page

Example

https://api.subscribepro.com/services/v2/subscriptions.json?access_token=xyz&since_id=11111&count=100

Assuming 11111 is the ID of a subscription on your Subscribe Pro Environment, this will return a JSON array of 100 subscription objects, starting at that record.

Here is the format of one record being returned by this endpoint:

{
  "subscriptions": [
    {
      "id": 123456,
      "customer_id": "1",
      "status": "Cancelled",
      "product_sku": "test-product",
      "qty": 1,
      "use_fixed_price": false,
      "interval": "Every Month",
      "next_order_date": "2016-05-17",
      "created_as_trial": true,
      "magento_shipping_method_code": "subscribepro_recurring",
      "payment_profile": {
        "id": 12345,
        "customer_id": "1",
        "magento_customer_id": "12",
        "customer_email": "[email protected]",
        "status": "redacted",
        "payment_vault": "Subscribe Pro Sandbox",
        "gateway": "Subscribe Pro Sandbox",
        "payment_token": "aBcXyZ",
        "creditcard_type": "visa",
        "creditcard_last_digits": "1111",
        "creditcard_month": "7",
        "creditcard_year": "2022",
        "creditcard_first_digits": "411111",
        "created": "2015-05-19T16:00:42+0000",
        "updated": "2015-06-25T17:47:42+0000",
        "payment_method_type": "credit_card",
        "billing_address": {
          "id": 2,
          "customer_id": "1",
          "first_name": "Test",
          "last_name": "User",
          "street1": "1 Test St",
          "street2": "",
          "city": "Baltimore",
          "region": "MD",
          "postcode": "21224",
          "country": "US",
          "phone": "999-999-9999",
          "created": "2015-05-19T16:00:42+0000",
          "updated": "2015-05-19T16:00:42+0000"
        }
      },
      "shipping_address": {
        "id": 3,
        "customer_id": "1",
        "magento_address_id": 23,
        "first_name": "Test",
        "last_name": "User",
        "created": "2015-05-19T16:00:45+0000",
        "updated": "2015-05-19T16:53:59+0000"
      },
      "failed_order_attempt_count": 1,
      "cancelled": "2016-07-14T18:50:32+0000",
      "creditcard_last_digits": "1111",
      "subscription_products": [
        {
          "product_sku": "test-product",
          "qty": "1",
          "created": "2015-05-19T16:00:45+0000",
          "updated": "2016-07-14T18:50:32+0000"
        }
      ],
      "magento_shipping_address_id": 23,
      "user_defined_fields": [],
      "created": "2015-05-19T16:00:45+0000",
      "updated": "2016-07-14T18:50:32+0000",
      "recurring_order_count": 0
    }
  ]
}