---
name: subscription-schedules-routes
description: Handle 6 OpenAPI operation(s) under /v1/subscription_schedules for the subscription schedules route group.
---

# subscription schedules API Routes

Handle 6 OpenAPI operation(s) under /v1/subscription_schedules for the subscription schedules route group.

Use the generated operation tools to make real API calls. Do not invent API responses.
If a tool reports missing setup, return the exact setup field name to the caller.
For write, update, or delete operations, state the intended action before calling the tool.

## Operations

### get_subscription_schedules

- Operation ID: `get_subscription_schedules`
- Route: `GET /v1/subscription_schedules`
- Mode: READ
- Summary: List all schedules
- Parameters:
  - `canceled_at` in `query`
  - `completed_at` in `query`
  - `created` in `query`
  - `customer` in `query`
  - `customer_account` in `query`
  - `ending_before` in `query`
  - `expand` in `query`
  - `limit` in `query`
  - `released_at` in `query`
  - `scheduled` in `query`
  - `starting_after` in `query`
- Body: JSON request body accepted.

### post_subscription_schedules

- Operation ID: `post_subscription_schedules`
- Route: `POST /v1/subscription_schedules`
- Mode: WRITE
- Summary: Create a schedule
- Body: JSON request body accepted.

### get_subscription_schedules_schedule

- Operation ID: `get_subscription_schedules_schedule`
- Route: `GET /v1/subscription_schedules/{schedule}`
- Mode: READ
- Summary: Retrieve a schedule
- Parameters:
  - `expand` in `query`
  - `schedule` in `path` required
- Body: JSON request body accepted.

### post_subscription_schedules_schedule

- Operation ID: `post_subscription_schedules_schedule`
- Route: `POST /v1/subscription_schedules/{schedule}`
- Mode: WRITE
- Summary: Update a schedule
- Parameters:
  - `schedule` in `path` required
- Body: JSON request body accepted.

### post_subscription_schedules_schedule_cancel

- Operation ID: `post_subscription_schedules_schedule_cancel`
- Route: `POST /v1/subscription_schedules/{schedule}/cancel`
- Mode: WRITE
- Summary: Cancel a schedule
- Parameters:
  - `schedule` in `path` required
- Body: JSON request body accepted.

### post_subscription_schedules_schedule_release

- Operation ID: `post_subscription_schedules_schedule_release`
- Route: `POST /v1/subscription_schedules/{schedule}/release`
- Mode: WRITE
- Summary: Release a schedule
- Parameters:
  - `schedule` in `path` required
- Body: JSON request body accepted.