Sign in

v1

latestOpenAPI 3.1.0CC-BY-NC-SA-4.02026-07-2413803.8 MB
Subscriptions API

Update subscription

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

Advanced access token with subscriptions.write

OAuth access with subscriptions.write

patch/customers/{customerId}/subscriptions/{subscriptionId}

Request body

descriptionstring

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.

intervalstring

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.

startDatestring

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

timesinteger

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.

webhookUrlstring

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.

mandateIdstring

The mandate used for this subscription, if any.

testmodeboolean

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.

Example request

{
  "amount": {
    "currency": "EUR",
    "value": "10.00"
  },
  "description": "Subscription of streaming channel",
  "interval": "1 months",
  "startDate": "2025-01-01",
  "times": 6,
  "webhookUrl": "https://example.com/webhook",
  "mandateId": "mdt_5B8cwPMGnU"
}

Response

The updated subscription object.