List all subscriptions

Subscriptions API v2
GEThttps://api.mollie.com/v2/subscriptions

Retrieve all subscriptions, ordered from newest to oldest. By using an API key all the subscriptions created with the current website profile will be returned. In the case of an OAuth Access Token relies the website profile on the profileId field. All subscriptions of the merchant will be returned if you do not provide it.

Parameters

from

string
optional
Offset the result set to the subscription with this ID. The subscription with this ID is included in the result set as well.

limit

integer
optional
The number of subscriptions to return (with a maximum of 250).

Access token parameters

If you are using organization access tokens or are creating an OAuth app, the only mandatory extra query string parameter is the profileId parameter. With it, you can specify for which profile you want to retrieve subscriptions. Organizations can have multiple profiles for each of their websites. See Profiles API for more information.

profileId

string
optional
The website profile’s unique identifier, for example pfl_3RkSN1zuPE.

testmode

boolean
optional
Set this to true to retrieve test mode subscriptions.

Response

200 application/hal+json

count

integer
The number of subscriptions found in _embedded, which is either the requested number (with a maximum of 250) or the default number.

_embedded

object

The object containing the queried data.

subscriptions

array
An array of subscription objects as described in Get subscription.

_links

object

Links to help navigate through the lists of subscriptions. Every URL object will contain an href and a type field.

self

URL object
The URL to the current set of subscriptions.

previous

URL object
The previous set of subscriptions, if available.

next

URL object
The next set of subscriptions, if available.

documentation

URL object
The URL to the subscriptions list endpoint documentation.

Example

cURLPHPPythonRubyNode.js
1
2
curl -X GET https://api.mollie.com/v2/subscriptions \
   -H "Authorization: Bearer test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM"
1
2
3
4
5
<?php
$mollie = new \Mollie\Api\MollieApiClient();
$mollie->setApiKey("test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM");

$subscriptions = $mollie->subscriptions->page();
1
2
3
4
We don't have a Python code example for this API call yet.

If you have some time to spare, feel free to open a pull request at:
https://github.com/mollie/api-documentation
1
2
3
4
We don't have a Ruby code example for this API call yet.

If you have some time to spare, feel free to open a pull request at:
https://github.com/mollie/api-documentation
1
2
3
4
We don't have a Node.js code example for this API call yet.

If you have some time to spare, feel free to open a pull request at:
https://github.com/mollie/api-documentation

Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
HTTP/1.1 200 OK
Content-Type: application/hal+json

{
    "count": 3,
    "_embedded": {
        "subscriptions": [
            {
                "resource": "subscription",
                "id": "sub_rVKGtNd6s3",
                "mode": "live",
                "createdAt": "2018-06-01T12:23:34+00:00",
                "status": "active",
                "amount": {
                    "value": "25.00",
                    "currency": "EUR"
                },
                "times": 4,
                "timesRemaining": 3,
                "interval": "3 months",
                "startDate": "2016-06-01",
                "nextPaymentDate": "2016-09-01",
                "description": "Quarterly payment",
                "method": null,
                "webhookUrl": "https://webshop.example.org/subscriptions/webhook",
                "_links": {
                    "self": {
                        "href": "https://api.mollie.com/v2/customers/cst_stTC2WHAuS/subscriptions/sub_rVKGtNd6s3",
                        "type": "application/hal+json"
                    },
                    "profile": {
                        "href": "https://api.mollie.com/v2/profiles/pfl_URR55HPMGx",
                        "type": "application/hal+json"
                    },
                    "customer": {
                        "href": "https://api.mollie.com/v2/customers/cst_stTC2WHAuS",
                        "type": "application/hal+json"
                    }
                }
            },
            { },
            { }
        ]
    },
    "_links": {
        "self": {
            "href": "https://api.mollie.com/v2/subscriptions",
            "type": "application/hal+json"
        },
        "previous": null,
        "next": {
            "href": "https://api.mollie.com/v2/subscriptions?from=sub_mnfbwhMfvo",
            "type": "application/hal+json"
        },
        "documentation": {
            "href": "https://docs.mollie.com/reference/v2/subscriptions-api/list-all-subscriptions",
            "type": "text/html"
        }
    }
}