search

Preview

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

SubscriptionCancellationOptionPayload

Payload returned when retrieving available cancellation options for a subscription.

This page contains

    Fields

    subscriptionCancellationOption: [SubscriptionCancellationOption!]! PREVIEW

    List of available subscription cancellation options and their statuses.

    subscription: SubscriptionDefinition! PREVIEW

    Subscription details for the requested subscription ID, will be extended with existing SubscriptionDefinition type

    subscriptionCancellationReason: [RoleBasedSubscriptionCancellationReason!]! PREVIEW

    Subscription cancellation reason for the subscription

    Queries for SubscriptionCancellationOptionPayload

    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.