| Field | Type | Required | Description | Example |
|---|---|---|---|---|
amount |
Optional<Amount> | ➖ | In v2 endpoints, monetary amounts are represented as objects with a currency and value field. |
|
times |
JsonNullable<Long> | ➖ | Total number of payments for the subscription. Once this number of payments is reached, the subscription is considered completed. Test mode subscriptions will get canceled automatically after 10 payments. |
6 |
interval |
Optional<String> | ➖ | Interval to wait between payments, for example 1 month or 14 days.The maximum interval is one year ( 12 months, 52 weeks, or 365 days).Possible values: ... days, ... weeks, ... months. |
2 days |
startDate |
Optional<String> | ➖ | The start date of the subscription in YYYY-MM-DD format. |
2025-01-01 |
description |
Optional<String> | ➖ | The subscription's description will be used as the description of the resulting individual payments and so showing up on the bank statement of the consumer. Please note: the description needs to be unique for the Customer in case it has multiple active subscriptions. |
Subscription of streaming channel |
method |
JsonNullable<SubscriptionMethod> | ➖ | The payment method used for this subscription. If omitted, any of the customer's valid mandates may be used. | paypal |
applicationFee |
Optional<SubscriptionRequestApplicationFee> | ➖ | With Mollie Connect you can charge fees on payments that your app is processing on behalf of other Mollie merchants. Setting an application fee on the subscription will ensure this fee is charged on each individual payment. Refer to the applicationFee parameter on the Get payment endpoint documentation for moreinformation. |
|
metadata |
JsonNullable<Metadata> | ➖ | Provide any data you like, for example a string or a JSON object. We will save the data alongside the entity. Whenever you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB. |
|
webhookUrl |
JsonNullable<String> | ➖ | We will call this URL for any payment status changes of payments resulting from this subscription. This webhook will receive all events for the subscription's payments. This may include payment failures as well. Be sure to verify the payment's subscription ID and its status. |
https://example.com/webhook |
mandateId |
Optional<String> | ➖ | N/A | mdt_5B8cwPMGnU |
profileId |
Optional<String> | ➖ | N/A | pfl_5B8cwPMGnU |
testmode |
JsonNullable<Boolean> | ➖ | Whether to create the entity in test mode or live mode. Most API credentials are specifically created for either live mode or test mode, in which case this parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting testmode to true. |
false |