Skip to main content
Skip table of contents

Account data model

NameTypeDescriptionAlways available
accessPointUIDIntegerThe unique access point identifier within the SDP. Can be used to request the full access point details from the SDP using the Access Point service. An access point provides details on the location the device resides in and how it should connect to the platform.Yes
accountNumberString
(max 20 chars)
The account number. Usually provided by the service provider.Yes
accountProfileUIDInteger

The unique account profile identifier within the SDP. This profile is used to specify the maximum number of allowed devices, device activations, and concurrent OTT streams.

   Available from SMSDomain-1.3 and above.

No
address1String
(max 150 chars)
First line of address.No
address2String
(max 150 chars)
Second line of address.No
cityStringAddress city name.No
countryString
(max 50 chars)
Address country.No
countyString
(max 100 chars)
Address county.No
creditLimitDoubleThe maximum spend per globally-specified credit interval, for example, a calendar month. If empty, the account will be able to make unlimited purchases.No
creditSpentDoubleThe credit spent so far in the current time period.No
creditSpentRSString

Not relevant to clients. Used by billing jobs.

   Available from SMSDomain-1.3 and above.

No
firstNameStringAccount holder first name.No
lastnameString
(max 100 chars)
Account holder last name.No
localityString
(max 100 chars)
Address locality, that is, area name.No
maxMPDeviceAllowedIntegerThe number of open devices associated with the account cannot exceed this value, if set.No
maxUserAllowedIntegerThe number of users associated with the account cannot exceed this value, if set.No
npvrProfileString
(max 32 chars)

The network PVR profile used for this account.

   Available from SMSDomain-1.3 and above.

No
passwordString
(max 20 chars)
Not typically used.No
postcodeString
(max 10 chars)
Postcode or zipcode.No
ppvStatusBoolean

Boolean to indicate whether the account has access to PPV services.

This field was known as isPPVEnabled in SMSDomain-1.2 and earlier.

No
rolloutProfileUIDLong

The identifier of the rollout profile that should be used for this account. A rollout profile indicates what software versions should be rolled out to an account's open devices.

  Available from SMSDomain-1.3 and above.

Yes
statusString

The account status. One of:

  • ACTIVE
  • CANCELLED
  • INACTIVE
  • RESTRICTED
  • SUSPENDED

Only accounts that are active or restricted will be able to sign on to the system, therefore the status is largely irrelevant to a client UI application. For details see: Account and STB Status.

Yes
titleStringAccount holder title.No
UIDIntegerUnique account identifier within the SDP. Can be used to query other APIs in the SDP, but not against any other modules or systems.Yes
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.