Stripe: Retrieve a schedule

Stripe subscriptionSchedules.getSubscriptionSchedulesSchedule: arguments, response, policy and SDK examples.

← Subscription schedules operations · Get started

Operation stripe.getsubscriptionschedulesschedule

Provider route: GET /v1/subscription_schedules/{schedule}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/stripe with npm, or alter-sdk-stripe with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { StripeIntegration } from "@alter-ai/stripe";

async function execute(input: Parameters<StripeIntegration["subscriptionSchedules"]["getSubscriptionSchedulesSchedule"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new StripeIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.subscriptionSchedules.getSubscriptionSchedulesSchedule(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_stripe import StripeIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = StripeIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.subscription_schedules.get_subscription_schedules_schedule(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.schedule`	string	Required within parent	Maximum length: 5000
`query`	object	Optional	Additional keys: not allowed
`query.expand`	array	Optional
`query.expand[]`	string	Each item	Maximum length: 5000

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	Model	Root	Expand Cancel a schedule — response body

Referenced models: Cancel a schedule — response body

Schemas

706 more schemas are linked from the tables above, on the schema pages.

Cancel a schedule — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes. Related guide: [Subscription schedules](https://docs.stripe.com/billing/subscriptions/subscription-schedules)
`application`	JSON	Optional
`application (anyOf 1)`	JSON	Alternative	ID of the Connect Application that created the schedule.
`application (anyOf 1) (anyOf 1)`	string	Alternative	Maximum length: 5000
`application (anyOf 1) (anyOf 2)`	Model	Alternative	Expand PostApplicationFeesIdRefund — response body — application / object: application
`application (anyOf 1) (anyOf 3)`	Model	Alternative	Expand Accept a quote — response body — application / value / deleted: True, object: application
`application (anyOf 2)`	null	Alternative
`billing_mode`	Model	Required within parent	Expand Cancel a schedule — response body — billing mode
`canceled_at`	JSON	Optional
`canceled_at (anyOf 1)`	JSON	Alternative
`canceled_at (anyOf 1) (anyOf 1)`	integer	Alternative	Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch. Format: unix-time
`canceled_at (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`canceled_at (anyOf 2)`	null	Alternative
`completed_at`	JSON	Optional
`completed_at (anyOf 1)`	JSON	Alternative
`completed_at (anyOf 1) (anyOf 1)`	integer	Alternative	Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch. Format: unix-time
`completed_at (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`completed_at (anyOf 2)`	null	Alternative
`created`	JSON	Required within parent
`created (anyOf 1)`	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
`created (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`current_phase`	JSON	Optional
`current_phase (anyOf 1)`	JSON	Alternative	Object representing the start and end dates for the current phase of the subscription schedule, if it is `active`.
`current_phase (anyOf 1) (anyOf 1)`	Model	Alternative	Expand Cancel a schedule — response body — current phase value end date, start date
`current_phase (anyOf 2)`	null	Alternative
`customer`	JSON	Required within parent	ID of the customer who owns the subscription schedule.
`customer (anyOf 1)`	string	Alternative	Maximum length: 5000
`customer (anyOf 2)`	Model	Alternative	Expand Create a customer — response body
`customer (anyOf 3)`	Model	Alternative	Expand Delete a customer — response body
`customer_account`	JSON	Optional
`customer_account (anyOf 1)`	string	Alternative	ID of the account who owns the subscription schedule. Maximum length: 5000
`customer_account (anyOf 2)`	null	Alternative
`default_settings`	Model	Required within parent	Expand Cancel a schedule — response body — default settings
`end_behavior`	string	Required within parent	Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription. Known values: cancel, none, release, renew
`id`	string	Required within parent	Unique identifier for the object. Maximum length: 5000
`livemode`	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
`metadata`	JSON	Optional
`metadata (anyOf 1)`	object	Alternative	Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Additional keys: see wildcard field
`metadata (anyOf 1).*`	string	Additional keys	Maximum length: 500
`metadata (anyOf 2)`	null	Alternative
`object`	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: subscription_schedule
`pause_schedules`	array	Optional	The pause schedules for this subscription schedule.
`pause_schedules[]`	Model	Each item	Expand Cancel a schedule — response body — pause schedules item
`phases`	array	Required within parent	Configuration for the subscription schedule's phases.
`phases[]`	Model	Each item	Expand Cancel a schedule — response body — phases item
`released_at`	JSON	Optional
`released_at (anyOf 1)`	JSON	Alternative
`released_at (anyOf 1) (anyOf 1)`	integer	Alternative	Time at which the subscription schedule was released. Measured in seconds since the Unix epoch. Format: unix-time
`released_at (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`released_at (anyOf 2)`	null	Alternative
`released_subscription`	JSON	Optional
`released_subscription (anyOf 1)`	string	Alternative	ID of the subscription once managed by the subscription schedule (if it is released). Maximum length: 5000
`released_subscription (anyOf 2)`	null	Alternative
`status`	string	Required within parent	The present status of the subscription schedule. Possible values are `not_started`, `active`, `completed`, `released`, and `canceled`. You can read more about the different states in our [behavior guide](https://docs.stripe.com/billing/subscriptions/subscription-schedules). Known values: active, canceled, completed, not_started, released
`subscription`	JSON	Optional
`subscription (anyOf 1)`	JSON	Alternative	ID of the subscription managed by the subscription schedule.
`subscription (anyOf 1) (anyOf 1)`	string	Alternative	Maximum length: 5000
`subscription (anyOf 1) (anyOf 2)`	Model	Alternative	Expand Pause a subscription — response body
`subscription (anyOf 2)`	null	Alternative
`test_clock`	JSON	Optional
`test_clock (anyOf 1)`	JSON	Alternative	ID of the test clock this subscription schedule belongs to.
`test_clock (anyOf 1) (anyOf 1)`	string	Alternative	Maximum length: 5000
`test_clock (anyOf 1) (anyOf 2)`	Model	Alternative	Expand Create a test clock — response body
`test_clock (anyOf 2)`	null	Alternative

Referenced models: PostApplicationFeesIdRefund — response body — application / object: application, Create a customer — response body, Accept a quote — response body — application / value / deleted: True, object: application, Delete a customer — response body, Pause a subscription — response body, Cancel a schedule — response body — current phase value end date, start date, Cancel a schedule — response body — phases item, Cancel a schedule — response body — default settings, Cancel a schedule — response body — pause schedules item, Cancel a schedule — response body — billing mode, Create a test clock — response body

PostApplicationFeesIdRefund — response body — application / object: application

Field	Type	Presence	Description and constraints
`$`	object	Root
`id`	string	Required within parent	Unique identifier for the object. Maximum length: 5000
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The name of the application. Maximum length: 5000
`name (anyOf 2)`	null	Alternative
`object`	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: application

Accept a quote — response body — application / value / deleted: True, object: application

Field	Type	Presence	Description and constraints
`$`	object	Root
`deleted`	boolean	Required within parent	Always true for a deleted object Known values: True
`id`	string	Required within parent	Unique identifier for the object. Maximum length: 5000
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The name of the application. Maximum length: 5000
`name (anyOf 2)`	null	Alternative
`object`	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: application

Policy, approvals and errors

SDK function policy ID: stripe.getsubscriptionschedulesschedule. Catalog operation: GetSubscriptionSchedulesSchedule. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"Stripe-Version": "2026-09-30.endive"}

Official provider source

Report an issue with this page