List subscription plans

GET https://api.ecurring.com/subscription-plans

In order to add a new subscription to a customer you will require the id of a subscription plan.

Subscription Plans can only be created by logging in to your dashboard, but you can retrieve them from the API to (for example) list them on your own website.

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)
include
string
Optional - A comma seperated list of relationships to include in the response. Possible values: subscriptions

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 plan objects as described in Get subscription plan

Example

{
  "meta": {
    "total": 2
  },
  "links": {
    "self": "https://api.ecurring.com/subscription-plans?page[number]=1&page[size]=10",
    "first": "https://api.ecurring.com/subscription-plans?page[number]=1&page[size]=10",
    "last": "https://api.ecurring.com/subscription-plans?page[number]=1&page[size]=10",
    "prev": null,
    "next": null
  },
  "data": [
    {
      "type": "subscription-plan",
      "id": "1",
      "links": {
        "self": "https://api.ecurring.com/subscription-plans/1"
      },
      "attributes": {
        "name": "One Size Fits All",
        "description": "eCurring - One Size Fits All",
        "start_date": "2017-01-01T00:00:00+02:00",
        "status": "active",
        "mandate_authentication_method": "online_payment",
        "send_invoice": true,
        "storno_retries": 1,
        "terms": null,
        "created_at": "2018-02-01T11:21:09+01:00",
        "updated_at": "2018-02-01T11:21:09+01:00"
      },
      "relationships": {
        "subscriptions": {
          "links": {
            "related": "https://api.ecurring.com/subscription-plans/1/subscriptions"
          },
          "data": []
        }
      }
    },
    { ... }
  ]
}