Skip to main content
POST
Cancel Plan
Cascade cancellation is synchronous and immediateCanceling a plan cancels every subscription on it right away — there’s no way to cancel the plan without also canceling its subscribers. Check affected_subscriptions in the response to know how many were affected.Re-canceling an already-CANCELED plan is safe and re-runs the cascade — it returns 200 again, not an error. This is deliberate: it’s the recovery path if a previous cascade partially failed to cancel some subscriptions, so retry a cancel call if you’re unsure it fully completed. INVALID_STATE (400) is reserved for a plan status outside ACTIVE/CANCELED, which isn’t currently reachable given those are the only two plan statuses.

Authorizations

public-api-key
string
header
default:<Your public-api-key>
required
private-secret-key
string
header
default:<Your private-secret-key>
required

Path Parameters

plan_id
string
required

The unique identifier of the plan.

Body

application/json
status
enum<string>
required
Available options:
CANCELED

Response

200

id
string
status
string
affected_subscriptions
integer

The number of subscriptions that were cascade-canceled along with the plan.