Create dunning policy

Create a dunning policy for the merchant.

POST /v1/billing/dunning/policies

Create dunning policy

cURL

curl --request POST \
  --url https://api.example.com/v1/billing/dunning/policies \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "retryIntervalsDays": [
    123
  ],
  "finalAction": "<string>",
  "isDefault": true
}
'

Request

name · string · required

Human-readable name, e.g. "Standard 3-strike".

retryIntervalsDays · integer[] · required

Days since the invoice went overdue at which each reminder is sent. e.g. [1, 3, 7] sends reminders at +1 day, +3 days, +7 days. Min 1 item, max 10.

finalAction · string · default: "cancel"

Action to apply when all retries are exhausted. One of cancel, pause, mark_uncollectible.

isDefault · boolean · default: "false"

Set this policy as the merchant default. Only one policy can be default at a time - setting a new default automatically unsets the previous one.

Response

Returns the created DunningPolicy object.

DunningPolicy object

Field	Type	Description
id	string	Policy id.
name	string	Policy name.
retryIntervalsDays	integer[]	Retry offsets in days.
finalAction	string	cancel | pause | mark_uncollectible
isDefault	boolean	Whether this is the merchant default.
active	boolean	Whether this policy is active.
createdAt	string	ISO 8601 timestamp.