---
title: "Cancel a Subscription"
method: PATCH
path: "/v1/subscriptions/{id}/cancel"
---

# Cancel a Subscription

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

This API cancels a previously created subscription.

## Path parameters

- `id` string, required

## Response `200`

200

- object
  - `data` object
    - `object` string
    - `id` string
    - `customer_id` string
    - `application_fee_percent` number, nullable
    - `billing_type` integer
    - `payment_due_days` integer, nullable
    - `cancel_at_period_end` integer
    - `canceled_at` integer, nullable
    - `current_period_end` integer, nullable
    - `current_period_start` integer, nullable
    - `days_until_due` integer, nullable
    - `plan_ref` string
    - `start_at` integer, nullable
    - `end_at` integer, nullable
    - `status` 'active' | 'trial' | 'pending' | 'passed_due' | 'paused' | 'unpaid' | 'canceled'
    - `message` string
    - `tax_percent` number
    - `trial_end` integer, nullable
    - `trial_days` integer
    - `trial_start` integer, nullable
    - `created_at` integer, nullable
    - `updated_at` integer, nullable
    - `description` string, nullable
    - `plan` object
      - `data` object
        - `object` string
        - `plan_id` string
        - `amount` integer
        - `interval` string
        - `interval_count` integer
        - `name` string
        - `plan_description` string, nullable
        - `statement_descriptor` string, nullable
        - `trial_period_days` union
          - string
          - integer
        - `currency` string
        - `created_at` integer, nullable
        - `updated_at` integer, nullable
  - `meta` object
    - `include` string[]
    - `custom` unknown[]
      - unknown

## Other responses

- `422` — 422

---

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