Force Dunning End

POST

/api/:account_id/subscriptions/:subscription_id/force-dunning-end

Force dunning to end immediately (internal workflow-only endpoint).

Called by Restate when hard cap or timeout safeguards are triggered to forcibly end dunning regardless of normal evaluation logic.

This endpoint:

Finds all active dunning states for the subscription
Transitions them to “ending” with reason from the safeguard
Applies the account’s configured dunning behavior
Returns the result to Restate

This is an emergency endpoint - should only be triggered by safeguards, not by normal dunning flow.

Force dunning to end immediately (internal workflow-only endpoint). Called by Restate when hard cap or timeout safeguards are triggered to forcibly end dunning regardless of normal evaluation logic. This endpoint: 1. Finds all active dunning states for the subscription 2. Transitions them to "ending" with reason from the safeguard 3. Applies the account's configured dunning behavior 4. Returns the result to Restate This is an emergency endpoint - should only be triggered by safeguards, not by normal dunning flow.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

subscription_idstringRequired

account_idstringRequired

Response

Successful Response

statusstring

reasonstring

subscription_cancelledbooleanOptionalDefaults to false

dunning_behaviorstring or nullOptional

Errors

422

Unprocessable Entity Error

$	curl -X POST https://app.paymentkit.com/api/account_id/subscriptions/subscription_id/force-dunning-end \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"status": "dunning_ended",
3	"reason": "hard_cap_safeguard_triggered",
4	"subscription_cancelled": true,
5	"dunning_behavior": "immediate_cancellation"
6	}

Authentication

Path parameters

Headers

Response

Errors