Subscriptions

Cancel subscription schedule

Use when cancelling a scheduled change (e.g. customer changed mind). Identify by schedule ID in path or by subscription ID + schedule type in body.

post/subscriptions/schedules/{schedule_id}/cancel

Path parameters

schedule_idstring required

Schedule ID (optional if using request body)

schedule_idstring

schedule_id is the ID of the schedule to cancel (optional if subscription_id and schedule_type are provided)

schedule_type'plan_change' | 'cancellation'

subscription_idstring

subscription_id is the ID of the subscription (required if schedule_id is not provided)

messagestring

message is a confirmation message

status'pending' | 'executing' | 'executed' | 'cancelled' | 'failed'

Changed in 1 of the 149 revisions of this API.1