OpenTV ENTera & OpenTV Platform Documentation

View a single subscription

Request

To view the details of a single subscription, send a GET request to:

https://<host>:<port>/orders/v1/subscriptions/{subscriptionId}

Mandatory fields (in URL)

  • subscriptionId – the ID of the subscription

Response

A successful request returns an HTTP 200 status. The body of the response contains the whole subscription object.

A bad request returns an HTTP 400 status.

A request to view a subscription that does not exist returns an HTTP 404 status.

Example

A successful request returns a payload that looks like this:

{
  "accountId": "bob1",
  "deviceId": "iPhone-123456789",
  "originId": "MPP",
  "status": "ACTIVE",
  "expiryDate": {},
  "currency": "string",
  "creationDate": {},
  "modifiedDate": {},
  "purchasableType": "string",
  "subscriptionId": "string",
  "bundleId": "bf8838c9-9722-4f62-aea8-a2bd00df6271",
  "signupVersion": 0,
  "bundlePrice": 0
}

See also

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