---
title: "Manage subscription"
method: PATCH
path: "/v1/subscriptions/{id}/manage"
tags: ["Subscriptions"]
---

# Manage subscription

`PATCH /v1/subscriptions/{id}/manage`

## Request

- Base URL: `https://api.kyshi.co`
- URL: `https://api.kyshi.co/v1/subscriptions/{id}/manage`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/kyshi/apis/kyshi-mor-public-api/docs/v1/subscriptions/:id/manage/patch.ts> (a function with typed inputs; its response is checked against the schema)

Cancels, reactivates, or schedules cancellation at period end. Prefer cancel_at_period_end for voluntary cancellations: an immediate cancel takes access the customer has already paid for.

## Path parameters

- `id` string, required

## Request body

- EnableOrCancelSubscriptionDto
  - `action` 'cancel' | 'activate' | 'cancel_at_period_end', required

## Response `200`

Success.

- object
  - `status` boolean, required: `true` on success.
  - `message` string, required
  - `code` number, required: Mirrors the HTTP status code.
  - `data` object, required: The endpoint-specific payload.
    - `id` string, required
    - `status` string, required
    - `plan` PublicPlanDto
      - `id` string, required
      - `name` string, required
      - `amount` number, required
      - `currency` string, required
      - `interval` string
      - `isActive` boolean
      - `createdAt` string
    - `customer` object
    - `nextChargeAt` string
    - `createdAt` string

## Other responses

- `400`: Missing or invalid request parameter.
- `401`: No valid API key provided.
- `403`: The API key lacks permission for this request.
- `404`: Resource not found. A 404 on an object you just created is usually a test/live mode mismatch.
- `422`: Business rule failure, such as an unsupported currency or insufficient balance.
- `500`: Something went wrong on Kyshi’s end.

## Changes

- **2026-11-03** `4aed77604588`: 1 breaking, 4 warning, 8 info
  - the response's body type changed from `object` to no type for status `200`
  - removed the optional property `code` from the response with the `200` status
  - removed the optional property `data` from the response with the `200` status
  - removed the optional property `message` from the response with the `200` status
  - …9 more

[Operation history](https://skmtc.dev/kyshi/apis/kyshi-mor-public-api/changes/v1/subscriptions/:id/manage/patch.md)

---

[API](https://skmtc.dev/kyshi/apis/kyshi-mor-public-api.md) - [All operations](https://skmtc.dev/kyshi/apis/kyshi-mor-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/kyshi/apis/kyshi-mor-public-api/revisions/4aed77604588?raw)