Subscriptions and waits

Get a subscription

GET/v1/agent/subscriptions/:id

Returns a subscription with its match count and expiry.

Parameters

Path parameters1

idstringRequired

Subscription ID (sub_…).

Returns

200The sample response is on the right.Errors return error and message; see Errors and limits.

GETGet a subscription

curl "https://api.getensue.com/v1/agent/subscriptions/sub_…" \
  -H "authorization: Bearer $ENSUE_API_KEY"

const res = await fetch("https://api.getensue.com/v1/agent/subscriptions/sub_…", {
  method: "GET",
  headers: {
    authorization: `Bearer ${process.env.ENSUE_API_KEY}`,
  },
});
console.log(await res.json());

import os, requests

res = requests.get(
    "https://api.getensue.com/v1/agent/subscriptions/sub_…",
    headers={"authorization": f"Bearer {os.environ['ENSUE_API_KEY']}"},
)
print(res.json())

200Response

{
  "id": "sub_9c4t…",
  "status": "active",
  "label": "t_42",
  "source": {
    "id": "src_8f2k…",
    "name": "stripe-prod"
  },
  "destination": {
    "id": "dst_7q1c…",
    "name": "billing-agent",
    "type": "inbox"
  },
  "correlation": "t_42",
  "max_events": 1,
  "matched": 0,
  "expires_at": "2026-11-11T10:00:00.000Z",
  "kind": "subscription"
}

{"id":"sub_9c4t…","status":"active","label":"t_42","source":{"id":"src_8f2k…","name":"stripe-prod"},"destination":{"id":"dst_7q1c…","name":"billing-agent","type":"inbox"},"correlation":"t_42","max_events":1,"matched":0,"expires_at":"2026-11-11T10:00:00.000Z","kind":"subscription"}