---
title: "List Dunning Plans"
method: GET
path: "/dunning_plans"
tags: ["Dunning Plans"]
---

# List Dunning Plans

`GET /dunning_plans`

## Request

- Base URL: `https://api.upflow.io/v1`
- URL: `https://api.upflow.io/v1/dunning_plans`
- Auth: API key in header `X-Api-Key` and API key in header `X-Api-Secret`

List dunning plans (workflows) configured for your organization. Use this endpoint to discover the `id` of a dunning plan that can then be referenced on customers or invoices.

## Query parameters

- `offset` integer
- `page` integer
- `limit` integer

## Response `200`

Paginated list of dunning plans.

- object
  - `offset` integer: 0-based index of the first item returned. Returned when using offset-based pagination or by default.
  - `page` integer: Page number (1-based). Returned when using page-based pagination.
  - `limit` integer, required: Maximum number of items returned.
  - `total` integer, required: Total items in the set.
  - `items` DunningPlan[], required
    - `id` string, uuid, required: The dunning plan ID.
    - `name` string, required: The dunning plan name.
    - `entity` 'CUSTOMER' | 'INVOICE', required: The entity this dunning plan applies to.
    - `mode` 'STANDARD' | 'CONTEXTUAL', required: The dunning plan mode.
    - `default` boolean, required: Whether this dunning plan is the default for the organization.
    - `maximumContactFrequency` integer, required: Minimum number of days between two contacts with a customer.
    - `emailReplyTo` string: Reply-to email used on messages sent through this dunning plan. Omitted when not configured.
    - `createdAt` string, date-time, required: The date at which the dunning plan was created (ISO 8601 format).
    - `updatedAt` string, date-time, required: The date at which the dunning plan was last updated (ISO 8601 format).

---

[API](https://skmtc.dev/upflow/apis/upflow-api.md) - [All operations](https://skmtc.dev/upflow/apis/upflow-api/llms.txt) - [OpenAPI document](https://skmtc.dev/upflow/apis/upflow-api/revisions/898a98ca0587?raw)