List all subscriptions¶
GET
https://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
stringoptionallimit
integeroptionalAccess token parameters¶
If you are using organization access tokens or are creating an
OAuth app, you can specify which profile you are retrieving subscriptions for using the
profileId
parameter. Organizations can have multiple profiles for each of their websites. If you omit the
profileId
parameter, the API will return all subscriptions across all profiles. See
Profiles API for more information.
For these authentication methods the optional testmode
parameter is available as well to enable test mode.
pfl_3RkSN1zuPE
. Omit this parameter to retrieve all
subscriptions across all profiles.true
to retrieve test mode subscriptions.Response¶
200
application/hal+json
count
integer_embedded
, which is either the requested number (with a maximum of 250) or
the default number._embedded
objectThe object containing the queried data.
subscriptions
array_links
objectLinks to help navigate through the lists of subscriptions. Every URL object will contain an href
and a type
field.
self
URL objectprevious
URL objectnext
URL objectdocumentation
URL objectExample¶
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 5 6 | from mollie.api.client import Client mollie_client = Client() mollie_client.set_api_key("test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM") subscriptions = mollie_client.subscriptions.list() |
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 share suggestions on our Discord: https://discord.gg/VaTVkXB4aQ |
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 share suggestions on our Discord: https://discord.gg/VaTVkXB4aQ |
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" } } } |