Preview

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

ManageScheduledChangeResult

This page contains

    Fields

    subscriptionId: ID!

    The subscription ID for this result.

    successCount: Int!

    Number of billingChargeResults entries that succeeded. Counts charges cancelled as a side effect too, so it can exceed the number of requested charges. Zero when userErrors is populated.

    failureCount: Int!

    Number of billingChargeResults entries that failed. Zero when userErrors is populated.

    userErrors: [ManageScheduledChangesError!] PREVIEW

    Subscription-level errors that prevented processing of this request item only; the other request items are still processed. When present, billingChargeResults is empty.

    billingChargeResults: [ManageScheduledChangeBillingChargeResult!]! PREVIEW

    Per-charge results, ordered by the requested billingCharge entries first. Cancelling a charge can cascade to other charges in the same end-of-contract unit, so this list can also contain charges that were not requested; those are appended at the end.

    Mutations for ManageScheduledChangeResult

    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.