MOmollie
Subscriptions API

List customer subscriptions

Changed on

Retrieve all subscriptions of a customer.

The results are paginated.

get/v2/customers/{customerId}/subscriptions

Request

  • Base URL
    https://api.mollie.com
  • URL
    https://api.mollie.com/v2/customers/{customerId}/subscriptions
  • Auth
    • HTTP bearer
    • or HTTP bearer
    • or OAuth 2
      Authorization code: https://my.mollie.com/oauth2/authorize
      Token URL: https://api.mollie.com/oauth2/tokens scopes: subscriptions.read

Query parameters

fromstring
Example:sub_5B8cwPMGnU

Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the result set.

limitinteger nullable
Example:50

The maximum number of items to return. Defaults to 50 items.

sort'asc' | 'desc'
Example:desc

Used for setting the direction of the result set. Defaults to descending order, meaning the results are ordered from newest to oldest.

testmodeboolean

Most API credentials are specifically created for either live mode or test mode. In those cases the testmode query parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the testmode query parameter to true.

Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.

Headers

idempotency-keystring
Example:123e4567-e89b-12d3-a456-426

A unique key to ensure idempotent requests. This key should be a UUID v4 string.

Response

A list of subscription objects.

countinteger required

The number of items in this result set. If more items are available, a _links.next URL will be present in the result as well.

The maximum number of items per result set is controlled by the limit property provided in the request. The default limit is 50 items.

Example response

{
  "count": 5,
  "_embedded": {
    "subscriptions": [
      {
        "resource": "subscription",
        "id": "sub_5B8cwPMGnU",
        "mode": "live",
        "status": "active",
        "amount": {
          "currency": "EUR",
          "value": "10.00"
        },
        "times": 6,
        "timesRemaining": 5,
        "interval": "2 days",
        "startDate": "2025-01-01",
        "nextPaymentDate": "2025-01-01",
        "description": "Subscription of streaming channel",
        "method": "paypal",
        "applicationFee": {
          "amount": {
            "currency": "EUR",
            "value": "10.00"
          },
          "description": "Platform fee"
        },
        "webhookUrl": "https://example.com/webhook",
        "customerId": "cst_5B8cwPMGnU",
        "mandateId": "mdt_5B8cwPMGnU",
        "createdAt": "2024-03-20T09:13:37+00:00",
        "canceledAt": "2025-01-01T13:10:19+00:00",
        "profileId": "pfl_5B8cwPMGnU",
        "_links": {
          "self": {
            "href": "https://...",
            "type": "application/hal+json"
          },
          "customer": {
            "href": "https://...",
            "type": "application/hal+json"
          },
          "mandate": {
            "href": "https://...",
            "type": "application/hal+json"
          },
          "profile": {
            "href": "https://...",
            "type": "application/hal+json"
          },
          "payments": {
            "href": "https://...",
            "type": "application/hal+json"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "previous": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "next": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "documentation": {
      "href": "https://...",
      "type": "application/hal+json"
    }
  }
}

Changes

  • 1bcb76dbe9eaRevision changes
    • breaking

      the response property's min was decreased from 1.00 to 0.00 for the response status

  • 00fb770ca934Revision changes
    • info

      the response property /////// became required for the status

    • info

      the response property /////// became required for the status

    • info

      the response property /////// became required for the status

    • info

      the response property /////// became required for the status

    • info

      the response property /////// became required for the status

    • info

      the response property /////// became required for the status

    • info

      the response property /////// became required for the status

    • info

      the response property /////// became required for the status

    • info

      the response property /////// became required for the status

    • info

      the response property /////// became required for the status