List all subscription schedules

cURL

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

from flexprice import Flexprice


with Flexprice(
    api_key_auth="<YOUR_API_KEY_HERE>",
) as f_client:

    res = f_client.subscriptions.list_all_subscription_schedules()

    # Handle response
    print(res)

import { Flexprice } from "@flexprice/sdk";

const flexprice = new Flexprice({
  apiKeyAuth: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await flexprice.subscriptions.listAllSubscriptionSchedules();

  console.log(result);
}

run();

package main

import(
	"context"
	flexprice "github.com/flexprice/go-sdk/v2"
	"github.com/flexprice/go-sdk/v2/models/dtos"
	"log"
)

func main() {
    ctx := context.Background()

    s := flexprice.New(
        flexprice.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    res, err := s.Subscriptions.ListAllSubscriptionSchedules(ctx, dtos.ListAllSubscriptionSchedulesRequest{})
    if err != nil {
        log.Fatal(err)
    }
    if res.GetPendingSchedulesResponse != nil {
        // handle response
    }
}

{
  "count": 123,
  "schedules": [
    {
      "can_be_cancelled": true,
      "cancelled_at": "2023-11-07T05:31:56Z",
      "configuration": {},
      "configuration_details": {
        "plan_change": {
          "billing_period_behaviour": "unchanged",
          "entity_policies": {
            "addons": {
              "default_behaviour": "carry",
              "overrides": {}
            }
          },
          "target_plan_id": "<string>"
        }
      },
      "created_at": "2023-11-07T05:31:56Z",
      "days_until_execution": 123,
      "error_message": "<string>",
      "executed_at": "2023-11-07T05:31:56Z",
      "execution_details": {
        "plan_change": {
          "change_type": "<string>",
          "effective_date": "2023-11-07T05:31:56Z",
          "from_plan_id": "<string>",
          "previous_subscription_id": "<string>",
          "subscription_id": "<string>",
          "to_plan_id": "<string>"
        }
      },
      "execution_result": {},
      "id": "<string>",
      "metadata": {},
      "schedule_type": "plan_change",
      "scheduled_at": "2023-11-07T05:31:56Z",
      "status": "pending",
      "subscription_id": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

GET

subscriptions

schedules

cURL

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

from flexprice import Flexprice


with Flexprice(
    api_key_auth="<YOUR_API_KEY_HERE>",
) as f_client:

    res = f_client.subscriptions.list_all_subscription_schedules()

    # Handle response
    print(res)

import { Flexprice } from "@flexprice/sdk";

const flexprice = new Flexprice({
  apiKeyAuth: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await flexprice.subscriptions.listAllSubscriptionSchedules();

  console.log(result);
}

run();

package main

import(
	"context"
	flexprice "github.com/flexprice/go-sdk/v2"
	"github.com/flexprice/go-sdk/v2/models/dtos"
	"log"
)

func main() {
    ctx := context.Background()

    s := flexprice.New(
        flexprice.WithSecurity("<YOUR_API_KEY_HERE>"),
    )

    res, err := s.Subscriptions.ListAllSubscriptionSchedules(ctx, dtos.ListAllSubscriptionSchedulesRequest{})
    if err != nil {
        log.Fatal(err)
    }
    if res.GetPendingSchedulesResponse != nil {
        // handle response
    }
}

{
  "count": 123,
  "schedules": [
    {
      "can_be_cancelled": true,
      "cancelled_at": "2023-11-07T05:31:56Z",
      "configuration": {},
      "configuration_details": {
        "plan_change": {
          "billing_period_behaviour": "unchanged",
          "entity_policies": {
            "addons": {
              "default_behaviour": "carry",
              "overrides": {}
            }
          },
          "target_plan_id": "<string>"
        }
      },
      "created_at": "2023-11-07T05:31:56Z",
      "days_until_execution": 123,
      "error_message": "<string>",
      "executed_at": "2023-11-07T05:31:56Z",
      "execution_details": {
        "plan_change": {
          "change_type": "<string>",
          "effective_date": "2023-11-07T05:31:56Z",
          "from_plan_id": "<string>",
          "previous_subscription_id": "<string>",
          "subscription_id": "<string>",
          "to_plan_id": "<string>"
        }
      },
      "execution_result": {},
      "id": "<string>",
      "metadata": {},
      "schedule_type": "plan_change",
      "scheduled_at": "2023-11-07T05:31:56Z",
      "status": "pending",
      "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

subscription_ids

string[]

Filter by subscription IDs

schedule_type

enum<string>[]

Filter by schedule type

Available options:

plan_change,

cancellation

schedule_status

enum<string>[]

Filter by schedule status

Available options:

pending,

executing,

executed,

cancelled,

failed

limit

integer

Limit results

offset

integer

Offset for pagination

Response

200 - application/json

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

API Documentation

Resources

List all subscription schedules

Query Parameters

Response