Webhooks

Update a subscription

Updates your subscription details. You can change the URL or the list of events.

patch/webhooks/{subscriptionId}

Request

Path parameters

subscriptionIdstring required

The unique identifier for the subscription.

Headers

versionstring date required

The API version with format yyyy-mm-dd. The current version is 2026-02-27.

Request body

eventsstring[] nullable

The list of events.

urlstring uri nullable

The URL of the Webhook endpoint.

descriptionstring nullable

The subscription description.

Example request

{
  "events": [
    "payment_intent.created",
    "order.created"
  ]
}

Response

OK

idstring

The unique identifier for the subscription.

accountIdstring nullable

The unique identifier for the account.

eventsstring[]

The list of events.

urlstring uri

The URL of the Webhook endpoint.

descriptionstring nullable

The subscription description.

createdAtstring date-time

The creation date, in ISO 8601 UTC format.

updatedAtstring date-time

The timestamp of the update date, in ISO 8601 UTC format.

Changes

No recorded changes to this operation across all 1 revision of this API.