search

Preview

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

SubscriptionCancellationOption

Represents the available subscription cancellation options.

This page contains

    Fields

    subscriptionCancellationOptionCode: SubscriptionCancellationOptionCode! PREVIEW

    The code representing the cancellation option type. Possible values: IMMEDIATE, END_OF_BILLING_CYCLE, END_OF_CONTRACT, CUSTOM_DATE.

    available: Boolean!

    Indicates whether this cancellation option is available.

    subscriptionCancellationRestriction: [SubscriptionCancellationRestriction!]! PREVIEW

    List of reasons preventing this cancellation option from being selected.

    Queries for SubscriptionCancellationOption

    subscriptionCancellationOptions PREVIEW

    Retrieve the cancellation options available for a specific subscription ID. This query enables clients to determine the appropriate cancellation action for a given subscription.