Cancels a subscription schedule and its associated subscription immediately (if active). Use when you need to stop scheduling of phases while leaving any existing subscription in place. Only succeeds if the schedule status is 'not_started' or 'active'.
proratebooleanIf the subscription schedule is 'active', indicates if the cancellation should be prorated. Defaults to true if not specified.
scheduleRequiredstringThe unique identifier for the subscription schedule to cancel (e.g., sub_sched_1Mr3owLkdIwHu7ix38CXMudt)
invoice_nowbooleanIf the subscription schedule is 'active', indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Defaults to true if not specified.
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
OAuth connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.