Skip to main content
GET
Dunning retry overview

Query Parameters

Example Request

Response

Notes

  • The recovery_rate is the ratio of successful_retries to total_retries across all dunning actions.
  • Each entry in by_action represents a distinct dunning action configured in your dunning campaigns.
  • Success is defined as the customer resolving the failed payment within the dunning window.
Use this endpoint alongside the dunning weights endpoint to understand which actions the system is learning to prioritize.

Authorizations

Authorization
string
header
required

Tenant API key obtained from POST /auth/register or POST /v1/developer/keys.

Response

Dunning overview.

total_retries
integer
total_successes
integer
success_rate
number
Required range: 0 <= x <= 1