List subscriptions

Subscriptions API v2
GEThttps://api.mollie.com/v2/customers/*customerId*/subscriptions

Retrieve all subscriptions of a customer.

Parameters

Replace customerId in the endpoint URL by the customer’s ID, for example cst_8wmqcHMN4U.

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).

Mollie Connect/OAuth parameters

If you’re creating an app with Mollie Connect/OAuth, the only mandatory extra 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
required
The payment profile’s unique identifier, for example pfl_3RkSN1zuPE. This field is mandatory.
testmode
boolean
optional
Set this to true to retrieve test mode subscriptions.

Response

200 application/hal+json; charset=utf-8

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

Request

1
2
curl -X GET https://api.mollie.com/v2/customers/cst_8wmqcHMN4U/subscriptions \
    -H "Authorization: Bearer test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM"

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
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,
                "interval": "3 months",
                "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"
                    },
                    "customer": {
                        "href": "https://api.mollie.com/v2/customers/cst_stTC2WHAuS",
                        "type": "application/hal+json"
                    }
                }
            },
            { },
            { }
        ]
    },
    "_links": {
        "self": {
            "href": "https://api.mollie.com/v2/customers/cst_stTC2WHAuS/subscriptions",
            "type": "application/hal+json"
        },
        "previous": null,
        "next": {
            "href": "https://api.mollie.com/v2/customers/cst_stTC2WHAuS/subscriptions?from=sub_mnfbwhMfvo",
            "type": "application/hal+json"
        },
        "documentation": {
            "href": "https://docs.mollie.com/reference/v2/subscriptions-api/list-subscriptions",
            "type": "text/html"
        }
    }
}