Accounts API4

Balance Transfers API3

Balances API5

Capabilities API1

Captures API3

Chargebacks API3

Checkout Sessions API2

Client Links API1

Clients API2

Customers API7

Delayed Routing API3

Draft Transfers API4

Invoices API2

Mandates API4

Methods API7

OAuth API2

Onboarding API2

Organizations API3

Payment Links API6

Payments API6

Payouts API4

Permissions API2

Profiles API6

Refunds API5

Sales Invoices API5

Settlements API8

Subscriptions API7

Terminals API6

Transfers API2

Unmatched Credit Transfers API4

Verify Payee API1

Wallets API1

Webhook Events API1

Webhooks API6

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.

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

Headers

idempotency-keystring

Example:123e4567-e89b-12d3-a456-426

A unique key to ensure idempotent requests. This key should be a UUID v4 string.

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

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.

Changes

Changed in 4 of the 79 revisions of this API.17

Jun 15, 202600fb770ca93410See the full diff
- ○
  the response property //// became required for the status
  response-property-became-required
- ○
  the response property //// became required for the status
  response-property-became-required
- ○
  the response property //// became required for the status
  response-property-became-required
- ○
  the response property //// became required for the status
  response-property-became-required
- ○
  the response property //// became required for the status
  response-property-became-required
- ○
  the response property //// became required for the status
  response-property-became-required
- ○
  the response property //// became required for the status
  response-property-became-required
- ○
  the response property //// became required for the status
  response-property-became-required
- ○
  the response property //// became required for the status
  response-property-became-required
- ○
  the response property //// became required for the status
  response-property-became-required
Jun 9, 2026327472893a894See the full diff
- ○
  the response property ////// became required for the status
  response-property-became-required
- ○
  the response property ////// became required for the status
  response-property-became-required
- ○
  the response property ////// became required for the status
  response-property-became-required
- ○
  the response property ////// became required for the status
  response-property-became-required
May 19, 20267cab62b218301See the full diff
- ○
  added the non-success response with the status
  response-non-success-status-added
May 12, 2026ef4b5a97b56a2See the full diff
- ○
  the endpoint scheme security advancedAccessToken was added to the API
  api-security-added
- ○
  the endpoint scheme security organizationAccessToken was removed from the API
  api-security-removed
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 79 revisions, 9 have no diff computed.

Full history