Skip to main content
GET
Get invoice dunning status

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.

Path Parameters

id
string
required

Response

Dunning status + attempt history.

object
enum<string>
Available options:
dunning_status
status
enum<string> | null

Where the invoice sits in the dunning cycle.

Available options:
idle,
retrying,
exhausted,
recovered,
stopped,
null
attempt_count
integer | null
next_attempt_at
string<date-time> | null
attempts
object[]