Skip to main content
GET
/
v1
/
subscription-schedules
List all subscription schedules
curl --request GET \
  --url https://us.api.flexprice.io/v1/v1/subscription-schedules
{
  "count": 123,
  "schedules": [
    {
      "can_be_cancelled": true,
      "cancelled_at": "<string>",
      "configuration": {},
      "created_at": "<string>",
      "days_until_execution": 123,
      "error_message": "<string>",
      "executed_at": "<string>",
      "execution_result": {},
      "id": "<string>",
      "metadata": {},
      "schedule_type": "plan_change",
      "scheduled_at": "<string>",
      "status": "pending",
      "subscription_id": "<string>",
      "updated_at": "<string>"
    }
  ]
}

Query Parameters

pending_only
boolean

Filter to pending schedules only

subscription_id
string

Filter by subscription ID

limit
integer

Limit results

offset
integer

Offset for pagination

Response

200 - application/json

OK

List of pending schedules for a subscription

count
integer

count is the number of pending schedules

schedules
object[]

schedules is the list of pending schedules