---
title: "Summary"
method: GET
path: "/api/invoice-schedules/summary"
tags: ["invoice-schedules"]
---

# Summary

`GET /api/invoice-schedules/summary`

## Request

- Base URL: `https://demo.usesecuro.com` (the document declares no server; this is the origin it was published from)
- URL: `https://demo.usesecuro.com/api/invoice-schedules/summary`
- Auth: OAuth 2
  - Password
  - Token URL: `/api/auth/login`
- TypeScript: <https://skmtc.dev/usesecuro/apis/securo/docs/api/invoice-schedules/summary/get.ts> (a function with typed inputs; its response is checked against the schema)

## Headers

- `X-Workspace-Id` string, nullable

## Response `200`

Successful Response

- ScheduleSummaryRead
  - `active_count` integer, required
  - `paused_count` integer, required
  - `ended_count` integer, required
  - `by_currency` ScheduleCurrencySummary[], required
    - `currency` string, required
    - `monthly_recurring` string, required
    - `active_count` integer, required
    - `ended_recently_count` integer, required
    - `monthly_lost` string, required
    - `past_due_count` integer, required

## Other responses

- `422`: Validation Error

## Changes

- **2026-11-05** `416a7752fec4`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/usesecuro/apis/securo/changes/api/invoice-schedules/summary/get.md)

---

[API](https://skmtc.dev/usesecuro/apis/securo.md) - [All operations](https://skmtc.dev/usesecuro/apis/securo/llms.txt) - [OpenAPI document](https://skmtc.dev/usesecuro/apis/securo/revisions/416a7752fec4?raw)