TriggerSubscriptionCancellationProcessInput
Input required to initiate a subscription cancellation process.
This page contains
Fields
subscriptionId ID! | The unique ID of the subscription to be cancelled. |
subscriptionCancellationOption SubscriptionCancellationOptionCode! PREVIEW | The cancellation option selected by the user (e.g., immediate, end of billing cycle). |
cancellationRequestDate DateTime | The date requested for the cancellation to take effect (if applicable). The date is conditionally mandatory based on the subscriptionCancellationOption. The date is required only when the subscriptionCancellationOption CUSTOM_DATE. For all other scenarios, if the date is available, it will be ignored. |
subscriptionCancellationNotification SubscriptionCancellationNotification! PREVIEW | Subscription cancellation notification preferences. |
subscriptionCancellationReasonInfo SubscriptionCancellationReasonInfo! PREVIEW | The reason for the cancellation |
Mutations for TriggerSubscriptionCancellationProcessInput
triggerSubscriptionCancellationProcess PREVIEW | Initiates the process to cancel a subscription based on the provided inputs. Users must specify the cancellation option, contextual details, and preferences for notification. |