Note: This data structure is deprecated, and will be replaced in Q3/4 2017 with a new service which structures the data differently.
A user subs status resource is represented in the FT API as a JSON data structure, as shown below. The following example shows all possible fields a user products resource can contain.
{ “b2b”: { “activeLicences”: [ {“accessLicenceId”: “46de75d7-4f1f-45ee-87ef-16363cc5e147”} ], “acquisitionContext”: null, “active”: false }, “b2c”: { “triallist”: false, “active”: true, “subscriptions”: [ { “trial”: false, “status”: “Active”, “effectiveStartDate”: “2016-06-02T00:00:00Z”, “effectiveEndDate”: null } ] }, “totalLicenceCount”: 2, “staff”: false }
User Subs Status Resource Properties
Property Name | Value | Description |
---|---|---|
b2b | json object | collection of data related to a user’s ‘B2B’ status |
b2b.activeLicences | array of json objects | list of B2B licences of which the user is a seatholder |
b2b.acquisitionContext | string | n/a |
b2b.active | boolean | true if the user is a seatholder on an active B2B licence |
b2c | json object | collection of data related to a user’s ‘B2C’ status |
b2c.triallist | boolean | true is user has an active trial subscription |
b2c.active | true | true if the user is seatholder on at least one active B2C licence |
b2c.subscriptions | array of json objects | |
totalLicencecount | int | total number of licences (of any type and status) on which the user is a seatholder. Useful to distinguish lapsed subscribers from those who have never had a B2C sub. |
staff | boolean | true if the user holds a seat on the FT staff licence. |