Pre-1.0 · one maintainer · Stripe and cards only · no SDKs (client libraries) yet · no production users yet. Docs describe v0.9.1 (29 Oct 2026) · What’s new →

List dunning policies

GET

/v1/dunning/policies

const url = 'http://localhost:8080/v1/dunning/policies?limit=50&offset=0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'http://localhost:8080/v1/dunning/policies?limit=50&offset=0' \
  --header 'Authorization: Bearer <token>'

Every dunning policy in this tenant and mode, the default first, then oldest first. Each one carries how many customers are assigned to it.

Authorizations

BearerAuth

Parameters

Query Parameters

limit

integer

default: 50 >= 1 <= 100

Rows per page, from 1 to 100. Default 50. Any other value, or one that is not a whole number, is a 422 with param: limit.

offset

integer

Rows to skip, 0 or more. Default 0. A negative value, or one that is not a whole number, is a 422 with param: offset.

Responses

200

Policies

application/json

object

data

required

Array

object

required

string

tenant_id

string

name

required

string

enabled

required

boolean

is_default

required

Customers without an assigned policy use the default.

boolean

seeded

required

True for the “Default retries” policy the account was created with, until you edit it or make it the default. While it is true, the next enabled policy you create becomes the default instead. Set by the server: a request body that sends it is refused with 422.

boolean

retry_days

required

Days to wait before each retry; the number of retries is its length.

Array<integer>

final_subscription_action

required

string

Allowed values: none pause cancel

final_invoice_action

required

string

Allowed values: none mark_uncollectible

created_at

required

string format: date-time

updated_at

required

string format: date-time

assigned_customers

required

Customers explicitly assigned to this policy. Customers using it only as the default are not counted.

integer

total

required

How many rows match the request’s filters, on every page, not only this one. The audit log and the customer list’s search and name or email sort say where they stop counting.

integer

Example

{
  "data": [
    {
      "id": "hc_dpol_1a2b3c4d5e6f7890",
      "retry_days": [
        3,
        4,
        7
      ],
      "final_subscription_action": "none",
      "final_invoice_action": "none"
    }
  ]
}

422

limit or offset is out of range or not a whole number, or the request sends the removed after cursor (param names it)

application/json

object

error

object

type

One of invalid_request_error, authentication_error, rate_limit_error or api_error. Every error the API answers has this shape, including an unknown path (404, code route_not_found) and a method the path does not take (405, code method_not_allowed, with an Allow header). The few exceptions are listed in docs/api-surface.md.

string

code

string

message

string

request_id

string

param

The request field the error is about. Sent only when the error names one. A request body may hold only the fields its operation lists, spelled and cased as listed: any other field, or one the server sets (such as id), is refused with 422 and param naming it. An operation with no request body lists no fields: send no body, {} or null. The Stripe and Postmark webhooks and the LiteLLM callback take their sender’s body as it comes.

string

Example

{
  "error": {
    "type": "invalid_request_error"
  }
}