Sign in

v1

latestOpenAPI 3.1.02026-07-261444991.2 MB
Subscription Change

Cancel subscription change

Cancel a subscription change. The change can no longer be applied. A subscription can only have one "pending" change at a time - use this endpoint to cancel an existing change before creating a new one.

post/subscription_changes/{subscription_change_id}/cancel

Path parameters

subscription_change_idstring required

Response

OK

idstring required
status'pending' | 'applied' | 'cancelled' required
applied_atstring date-time nullable

When this change was applied.

cancelled_atstring date-time nullable

When this change was cancelled.

expiration_timestring date-time required

Subscription change will be cancelled at this time and can no longer be applied.

change_typestring required

The type of change (e.g., 'schedule_plan_change', 'create_subscription').

effective_datestring date-time nullable

When this change will take effect.

change_optionstring nullable

How the change is scheduled (e.g., 'immediate', 'end_of_subscription_term', 'requested_date').

plan_idstring nullable

The target plan ID for plan changes.

billing_cycle_alignmentstring nullable

Billing cycle alignment for plan changes.