Preview

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

ManageScheduledChangesPayload

This page contains

    Fields

    results: [ManageScheduledChangeResult!]! PREVIEW

    Per-subscription results for the manage request, in the same order as requestItems. Empty when userErrors is populated.

    userErrors: [ManageScheduledChangesError!] PREVIEW

    Bulk-level errors that prevented any processing (an empty requestItems list or a duplicate subscriptionId). When present, no request item was processed and nothing was changed.

    Mutations for ManageScheduledChangesPayload

    manageScheduledChanges PREVIEW

    Manages one or more scheduled changes on subscriptions before they take effect. Supports selective targeting (billingCharge) or cancel-all mode (cancelAll).

    Only ScheduledChangeOperationType.CANCEL is currently applied; any other operation is reported per charge with ScheduledChangeOperationNotSupportedError.

    The payload of the request is validated up front: an empty requestItems list or a duplicate subscriptionId rejects every request item and is reported in ManageScheduledChangesPayload.userErrors with no results. Request items are then processed independently, so a failure on one subscription does not prevent the others from being processed and this mutation can complete partially. A targeting problem within a request item is reported in that item's ManageScheduledChangeResult.userErrors only.