Skip to main content

CancelSubscriptionDto

immediateboolean

When true, cancels immediately on Stripe and revokes access. When false (default), schedules cancel at period end so the user keeps access until then.

Default value: false
reasonstring

Admin-provided reason for the cancel; surfaced in audit log.

CancelSubscriptionDto
{
"immediate": false,
"reason": "string"
}