---
title: "Pause a schedule"
method: POST
path: "/schedules/v1/{schedule_id}/pause"
tags: ["Schedules"]
---

# Pause a schedule

`POST /schedules/v1/{schedule_id}/pause`

Pauses an active schedule. Payments will not be attempted until resumed.

## Path parameters

- `schedule_id` string, uuid, required

## Request body

- ScheduleActionRequest
  - `reason` string, nullable — An optional human readable reason for the action.

## Response `200`

The schedule was paused.

- ScheduleActionResponse
  - `schedule_id` string, uuid, required — The id of the schedule the action was applied to.
  - `status` 'PENDING' | 'ACTIVE' | 'PAUSED' | 'CONSENT_BLOCKED' | 'CANCELLED' | 'COMPLETED', required — The lifecycle status of a schedule. - `PENDING` — registered, not yet active. - `ACTIVE` — active; payments are attempted on their due dates. - `PAUSED` — temporarily paused; no payments attempted until resumed. - `CONSENT_BLOCKED` — the underlying consent is no longer usable. - `CANCELLED` — terminated by the client or due to consent state. - `COMPLETED` — all planned payments have been executed.
  - `updated_at` string, date-time, required — The date and time the schedule was last updated.
  - `links` ScheduleLinks, required — Hypermedia links for the actions available on a schedule. Only `self` is always present; the remaining links are included only when the corresponding action is currently available.
    - `self` string, required — Link to the schedule itself.
    - `cancel` string, nullable — Link to cancel the schedule, when the action is available.
    - `pause` string, nullable — Link to pause the schedule, when the action is available.
    - `resume` string, nullable — Link to resume the schedule, when the action is available.
    - `upcoming_payments` string, nullable — Link to the upcoming payments of the schedule, when available.

---

[API](https://skmtc.net/leantech/apis/auth.md) · [All operations](https://skmtc.net/leantech/apis/auth/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/leantech/auth/revisions/c2e46d54d886/schema)