---
title: "Terminate a pass [Beta]"
method: POST
path: "/passes/{passId}/terminate"
---

# Terminate a pass \[Beta\]

`POST /passes/{passId}/terminate`

## Request

- Base URL: `https://api.sandbox.cleeng.com/3.1`
- URL: `https://api.sandbox.cleeng.com/3.1/passes/{passId}/terminate`
- Auth: API key in header `X-Publisher-Token`

Use this endpoint to terminate a pass using its ID.

## Path parameters

- `passId` integer, required

## Headers

- `Content-Type` string

## Request body

- object
  - `terminationType` 'publisherCancel' | 'policyViolation' | 'expiration': One of following: - `publisherCancel` - publisher-initiated termination - `policyViolation` - terminated as a result of policy violation - `expiration` - terminated as a result of pass expiration When omitted (or empty body), defaults to `publisherCancel` These values are used to drive churn analytics in the Cleeng dashboard.

## Response `200`

200

- object
  - `passId` integer
  - `customerId` integer
  - `status` string
  - `offerId` string
  - `expiresAt` integer
  - `paymentMethodId` integer
  - `externalId` string
  - `externalProperties` object
  - `isExternallyManaged` boolean
  - `source` string

## Other responses

- `400`: 400
- `404`: 404
- `422`: 422

---

[API](https://skmtc.dev/cleeng/apis/api-31.md) - [All operations](https://skmtc.dev/cleeng/apis/api-31/llms.txt) - [OpenAPI document](https://skmtc.dev/cleeng/apis/api-31/revisions/df55396cda4f?raw)
