Preview

PreviewSubscriptionCancellationInput is in Preview status and is subject to change without notice. For more information about Preview status, see the GraphQL API policy.

PreviewSubscriptionCancellationInput

Input for previewing a subscription cancellation. Same fields as TriggerSubscriptionCancellationProcessInput but excludes notification preferences since they are irrelevant for a dry-run preview.

This page contains

    Fields

    subscriptionId ID!

    The unique ID of the subscription to preview cancellation for.

    subscriptionCancellationOption SubscriptionCancellationOptionCode! PREVIEW

    The cancellation option to preview.

    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 is CUSTOM_DATE. For all other scenarios, if the date is available, it will be ignored.

    subscriptionCancellationReasonInfo SubscriptionCancellationReasonInfo PREVIEW

    The reason for the cancellation. Required if subscriptionCancellationReasonRequired AppSetting is enabled on the marketplace.