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

Fetch subscription schedule

cURL

curl --request GET \
  --url https://api.withorb.com/v1/subscriptions/{subscription_id}/schedule \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "start_date": "2023-11-07T05:31:56Z",
      "end_date": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "plan": {
        "id": "m2t5akQeh2obwxeU",
        "external_plan_id": "m2t5akQeh2obwxeU",
        "name": "Example plan"
      }
    }
  ],
  "pagination_metadata": {
    "has_more": true,
    "next_cursor": "<string>"
  }
}

Authorizations

Authorization · string · header · required

API Keys can be issued in the Orb's web application.

Path Parameters

subscription_id · string · required

Query Parameters

limit · integer · default: 20

The number of items to fetch. Defaults to 20.

Required range: 1 <= x <= 100

cursor · string | null

Cursor for pagination. This can be populated by the next_cursor value returned from the initial request.

start_date[gte] · string<date-time> | null

start_date[gt] · string<date-time> | null

start_date[lt] · string<date-time> | null

start_date[lte] · string<date-time> | null

Response

200

application/json

OK

data · SubscriptionScheduleItem · object[] · required

Show child attributes

pagination_metadata · PaginationMetadata · object · required

Show child attributes