Add Entitlement Subscription | Partner Developer Platform

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

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

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

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

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