Skip to content

Cancel the current dunning episode for a subscription

POST
/api/subscriptions/{id}/cancel-dunning
curl --request POST \
--url https://api.usegro.co/api/subscriptions/example/cancel-dunning

Writes off the unpaid billing cycle: the dunning episode is marked lost (exhausted) and the subscription resumes its normal schedule. Requires the subscription’s next dates to be valid (present and not in the past).

id
required
string

Dunning cancelled

Media typeapplication/json
object
success
required
boolean
message
required
string

Example generated

{
"success": true,
"message": "example"
}

Subscription is not in dunning or its dates are invalid

Media typeapplication/json

Example

{
"success": false,
"error": "Cannot cancel dunning: next billing date is in the past",
"errorCode": "INVALID_DATES"
}