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 →

Get dunning policy

GET

/v1/dunning/policies/{id}

const url = 'http://localhost:8080/v1/dunning/policies/example';
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/example \
  --header 'Authorization: Bearer <token>'

Authorizations

BearerAuth

Parameters

Path Parameters

required

string

Responses

200

The policy

application/json

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

Example

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

404

not_found: no policy with this id in this tenant and mode.

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"
  }
}