Skip to main content
GET
Preview subscription timeline

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Query Parameters

max_events
integer
default:12

Maximum number of events to project (1–36, default 12); combined with until, whichever limit is reached first stops the projection.

Required range: x <= 36
until
string<date-time>

Only project events strictly before this instant; combined with max_events, whichever limit is reached first stops the projection.

Example:

"2024-12-20T16:04:11Z"

starts_at
string<date-time>

The instant to assume the subscription starts. Only applied when the subscription is still pending an activation event (a manual activation, checkout, quote signature, or a manually-started contract) and therefore has no start date yet; the projection then assumes it starts at this instant. Ignored for a subscription that already has a known start.

Example:

"2024-12-20T16:04:11Z"

Response

Projected subscription timeline

events
object[]
required

The subscription's projected future lifecycle events, in chronological order (by date).

stopped_because
object
required

Why the projection stopped — required reading, since the walk truncates rather than failing, so a short list of events is otherwise ambiguous.