Add Entitlement Subscription | Partner Developer Platform

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);
}

{
  "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,
    "creditCardTransactionId": 1,
    "cashBalanceLogId": 1,
    "creditCardId": 1,
    "accountId": 1,
    "entitlementId": 1,
    "expirationDate": {
      "year": 1,
      "month": 1,
      "day": 1
    },
    "autorenewal": true,
    "planCategories": "string"
  }
}

### For use with Add-ons, allows for purchase of entitlements such as Market Replay. ***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).

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);
}

{
  "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,
    "creditCardTransactionId": 1,
    "cashBalanceLogId": 1,
    "creditCardId": 1,
    "accountId": 1,
    "entitlementId": 1,
    "expirationDate": {
      "year": 1,
      "month": 1,
      "day": 1
    },
    "autorenewal": true,
    "planCategories": "string"
  }
}

For use with Add-ons, allows for purchase of entitlements such as Market Replay.

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

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

Response

EntitlementSubscriptionResponse

errorTextstring<=8192 characters

Non-empty if the request failed

errorCodeenum

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

entitlementSubscriptionobject

1	const url = 'https://demo.tradovateapi.com/v1/userPlugin/addentitlementsubscription';
2	const options = {
3	method: 'POST',
4	headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
5	body: '{"entitlementId":1}'
6	};
7
8	try {
9	const response = await fetch(url, options);
10	const data = await response.json();
11	console.log(data);
12	} catch (error) {
13	console.error(error);
14	}

1	{
2	"errorText": "string",
3	"errorCode": "ConflictWithExisting",
4	"entitlementSubscription": {
5	"userId": 1,
6	"timestamp": "2024-01-15T09:30:00Z",
7	"planPrice": 1.1,
8	"pluginName": "string",
9	"approval": true,
10	"startDate": {
11	"year": 1,
12	"month": 1,
13	"day": 1
14	},
15	"paidAmount": 1.1,
16	"id": 1,
17	"creditCardTransactionId": 1,
18	"cashBalanceLogId": 1,
19	"creditCardId": 1,
20	"accountId": 1,
21	"entitlementId": 1,
22	"expirationDate": {
23	"year": 1,
24	"month": 1,
25	"day": 1
26	},
27	"autorenewal": true,
28	"planCategories": "string"
29	}
30	}