List subscription payments¶
Subscriptions API v2
GET
https://api.mollie.com/v2/customers/*customerId*/subscriptions/*subscriptionId*/payments
Authentication:API keysOrganization access tokensApp access tokens
Retrieve all payments of a specific subscriptions of a customer.
Parameters¶
Replace customerId
and subscriptionId
in the endpoint URL by the customer’s ID, for example cst_8wmqcHMN4U
,
and by the subscription’s ID, for example sub_8JfGzs6v3K
.
from
stringoptional
Used for pagination. Offset the result set to the payment with this ID. The payment with
this ID is included in the result set as well.
limit
integeroptional
The number of payments to return (with a maximum of 250).
Access token parameters¶
If you are using organization access tokens or are creating an
OAuth app, you can enable test mode through the testmode
query string parameter.
Set this to
true
to retrieve test mode payments.Response¶
200
application/hal+json
_embedded
objectThe object containing the queried data.
payments
array
An array of payment objects as described in Get payment.
count
integer
The number of payments found in
_embedded
, which is either the requested number (with a maximum of 250) or the
default number._links
objectLinks to help navigate through the lists of payments. Every URL object will contain an href
and a type
field.
self
URL object
The URL to the current set of payments.
previous
URL object
The previous set of payments, if available.
next
URL object
The next set of payments, if available.
documentation
URL object
The URL to the list subscription payments endpoint documentation.
Example¶
Request¶
cURLPHPPythonRubyNode.js
1 2 | curl -X GET https://api.mollie.com/v2/customers/cst_8wmqcHMN4U/subscriptions/sub_8JfGzs6v3K/payments \ -H "Authorization: Bearer test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM" |
1 2 3 4 5 6 7 8 | from mollie.api.client import Client mollie_client = Client() mollie_client.set_api_key("test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM") customer = mollie_client.customers.get("cst_stTC2WHAuS") subscription = customer.subscriptions.get("sub_8JfGzs6v3K") payments = subscription.payments.list() |
1 2 3 4 | We don't have a PHP 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 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 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 | HTTP/1.1 200 OK Content-Type: application/hal+json { "_embedded": { "payments": [ { "resource": "payment", "id": "tr_DtKxVP2AgW", "mode": "live", "createdAt": "2018-09-19T12:49:52+00:00", "amount": { "value": "10.00", "currency": "EUR" }, "description": "Some subscription 19 sep. 2018", "method": "directdebit", "metadata": null, "status": "pending", "isCancelable": true, "expiresAt": "2019-09-19T12:49:52+00:00", "locale": "nl_NL", "profileId": "pfl_rH9rQtedgS", "customerId": "cst_8wmqcHMN4U", "mandateId": "mdt_aGQNkteF6w", "subscriptionId": "sub_8JfGzs6v3K", "sequenceType": "recurring", "redirectUrl": null, "webhookUrl": "https://example.org/webhook", "settlementAmount": { "value": "10.00", "currency": "EUR" }, "details": { "transferReference": "SD67-6850-2204-6029", "creditorIdentifier": "NL08ZZZ502057730000", "consumerName": "Customer A", "consumerAccount": "NL50INGB0006588912", "consumerBic": "INGBNL2A", "dueDate": "2018-09-21", "signatureDate": "2018-09-19" }, "_links": { "self": { "href": "https://api.mollie.com/v2/payments/tr_DtKxVP2AgW", "type": "application/hal+json" }, "checkout": null, "customer": { "href": "https://api.mollie.com/v2/customers/cst_8wmqcHMN4U", "type": "application/hal+json" }, "mandate": { "href": "https://api.mollie.com/v2/customers/cst_8wmqcHMN4U/mandates/mdt_aGQNkteF6w", "type": "application/hal+json" }, "subscription": { "href": "https://api.mollie.com/v2/customers/cst_8wmqcHMN4U/subscriptions/sub_8JfGzs6v3K", "type": "application/hal+json" } } }, {...}, {...}, {...} ] }, "count": 4, "_links": { "documentation": { "href": "https://docs.mollie.com/reference/v2/subscriptions-api/list-subscription-payments", "type": "text/html" }, "self": { "href": "https://api.mollie.com/v2/customers/cst_8wmqcHMN4U/subscriptions/sub_8JfGzs6v3K/payments?limit=50", "type": "application/hal+json" }, "previous": null, "next": null } } |