cancelSubscription

Cancels the subscription permanently from the cancellation flow: the account moves to the cancelled plan, not Free or Free+, and is kept rather than deleted. Paid plans keep access until the period ends; trials cancel immediately. Contacts Stripe and notifies support; fails without a subscription, and Enterprise plans must contact support. On a free plan, or one already cancelling, cancelled, or expired, it returns the status without changes. Use switchToFree to keep a free plan. Requires billing edit access.

cancelSubscription(
  reason: String
): CancelSubscriptionResult

Arguments

cancelSubscription.reason ● String scalar

The customer's answer to the cancellation survey, sent to support as one line of at most 128 characters.

Type

CancelSubscriptionResult object

Requested flow status returned by switchToFree or cancelSubscription.