Skip to main content
WEBHOOK
complete_dunning
{
  "id": "req_4wslCq3dynn1ptiX4svIx60FvIK",
  "type": "complete_dunning",
  "created": "2023-01-18T11:00:00Z",
  "data": {
    "invoiceId": "inv_12345678"
  }
}
{
  "success": true,
  "message": "Event processed successfully"
}

Authorizations

​
Authorization
string
header
required

API key authentication using a Bearer token in the Authorization header. Example: Authorization: Bearer YOUR_API_KEY

Body

application/json

Event sent when dunning process should be completed for an invoice. This is triggered when a hard error occurs or the maximum number of retries is reached. The invoice should be considered non-retryable and the merchant should take appropriate actions such as closing the invoice or communicating with the customer.

​
id
string
required

Unique identifier for this webhook event

Example:

"req_4wslCq3dynn1ptiX4svIx60FvIK"

​
type
enum<string>
required

Event type identifier

Available options:
complete_dunning
Example:

"complete_dunning"

​
created
string<date-time>
required

Timestamp when this webhook event was created

Example:

"2023-01-18T11:00:00Z"

​
data
object
required

Complete dunning event data

Response

Event received and processed successfully

​
success
boolean

Indicates if the event was successfully received and processed

Example:

true

​
message
string

Additional information about the response

Example:

"Event processed successfully"

⌘I