GET /users/{userId}/subs-status

Purpose

Retrieve the user’s subscription status.

Note: This data structure is deprecated, and will be replaced in Q3/4 2017 with a new service which structures the data differently.

Request

Resource URL

GET https://api.ft.com/users/{userId}/subs-status

For security reasons requests must be made over HTTPS.

Parameters

Path ParamValue
userId
The unique identifier for the user whose subs status is to be retrieved

Request Headers

HeaderValue
X-Api-Key <API key value>

Request Body

Not supported.

Response

Response Body

A JSON representation of the user’s Subs Status Resource an example of which is as below:

{
  “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
}

HTTP Status Codes

Http StatusDescription
200 Ok The user’s subscription status resource for the supplied userId was returned successfully. 
400 Bad Request The request was invalid. You may refer to Error Response Object returned for details around why the request was invalid.
403 Forbidden Invalid API key
404 Not Found No user record for the supplied userId was found.
500 Service unavialable. Please try again later.