Add Entitlement Subscription | Tradovate Partner API

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.

### 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).

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 or null<=8192 characters

Non-empty if the request failed

errorCodeenum or null

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

entitlementSubscriptionobject or null

1	curl -X POST https://demo.tradovateapi.com/v1/userPlugin/addentitlementsubscription \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"entitlementId": 1
6	}'

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	}