Skip to main content

When this fires

After a payment failure put a subscription in past_due, a successful retry of the outstanding invoice fires this event — whether the charge succeeded automatically or the customer paid through the portal after updating their card. The subscription returns to active at the same time, so customer.state_changed also fires. Restore access on either event; use this one specifically to close dunning flows you opened on payment.failed.

Body

application/json
id
string
required
event
string
required
Allowed value: "payment.recovered"
timestamp
string
required
organizationId
string
required
mode
enum<string>
required
Available options:
live,
sandbox
apiVersion
string
required
data
object
required

Response

200

Return any 2xx status code to acknowledge receipt of the event.