---
title: "Schedule subscription cancellation"
method: PUT
path: "/subscription/schedule-cancellation"
---

# Schedule subscription cancellation

`PUT /subscription/schedule-cancellation`

Schedule a subscription to be canceled at the end of the current billing period. Only available for Stripe, Paddle, Solidgate, Primer and Zotlo subscriptions.

## Request body

- object
  - `pay_system_id` string, required — ID of the subscription in external Stripe/Paddle/PayPal, e.g. sub_1PzNJzCsRq5tBi2bbfNsAf86or I-H7HC902MYM49
  - `cancel_at_period_end` boolean — If true, the subscription will be scheduled to cancel at the end of the current billing period. If false, the cancellation schedule will be removed.

## Response `200`

Subscription cancellation scheduled successfully.

- object
  - `success` integer
  - `error` integer
  - `message` string

## Other responses

- `400` — Invalid request or missing parameters.

---

[API](https://skmtc.net/web2wave/apis/web2wave-api.md) · [All operations](https://skmtc.net/web2wave/apis/web2wave-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/web2wave/web2wave-api/versions/c88545119271/schema)