PreviewSubscriptionCancellationPayload
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.
This page contains
Fields
| status: SubscriptionCancellationRequestStatus PREVIEW | The status that would result from this cancellation. For preview, this will be IN_PROGRESS (immediate) or SCHEDULED (future date). |
| effectiveCancellationDate: Date | The effective date on which cancellation would take place. Null for IMMEDIATE cancellation. |
| terminationFeePreview: TerminationFeePreview PREVIEW | Termination fee details that would apply, if any. Null when no termination fee is applicable (e.g., within grace period, no contract, or free subscription). |
| userErrors: [PreviewSubscriptionCancellationError!] PREVIEW | A list of user errors that occurred during the preview request. |
Queries for PreviewSubscriptionCancellationPayload
| previewSubscriptionCancellation PREVIEW | 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. |