Cancel Plan

The only supported status transition. Canceling a plan blocks new subscriptions AND synchronously cascade-cancels every subscription currently linked to it.

post/plans/{plan_id}/status

Request

Base URL
https://api-sandbox.y.uno/v1
Auth
API key in header PUBLIC-API-KEY and API key in header PRIVATE-SECRET-KEY
TypeScript
https://skmtc.dev/y/apis/ai-caller/docs/plans/:plan_id/status/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

plan_idstring required

The unique identifier of the plan.

Request body

status'CANCELED' required

Response

200

idstring

statusstring

affected_subscriptionsinteger

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

Changes

No recorded changes to this operation across all 1 revision of this API.