List subscriptions

GET https://api.ecurring.com/subscriptions

Subscriptions are the most important part of the eCurring API. A customer may have multiple subscriptions, with each subscription having one or more transactions (based on the status of the subscription).

Parameters

page[number]
integer
Optional - The number of the page (default is 1)
page[size]
integer
Optional - The number of objects to return (default is 10)

Response

meta
object
An object containing some meta information about the response.
total
integer
The total number of objects in the response
links
object
Links to help navigate through the lists of objects, based on the given page number and page size.
self string The current page
first string Optional - The first page of the set
last string Optional - The last page of the set
prev string Optional - The previous page in the set
next string Optional - The next page in the set
data
array
A list of subscription objects as described in Get subscription

Example

{
  "meta": {
    "total": 2
  },
  "links": {
    "self": "https://api.ecurring.com/subscriptions?page[number]=1&page[size]=10",
    "first": "https://api.ecurring.com/subscriptions?page[number]=1&page[size]=10",
    "last": "https://api.ecurring.com/subscriptions?page[number]=85&page[size]=10",
    "prev": null,
    "next": null
  },
  "data": [
    {
      "type": "subscription",
      "id": "1",
      "links": {
        "self": "https://api.ecurring.com/subscriptions/1"
      },
      "attributes": {
        "mandate_code": "ECUR-1",
        "mandate_accepted": true,
        "mandate_accepted_date": "2017-02-11T00:00:00+01:00",
        "start_date": "2017-02-11T22:11:57+01:00",
        "status": "active",
        "cancel_date": null,
        "resume_date": null,
        "confirmation_page": "https://app.ecurring.com/mandate/accept/1/ECUR-1",
        "confirmation_sent": false,
        "subscription_webhook_url": null,
        "transaction_webhook_url": null,
        "created_at": "2017-02-01T11:21:09+01:00",
        "updated_at": "2017-02-11T00:00:00+01:00"
      },
      "relationships": {
        "subscription-plan": {
          "data": {
            "type": "subscription-plan",
            "id": "1"
          }
        },
        "customer": {
          "data": {
            "type": "customer",
            "id": "1"
          }
        },
        "transactions": {
          "links": {
            "related": "https://api.ecurring.com/subscriptions/1/transactions"
          },
          "data": [
            {
              "type": "transaction",
              "id": "02f3c67b-1e1a-4692-8826-14f17f9b2c61"
            }
          ]
        }
      }
    }
    { ... }
  ]
}