Delete phase

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

Delete one or all future phases from a subscription schedule. Useful when a customer wants to undo a scheduled renewal or when replacing renewal offers.


Modes

ModeBehavior
last_phase (default)Deletes only the last future phase
all_phasesDeletes all future phases, leaving only the current phase

Restrictions

ConditionResult
Subscription has no schedule404 error
Subscription has only one phase422 error
No future phases exist422 error
Phase is a gifted renewalCannot be deleted

Behavior After Deletion

  • Auto-renew plan: After deleting all phases, end_behavior is set to release (subscription will auto-renew after the last remaining phase)
  • Self-renew plan: After deleting all phases, end_behavior is set to cancel (subscription expires after the last remaining phase)
  • Advance invoices for deleted phases are voided or refunded depending on payment status

Webhook

No explicit webhook event is dispatched for phase deletion. The subscription model update may trigger subscription.updated via the Eloquent observer if the subscription record is saved during the operation.

Path Params
int32
required
Query Params
int32
required
Body Params
string
Defaults to last_phase
Headers
string
required
Defaults to Bearer eyJ***
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json