Skip to content

/cancel_userproduct

/me/cancel_userproduct

Target audience: Developers

Introduction

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)

URI

Environment URI
Stage https://payway-api.stage.adeprimo.se/external/api/v1/me/cancel_userproduct
Production https://backend.worldoftulo.com/external/api/v1/me/cancel_userproduct

Required scope

1
/external/me/w

Parameters

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

1
2
3
4
5
6
7
8
9
curl --request PUT \
  --url https://payway-api.stage.adeprimo.se/external/api/v1/me/cancel_userproduct \
  --header 'accept: application/json' \
  --header 'authorization: Bearer token' \
  --header 'content-type: application/json' \
  --data '{
  "id": "50f3ac249f6aef294d000007"
  "cancellation_reason_id": "24f26283220c48af88ebf2a8"
}'

Response

Field Description
id id of the cancelled user product

Example Response

1
2
3
4
HTTP 200
{
    "id": "50f3ac249f6aef294d000007"
}