---
title: "Get schedule details"
method: GET
path: "/schedules/v1/{schedule_id}"
tags: ["Schedules"]
---

# Get schedule details

`GET /schedules/v1/{schedule_id}`

Returns the full details of a single schedule.

## Path parameters

- `schedule_id` string, uuid, required

## Response `200`

The schedule details.

- ScheduleDetailsResponse
  - `schedule_id` string, uuid, required — The id of the schedule.
  - `consent_id` string, uuid, required — The id of the consent the schedule belongs to.
  - `application_id` string, uuid, required — The id of the application that owns the schedule.
  - `kind` 'RECURRING' | 'EXPLICIT', required — Discriminates between recurring and explicit schedules.
  - `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.
  - `plan_summary` SchedulePlanSummary, required — Summary of the schedule's plan. The populated fields depend on the schedule `kind`: recurring schedules populate `amount`, `period_unit`, `start_date` and `end_date`; explicit schedules populate `planned_count`, `first_payment_date` and `last_payment_date`.
    - `amount` ScheduleAmount — A monetary amount for a scheduled payment.
      - `value` number, required — The amount of money in the currency specified.
      - `currency` string, required — The currency of the amount.
    - `period_unit` 'DAY' | 'WEEK' | 'MONTH' | 'YEAR' — The time unit on which a recurring schedule repeats. - `DAY` — the schedule repeats every day. - `WEEK` — the schedule repeats every week. - `MONTH` — the schedule repeats every month. - `YEAR` — the schedule repeats every year.
    - `start_date` string, date, nullable — The start date. Present for recurring schedules.
    - `end_date` string, date, nullable — The end date, when bounded. Present for recurring schedules.
    - `planned_count` integer, nullable — The number of planned payments. Present for explicit schedules.
    - `first_payment_date` string, date, nullable — The date of the first planned payment. Present for explicit schedules.
    - `last_payment_date` string, date, nullable — The date of the last planned payment. Present for explicit schedules.
  - `pending_payment` PendingScheduledPayment
    - `scheduled_payment_id` string, uuid, required — The id of the pending scheduled payment.
    - `due_date` string, date, required — The date the pending payment is due.
    - `amount` ScheduleAmount, required — A monetary amount for a scheduled payment.
      - `value` number, required — The amount of money in the currency specified.
      - `currency` string, required — The currency of the amount.
    - `reference` string, nullable — The reference applied to the pending payment, when set.
  - `created_at` string, date-time, required — The date and time the schedule was created.
  - `updated_at` string, date-time, nullable — The date and time the schedule was last updated.

---

[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)