Add new users to a subscription

This article describes how to add a new user to the subscription, get a list of the subscription members and remove the user from the subscription.

Getting started

You will need the following tools and features:

Knowledge on how to use API key in FastReport Corporate Server.

This article does not include the information about authentication and authorization.
The curl tool.

Any other REST client will work, however, the examples are provided for curl.
Active subscription for FastReport.Cloud with two slots for the user.
Internet access.

Remark

Please, note: You can add a user to a subscription only by the user's identifier.

Instructions

To add a new user to a subscription, a subscription identifier is required.

Get your subscription identifier by GET request to https://fastreport.cloud/api/manage/v1/Subscriptions?skip=0&take=10.

A sample request.

curl -X GET "https://fastreport.cloud/api/manage/v1/Subscriptions?skip=0&take=10" -H "accept: text/plain"

A sample response.

{
  "subscriptions": [
    {
      "id": "5fa919fa292a8300019349bc",
      "name": "Awesome Corp",
      "current": {
        "startTime": "2020-11-17T10:22:58.584Z",
        "endTime": "2025-11-17T10:22:58.584Z",
        "plan": {
          "id": "5f43924b0231500001225686",
          "isActive": false,
          "displayName": "The greatest power",
          "timePeriodType": "Year",
          "timePeriod": 5,
          "readonlyTimeLimitType": "Second",
          "readonlyTimeLimit": 0,
          "templatesSpaceLimit": 1048576000,
          "reportsSpaceLimit": 1048576000,
          "exportsSpaceLimit": 1048576000,
          "fileUploadSizeLimit": 1048576000000,
          "dataSourceLimit": 10,
          "maxUsersCount": 10,
          "hasSpaceOverdraft": false,
          "groupLimit": 5,
          "onlineDesigner": true,
          "isDemo": false,
          "urlToBuy": "https://fast-report.com",
          "unlimitedPage": true,
          "pageLimit": 15
        }
      },
      "old": [],
      "templatesFolder": {
        "folderId": "5fa919f9292a8300019349b9",
        "bytesUsed": 1668491
      },
      "reportsFolder": {
        "folderId": "5fa919f9292a8300019349ba",
        "bytesUsed": 6085990
      },
      "exportsFolder": {
        "folderId": "5fa919fa292a8300019349bb",
        "bytesUsed": 8336710
      }
    }
  ],
  "count": 1,
  "skip": 0,
  "take": 10
}

The subscription identifier from the example above is 5fa919fa292a8300019349bc.

To add a new user, make a PUT request https://fastreport.cloud/api/manage/v1/Subscriptions/{subscriptionId }/users/{userId} substituting {subscriptionId} with the subscription identifier and {userId} — with the user identifier.

A sample request.
```
curl -X PUT "https://fastreport.cloud/api/manage/v1/Subscriptions/5fa919fa292a8300019349bc/users/5af5a8dc-8cb0-40f9-ac99-ca2533fa4492" -H "accept: text/plain"
```
In response, you will receive an empty message with the status code OK 200.

To get a list of users, make a GET request to https://fastreport.cloud/api/manage/v1/Subscriptions/{id}/users?skip=0&take=10, substituting {id} with subscription identifier.