cancelSubscription.md

//////////////////////////////////////////////////////////////////////////////////////////////
// DO NOT MODIFY THIS FILE                                                                  //
// This file is automatically generated by ZenStack CLI and should not be manually updated. //
// Source: schema.zmodel · Generated: 2026-02-23                                            //
//////////////////////////////////////////////////////////////////////////////////////////////

Index / Procedures / cancelSubscription

cancelSubscription Mutation

Cancel a workspace subscription.

The workspace retains access to paid features until currentPeriodEnd. After that date, the workspace is downgraded to the free tier automatically.

Cancellation sends a Stripe API call to stop future renewals and records the canceledAt timestamp locally.

Defined in: procedures.zmodel

Declaration · procedures.zmodel

mutation procedure cancelSubscription(
    subscriptionId: String
): Subscription

📥 Parameters

Input parameters accepted by this procedure.

Parameter	Type	Required
subscriptionId	String	Yes

📤 Returns

The return type of this procedure.

Subscription

---

📚 References

• ZModel procedures — ZenStack documentation

---

Next: getWorkspaceAnalytics