Suspending a third-party product entitlement

Overview

Request

To suspend a third-party product entitlement, the self-care portal should send a POST request to:

https://<host>:<port>/tpes/v1/operator/entitlements/{entitlementId}/actions/suspend

Headers

• x-correlation-id  – identifier for logging, to correlate messages across a call flow

• Authorization – Keycloak access token (see Accessing operator APIs using Keycloak)

• Content-Type: application/json

Mandatory arguments

• entitlementId – the ID of the entitlement to be suspended

Optional arguments

None

Response

A successful request returns an HTTP 200 status.

If the request is awaiting confirmation from the third-party provider, the request returns an HTTP 202 status.

A bad request returns an HTTP 400 status.

If the specified entitlement does not exist, the request returns an HTTP 404 status.

See also

Third Party Entitlement Service (TPES) API documentation