Skip to content

Cancel product


Target audience: Developers

Cancel subscription


This endpoint cancelling a single user product by id. It will put the user product in the cancelled state, which means it will be deactivated upon next renewal date.

Prerequisites and Constraints

  • The user product must be controlled by Payway (provision_service == tulo)
  • The package of the user product is configured to allow the user to cancel it. This is administered in PAP package administration.
  • The user product must be recurring (subscription_type != limited)


Environment URI


Identity Scope
Yes /external/me/w


Field Required Description
id Required id of the user product to cancel
cancellation_reason_id Optional id of the cancellation reason to supply. Defaults to default cancellation reason if omitted.

Curl Example

curl --request PUT \
  --url \
  --header 'accept: application/json' \
  --header 'authorization: Bearer token' \
  --header 'content-type: application/json' \
  --data '{
  "id": "50f3ac249f6aef294d000007"
  "cancellation_reason_id": "24f26283220c48af88ebf2a8"


Field Description
id id of the cancelled user product

Example Response

HTTP 200
    "id": "50f3ac249f6aef294d000007"