> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://partner.ninjatrader.com/eval/api/rest-api-endpoints/users/add-entitlement-subscription/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://partner.ninjatrader.com/_mcp/server.

# Add Entitlement Subscription

POST https://live.tradovateapi.com/v1/userPlugin/addentitlementsubscription
Content-Type: application/json

### Add an entitlement subscription for a user.**Available to:** All authenticated users for their own subscriptions; organization administrators to add a subscription for another user in their organization**Environments:** Live**[Rate Limit](/overview/core-concepts/rate-limits):** No endpoint-specific limit***Note***: The [/user/createEvaluationUsers](/api/rest-api-endpoints/users/create-evaluation-users) endpoint replaces [/user/signUpOrganizationMember](/api/rest-api-endpoints/users/sign-up-organization-member), [/user/addTradovateSubscription](/api/rest-api-endpoints/users/add-tradovate-subscription), and [/userPlugin/addEntitlementSubscription](/api/rest-api-endpoints/users/add-entitlement-subscription).Use this endpoint with Add-ons to purchase entitlements such as Market Replay. Pass the `entitlementId` of the entitlement you want to assign to the user.Do not pass entitlement ID 22 (GroupTrade) to this endpoint. Requests that pass entitlement ID 22 fail. Entitlement ID 22 is deprecated: Group Trading is now standard for any user with two or more accounts in the same environment and no longer requires an entitlement.

Reference: https://partner.ninjatrader.com/eval/api/rest-api-endpoints/users/add-entitlement-subscription

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Body (application/json)

This endpoint expects an AddEntitlementSubscription.

- `entitlementId` (long, required)
- `creditCardId` (long, optional)
- `accountId` (long, optional)
- `userId` (long, optional)
- `nonProSigned` (boolean, optional)

## Response

### 200

EntitlementSubscriptionResponse

- `errorText` (string, optional) — Non-empty if the request failed
- `errorCode` (enum, optional) — ConflictWithExisting, DowngradeNotAllowed, IncompatibleCMEMarketDataSubscriptionPlans, IncorrectPaymentMethod, InsufficientFunds, PaymentProviderError, PlanDiscontinued, SingleTrialOnly, Success, UnknownError
  - Allowed values: `ConflictWithExisting`, `DowngradeNotAllowed`, `IncompatibleCMEMarketDataSubscriptionPlans`, `IncorrectPaymentMethod`, `InsufficientFunds`, `PaymentProviderError`, `PlanDiscontinued`, `SingleTrialOnly`, `Success`, `UnknownError`
- `entitlementSubscription` (UserPlugin, optional)

## Types

### UserPlugin

- `userId` (long, required)
- `timestamp` (datetime, required)
- `planPrice` (double, required)
- `pluginName` (string, required)
- `approval` (boolean, required)
- `startDate` (TradeDate, required)
- `paidAmount` (double, required)
- `id` (long, optional)
- `cashBalanceLogId` (long, optional)
- `accountId` (long, optional)
- `entitlementId` (long, optional)
- `expirationDate` (TradeDate, optional)
- `autorenewal` (boolean, optional)
- `planCategories` (string, optional)
- `rebate` (double, optional)

### TradeDate

- `year` (integer, required)
- `month` (integer, required)
- `day` (integer, required)

## Examples

**Request**

```json
{
  "entitlementId": 1
}
```

**Response**

```json
{
  "errorText": "string",
  "errorCode": "ConflictWithExisting",
  "entitlementSubscription": {
    "userId": 1,
    "timestamp": "2024-01-15T09:30:00Z",
    "planPrice": 1.1,
    "pluginName": "string",
    "approval": true,
    "startDate": {
      "year": 1,
      "month": 1,
      "day": 1
    },
    "paidAmount": 1.1,
    "id": 1,
    "cashBalanceLogId": 1,
    "accountId": 1,
    "entitlementId": 1,
    "expirationDate": {
      "year": 1,
      "month": 1,
      "day": 1
    },
    "autorenewal": true,
    "planCategories": "string",
    "rebate": 1.1
  }
}
```

**SDK Code**

```python
import requests

url = "https://live.tradovateapi.com/v1/userPlugin/addentitlementsubscription"

payload = { "entitlementId": 1 }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://live.tradovateapi.com/v1/userPlugin/addentitlementsubscription';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"entitlementId":1}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://live.tradovateapi.com/v1/userPlugin/addentitlementsubscription"

	payload := strings.NewReader("{\n  \"entitlementId\": 1\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://live.tradovateapi.com/v1/userPlugin/addentitlementsubscription")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"entitlementId\": 1\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://live.tradovateapi.com/v1/userPlugin/addentitlementsubscription")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"entitlementId\": 1\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://live.tradovateapi.com/v1/userPlugin/addentitlementsubscription', [
  'body' => '{
  "entitlementId": 1
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://live.tradovateapi.com/v1/userPlugin/addentitlementsubscription");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"entitlementId\": 1\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["entitlementId": 1] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://live.tradovateapi.com/v1/userPlugin/addentitlementsubscription")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```