v1
latestOpenAPI 3.1.02026-07-261444991.2 MBSubscription
Fetch subscription schedule
This endpoint returns a paginated list of all plans associated with a subscription along with their start and end dates. This list contains the subscription's initial plan along with past and future plan changes.
get/subscriptions/{subscription_id}/schedule
Path parameters
subscription_idstring required
Query parameters
limitinteger
The number of items to fetch. Defaults to 20.
cursorstring nullable
Cursor for pagination. This can be populated by the next_cursor value returned from the initial request.
start_date[gte]string date-time nullable
start_date[gt]string date-time nullable
start_date[lt]string date-time nullable
start_date[lte]string date-time nullable
Response
OK
Example response
{
"data": [
{
"plan": {
"id": "m2t5akQeh2obwxeU",
"external_plan_id": "m2t5akQeh2obwxeU",
"name": "Example plan"
}
}
]
}