dunning-settings
Stable. Describes behaviour that is built and covered by tests in this repository.
GET /v1/dunning-settings #
How long Payrudder waits before it retries a declined payment
Responses
| Status | Meaning | Body |
|---|---|---|
200 | OK | DunningSettings |
Example response
{
"retry_hours": [
1
],
"defaults_in_use": false,
"update_time": "2026-11-03T10:15:00Z"
}curl
curl -X GET https://YOUR-API-ADDRESS/v1/dunning-settings \
-H "Authorization: Bearer $PAYRUDDER_API_KEY"PUT /v1/dunning-settings #
Replace the retry delays
Up to six delays, each 1 to 720 hours (minutes in a sandbox tenant). A declined charge is retried after the first delay, then the second, and so on; when the delays run out the invoice is given up as uncollectible. An empty list gives up on the first decline.
Request body
| Field | Type | Description |
|---|---|---|
retry_hours | array of integer | |
block_on_chargeback | boolean | Absent: kept as it is. retry_hours is replaced as before (absent is none). |
Example
{}Responses
| Status | Meaning | Body |
|---|---|---|
200 | OK | DunningSettings |
400 | Error envelope | Error |
Example response
{
"retry_hours": [
1
],
"defaults_in_use": false,
"update_time": "2026-11-03T10:15:00Z"
}curl
curl -X PUT https://YOUR-API-ADDRESS/v1/dunning-settings \
-H "Authorization: Bearer $PAYRUDDER_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'Models
DunningSettings
| Field | Type | Description |
|---|---|---|
retry_hours required | array of integer | |
defaults_in_use required | boolean | True when nothing was set and the service-wide delays apply |
update_time required | string · date-time | |
block_on_chargeback | boolean | A formal dispute (a chargeback) of a customer's payment blocks the customer, category chargeback. Off unless you turn it on; it blocks only when the dispute opens and never lifts the block by itself. |
DunningSettingsInput
| Field | Type | Description |
|---|---|---|
retry_hours | array of integer | |
block_on_chargeback | boolean | Absent: kept as it is. retry_hours is replaced as before (absent is none). |
Error
| Field | Type | Description |
|---|---|---|
error required | object |