List all subscription schedules

Use when listing or searching scheduled changes across subscriptions (e.g. admin view). Returns schedules with optional filtering.

GET /v1/subscription-schedules

List all subscription schedules

cURL

curl --request GET \
  --url https://us.api.flexprice.io/v1/v1/subscription-schedules

import requests

url = "https://us.api.flexprice.io/v1/v1/subscription-schedules"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://us.api.flexprice.io/v1/v1/subscription-schedules', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://us.api.flexprice.io/v1/v1/subscription-schedules",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://us.api.flexprice.io/v1/v1/subscription-schedules"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://us.api.flexprice.io/v1/v1/subscription-schedules")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://us.api.flexprice.io/v1/v1/subscription-schedules")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

200

{
  "count": 123,
  "schedules": [
    {
      "can_be_cancelled": true,
      "cancelled_at": "2023-11-07T05:31:56Z",
      "configuration": {},
      "created_at": "2023-11-07T05:31:56Z",
      "days_until_execution": 123,
      "error_message": "<string>",
      "executed_at": "2023-11-07T05:31:56Z",
      "execution_result": {},
      "id": "<string>",
      "metadata": {},
      "scheduled_at": "2023-11-07T05:31:56Z",
      "subscription_id": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

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

Show child attributes