Changing the product associated with a third-party product entitlement

Overview

When a customer upgrades or downgrades their third-party product subscription (for example, if they upgrade from Netflix Standard to Netflix Premium), the existing entitlement is still used, but the CRM system must notify OpenTV Platform that the product associated with it has changed.

Each such product variant must be set up as a separate product in OpenTV Platform – see Creating a third-party product.

Request

To change the product associated with a third-party product entitlement, the CRM system should send a POST request to:

BASH

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

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 (in URL) – the ID of the entitlement for which the product is to be changed
productId (in body) – the ID of the new product to be associated with the entitlement

Optional arguments

None

Example

A POST request with the following body will change the product associated with the entitlement whose ID is specified in the URL:

JSON

{
  "productId": "example_product_002"
}

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. When OPF receives this confirmation, it notifies your CRM system – see Handling third-party product entitlement changes.

A bad request returns an HTTP 400 status.

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