OpenTV ENTera & OpenTV Platform Documentation

Subscribe to a bundle for a customer

Request

To subscribe to a bundle on behalf of a customer (for example, when a customer makes a purchase by phone), send a POST request to:

http://<host>:<port>/orders/operator/v1/account/{accountId}/subscriptions

Mandatory fields

  • accountId (in URL) – the ID of the customer account

  • deviceID (in body) – the ID of the device

  • originId – the ID of the system generating the request

  • bundleId – the ID of the bundle being purchased/subscribed to

You can specify the price for the bundle as part of the request (in the bundlePrice field), for example, to give the customer a discount. If you do not supply a price, the regular, defined price for the bundle is used.

For all available fields, see Orders API documentation.

Example

A request with this payload subscribed to specified bundle on behalf of the user (whose account ID is specified in the URL):

{
  "deviceId": "iPhone-123456789",
  "originId": "MPP",
  "bundleId": "bf8838c9-9722-4f62-aea8-a2bd00df6271"
}

Response

A successful request returns an HTTP 201 status. The response includes the complete order object.

An unsuccessful request returns an HTTP 400 status if there was a problem with the request.

An unauthorised request returns an HTTP 401 status.

See also

For full details of this API, see Orders API documentation.