API Reference

Update subscription

patch
https://api.mollie.com/v2/customers//subscriptions/

Update an existing subscription.

Canceled subscriptions cannot be updated.

For an in-depth explanation of each parameter, refer to the Create subscription endpoint.

Access with

API key

Organization access token with subscriptions.write

OAuth access with subscriptions.write

Path Params
string
required

Provide the ID of the related customer.

string
required

Provide the ID of the related subscription.

Body Params
amount
object

Update the amount for future payments of this subscription.

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.

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.

string

The start date of the subscription in YYYY-MM-DD format.

integer

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.

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.

Any metadata added to the subscription will be automatically forwarded to the payments generated for it.

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.

string

The mandate used for this subscription, if any.

boolean

Whether the entity was created in test mode or live mode. This field does not update the mode of the entity.

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.

Responses

Updated 4 days ago

Language
Credentials
LoadingLoading…
Response
Choose an example:
application/hal+json

Updated 4 days ago