CLcleeng

Terminate a pass [Beta]

Use this endpoint to terminate a pass using its ID.

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

Path parameters

passIdinteger required

Pass identifier in Cleeng.

Headers

Content-Typestring

application/json

Request body

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

passIdinteger
customerIdinteger
statusstring
offerIdstring
expiresAtinteger
paymentMethodIdinteger
externalIdstring
externalPropertiesobject
isExternallyManagedboolean
sourcestring

Example response

{
  "passId": 123456789,
  "customerId": 123123123,
  "status": "terminated",
  "offerId": "P987654321_PL",
  "expiresAt": 1713273647,
  "paymentMethodId": 111222333,
  "externalId": "externalId",
  "isExternallyManaged": true,
  "source": "samsung"
}

Changes

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