/v1/subscriptions/{subscription_id}

Update a subscription's endpoint, events, or active state.

Changes take effect for the next delivery; attempts already queued keep the settings they were created with. Omitted fields keep their current value, so send only what you want to change. Pausing with active: false stops new deliveries but keeps the delivery log intact.

Jump to the request builder ↓

Parameters

Path parameters

subscription_id string required

Identifier of the subscription to update, from the create response or the dashboard.

Example: sub_9f2c1a

Body parameters

url string optional

New HTTPS endpoint for future deliveries. The signing secret does not change.

Example: https://example.com/hooks/hooklane-eu
events array of strings optional

Replacement list of event types, comma-separated. This replaces the whole list — include every event you still want.

Example: invoice.paid, invoice.payment_failed, invoice.refunded
active boolean optional

Pause (false) or resume (true) deliveries for this subscription.

Example: false

Response

The full subscription with the updated fields applied. The signing secret is never returned again — only `create` responds with it.

200 · application/json

{
  "id": "sub_9f2c1a",
  "object": "subscription",
  "url": "https://example.com/hooks/hooklane-eu",
  "events": [
    "invoice.paid",
    "invoice.payment_failed",
    "invoice.refunded"
  ],
  "description": "Production billing endpoint",
  "active": false,
  "created_at": "2026-08-28T09:12:44Z"
}