Subscriptions API

List subscription payments

Retrieve all payments of a specific subscription.

The results are paginated.

🔑 Access with

API key

Advanced access token with subscriptions.read payments.read

OAuth access with subscriptions.read payments.read

get/customers/{customerId}/subscriptions/{subscriptionId}/payments

Request

Base URL
https://api.mollie.com/v2
URL
https://api.mollie.com/v2/customers/{customerId}/subscriptions/{subscriptionId}/payments
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, payments.read

Query parameters

fromstring

Example:tr_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.

sortstring

Example:desc

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

Possible values: asc desc

profileIdstring

The identifier referring to the profile this entity belongs to.

Most API credentials are linked to a single profile. In these cases the profileId can be omitted in the creation request. For organization-level credentials such as OAuth access tokens however, the profileId parameter is required.

Example:pfl_5B8cwPMGnU

The identifier referring to the profile you wish to retrieve the resources for.

Most API credentials are linked to a single profile. In these cases the profileId must not be sent. For organization-level credentials such as OAuth access tokens however, the profileId parameter is required.

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.

Response

A list of payment 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": {
    "payments": [
      {
        "resource": "payment",
        "id": "tr_5B8cwPMGnU",
        "mode": "live",
        "description": "Chess Board",
        "amount": {
          "currency": "EUR",
          "value": "10.00"
        },
        "amountRefunded": {
          "currency": "EUR",
          "value": "10.00"
        },
        "amountRemaining": {
          "currency": "EUR",
          "value": "10.00"
        },
        "amountCaptured": {
          "currency": "EUR",
          "value": "10.00"
        },
        "amountChargedBack": {
          "currency": "EUR",
          "value": "10.00"
        },
        "settlementAmount": {
          "currency": "EUR",
          "value": "10.00"
        },
        "redirectUrl": "https://example.org/redirect",
        "cancelUrl": "https://example.org/cancel",
        "webhookUrl": "https://example.org/webhooks",
        "lines": [
          {
            "type": "physical",
            "description": "LEGO 4440 Forest Police Station",
            "quantity": 1,
            "quantityUnit": "pcs",
            "unitPrice": {
              "currency": "EUR",
              "value": "10.00"
            },
            "discountAmount": {
              "currency": "EUR",
              "value": "10.00"
            },
            "totalAmount": {
              "currency": "EUR",
              "value": "10.00"
            },
            "vatRate": "21.00",
            "vatAmount": {
              "currency": "EUR",
              "value": "10.00"
            },
            "sku": "9780241661628",
            "categories": [
              "meal",
              "eco"
            ],
            "imageUrl": "https://...",
            "productUrl": "https://...",
            "recurring": {
              "description": "Gym subscription",
              "interval": "12 months",
              "amount": {
                "currency": "EUR",
                "value": "10.00"
              },
              "times": 1,
              "startDate": "2024-12-12"
            }
          }
        ],
        "billingAddress": {
          "title": "Mr.",
          "givenName": "Piet",
          "familyName": "Mondriaan",
          "organizationName": "Mollie B.V.",
          "streetAndNumber": "Keizersgracht 126",
          "streetAdditional": "Apt. 1",
          "postalCode": "1234AB",
          "email": "piet@example.org",
          "city": "Amsterdam",
          "region": "Noord-Holland",
          "country": "NL"
        },
        "shippingAddress": {
          "title": "Mr.",
          "givenName": "Piet",
          "familyName": "Mondriaan",
          "organizationName": "Mollie B.V.",
          "streetAndNumber": "Keizersgracht 126",
          "streetAdditional": "Apt. 1",
          "postalCode": "1234AB",
          "email": "piet@example.org",
          "city": "Amsterdam",
          "region": "Noord-Holland",
          "country": "NL"
        },
        "locale": "en_US",
        "countryCode": "BE",
        "method": "ideal",
        "issuer": "ideal_INGBNL2A",
        "restrictPaymentMethodsToCountry": "NL",
        "captureMode": "manual",
        "captureDelay": "8 hours",
        "captureBefore": "2024-03-20T09:28:37+00:00",
        "applicationFee": {
          "amount": {
            "currency": "EUR",
            "value": "10.00"
          },
          "description": "Platform fee"
        },
        "routing": [
          {
            "resource": "route",
            "id": "rt_5B8cwPMGnU",
            "mode": "live",
            "amount": {
              "currency": "EUR",
              "value": "10.00"
            },
            "destination": {
              "type": "organization",
              "organizationId": "org_1234567"
            },
            "createdAt": "2024-12-12T10:00:00+00:00",
            "releaseDate": "2024-12-12",
            "_links": {
              "self": {
                "href": "https://...",
                "type": "application/hal+json"
              },
              "payment": {
                "href": "https://...",
                "type": "application/hal+json"
              }
            }
          }
        ],
        "sequenceType": "oneoff",
        "subscriptionId": "sub_5B8cwPMGnU",
        "mandateId": "mdt_5B8cwPMGnU",
        "customerId": "cst_5B8cwPMGnU",
        "profileId": "pfl_5B8cwPMGnU",
        "settlementId": "stl_5B8cwPMGnU",
        "orderId": "ord_5B8cwPMGnU",
        "status": "open",
        "statusReason": {
          "code": "insufficient_funds",
          "message": "The account associated with the card has insufficient funds. The shopper should use another payment method or\ncontact their bank."
        },
        "isCancelable": true,
        "createdAt": "2024-03-20T09:13:37+00:00",
        "authorizedAt": "2024-03-20T09:28:37+00:00",
        "paidAt": "2024-03-20T09:28:37+00:00",
        "canceledAt": "2024-03-20T09:28:37+00:00",
        "expiresAt": "2024-03-20T09:28:37+00:00",
        "expiredAt": "2024-03-20T09:28:37+00:00",
        "failedAt": "2024-03-20T09:28:37+00:00",
        "dueDate": "2025-01-01",
        "storeCredentials": true,
        "_links": {
          "self": {
            "href": "https://...",
            "type": "application/hal+json"
          },
          "checkout": {
            "href": "https://...",
            "type": "application/hal+json"
          },
          "changePaymentState": {
            "href": "https://...",
            "type": "application/hal+json"
          },
          "dashboard": {
            "href": "https://...",
            "type": "application/hal+json"
          },
          "refunds": {
            "href": "https://...",
            "type": "application/hal+json"
          },
          "chargebacks": {
            "href": "https://...",
            "type": "application/hal+json"
          },
          "captures": {
            "href": "https://...",
            "type": "application/hal+json"
          },
          "settlement": {
            "href": "https://...",
            "type": "application/hal+json"
          },
          "customer": {
            "href": "https://...",
            "type": "application/hal+json"
          },
          "mandate": {
            "href": "https://...",
            "type": "application/hal+json"
          },
          "subscription": {
            "href": "https://...",
            "type": "application/hal+json"
          },
          "order": {
            "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

No recorded changes to this operation across all 1 revision of this API.