Skip to main content
GET
Get a dunning flow
Draft documentation — API not yet rolled out. This endpoint describes the preview contract and may change before release. Sandbox access is provided separately. See access and limitations.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

uuid
string<uuid>
required

UUID of the dunning flow in this request.

Response

A configured dunning flow (Mahnlauf). levels is the ordered level configuration; level_count matches the summary shape embedded in GET /invoices/{uuid}/dunning/.

id
string<uuid>
required
read-only
name
string
required
read-only
is_default
boolean
required
read-only

Current enrollment configuration. Non-default rows include historical versions still referenced by existing invoices; is_active does not identify the latest version.

is_activated
boolean
required
read-only

Whether sending has been activated for this flow in the paywise portal. Released invoices remain pending until activation, unless another hold applies.

is_active
boolean
required
read-only

False = the flow was deactivated by paywise (no new enrollments; invoices already running on it continue). Not a deletion.

fees_enabled
boolean
required
read-only

Master switch for dunning fees. A level's fee is charged only when this and the level's fee_enabled are true.

level_count
integer
required
read-only
levels
object[]
required
read-only

Dunning-level configurations in level order. Flow configuration is read-only through this API.