Skip to main content
POST
Create a dunning policy

Authorizations

Authorization
string
header
required

Your PayBridgeNP API key. Obtain one from the dashboard under Settings → API Keys. Prefix: sk_test_ for testing, sk_live_ for production.

Body

application/json
name
string
required
Example:

"Standard retries"

retryIntervalsDays
integer[]
required
Example:
finalAction
enum<string>
default:cancel
Available options:
cancel,
pause,
mark_uncollectible
isDefault
boolean
default:false

Response

Policy created.

id
string
Example:

"dpol_01j9x2k3m4n5p6q7r8s9t0u1v2"

object
enum<string>
Available options:
dunning_policy
name
string
Example:

"Standard retries"

retry_intervals_days
integer[]

Days-after-overdue to retry, e.g. [1, 3, 7].

Example:
final_action
enum<string>

Action when all retries are exhausted.

Available options:
cancel,
pause,
mark_uncollectible
is_default
boolean
active
boolean