Sign in
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/v1/subscriptions/schedules/{schedule_id}/cancel

Path parameters

schedule_idstring required

Schedule ID (optional if using request body)

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)

Response

OK

messagestring

message is a confirmation message

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

Changes

Changed in 2 of the 112 revisions of this API.757

  • 7d57386313c7352See the full diff
    • ▲

      request property was restricted to a list of enum values

      request-property-became-enum

    • ▲

      the request property type changed from no type to string

      request-property-type-changed

    • ▲

      the response's property type changed from no type to string for status

      response-property-type-changed

    • ●

      added the new cancelled enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new executed enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new executing enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new failed enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new pending enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      added the new cancellation enum value to the request property

      request-property-enum-value-added

    • ○

      added the new plan_change enum value to the request property

      request-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 4b1a811c417945See the full diff
    • ▲

      removed the enum value cancellation of the request property

      request-property-enum-value-removed

    • ▲

      removed the enum value plan_change of the request property

      request-property-enum-value-removed

    • ▲

      the request property type changed from string to no type

      request-property-type-changed

    • ▲

      the response's property type changed from string to no type for status

      response-property-type-changed

    • ○

      removed the cancelled enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the executed enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the executing enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the failed enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the pending enum value from the response property for the response status

      response-property-enum-value-removed

    This revision also has 121 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog