Cancel the workspace subscription
Cancels the workspace's subscription with the billing provider and returns the resulting subscription summary. Requires a Clerk session and the `billing:manage` workspace permission. Send an `Idempotency-Key` header to make retries safe; a replay within the window returns the original response.
Authorization
apiKey Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.
In: header
Path Parameters
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/v1/workspaces/string/billing/cancel"{ "data": { "workspaceId": "string", "plan": "free", "status": "none", "polarCustomerId": "string", "polarSubscriptionId": "string", "polarProductId": "string", "cancelAtPeriodEnd": true, "currentPeriodEnd": "string" }}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}Open a customer portal session for the workspace
Creates a Polar customer-portal session for the workspace and returns its URL, so the payer can manage payment methods and invoices with the provider. Requires a Clerk session and the `billing:manage` workspace permission.
Read the public plan catalog
Returns the default plan catalog assembled from the current plan configuration and prices, with no experiment variant applied, for use on marketing surfaces. No authentication is required.