Preview

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

previewSubscriptionCancellation

Preview the outcome of cancelling a subscription for a given cancellation option. Returns the termination fee and effective cancellation date without triggering the actual cancellation. This is read-only.

This page contains

    Authorization Rules

    This request requires authorization with at least one of the following scopes:

    Scopes

    billing.subscription-cancellation.read.instance

    billing.subscription-cancellation.read.tenant

    billing.subscription-cancellation.read.account

    billing.subscription-cancellation.read.self

    billing.subscription-cancellation.read.network

    billing.subscription-cancellation.read.agent

    Arguments

    input PreviewSubscriptionCancellationInput! PREVIEW

    Return Fields

    PreviewSubscriptionCancellationPayload PREVIEW

    Payload returned after previewing a subscription cancellation. Unlike TriggerSubscriptionCancellationProcessPayload (which returns an AsynchronousProcess with id, triggeredOn, startedOn, completedOn), this returns the computed result synchronously since no actual cancellation is triggered. If userErrors is not empty, the preview fields may be null.

    Interactive example

    This is an example query. Use the embedded interactive tool below to edit the query.

    Hint: use Ctrl + Space for autocompleting fields.