Add Entitlement Subscription

POST

https://demo.tradovateapi.com/v1/userPlugin/addentitlementsubscription

POST

/v1/userPlugin/addentitlementsubscription

const url = 'https://demo.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);
}

200Successful

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

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: No endpoint-specific limit

Note: The /user/createEvaluationUsers endpoint replaces /user/signUpOrganizationMember, /user/addTradovateSubscription, and /userPlugin/addEntitlementSubscription.

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.

### 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. <Warning>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.</Warning>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

entitlementIdlongRequired

creditCardIdlongOptional

accountIdlongOptional

userIdlongOptional

nonProSignedbooleanOptional

Response

EntitlementSubscriptionResponse

errorTextstringOptional<=8192 characters

Non-empty if the request failed

errorCodeenumOptional

ConflictWithExisting, DowngradeNotAllowed, IncompatibleCMEMarketDataSubscriptionPlans, IncorrectPaymentMethod, InsufficientFunds, PaymentProviderError, PlanDiscontinued, SingleTrialOnly, Success, UnknownError

entitlementSubscriptionobjectOptional