SubscriptionScheduleUpdateRequest

Request body for updating a subscription schedule. All fields are optional.

If phases is provided, all existing phase rows are deleted and replaced. The running workflow recalculates its next action time.

  • phases
    Type: SchedulePhases 1…20

    Ordered list of schedule phases. Applied sequentially by the workflow. The first phase's start_date determines when the subscription is created.

    Properties: 10
  • default_settings
    Type: ScheduleDefaultSettings

    Default settings applied to the subscription created by this schedule.

    Properties: 3
  • end_behavior
    Type: ScheduleEndBehaviorenum

    What happens when the last phase ends:

    • RELEASE — schedule becomes RELEASED; the subscription continues billing on its own cadence
    • CANCEL — the subscription is immediately canceled; schedule becomes COMPLETED
    • NONE — no action taken; schedule remains active
    values
    RELEASECANCELNONE
  • metadata
    Type: object | null

    Updated metadata key-value pairs.

    Properties: 1