Skip to navigation

Restore Plugin Autorenewal

View as Markdown

Restore auto-renewal for a user’s plugin subscription.

Available to: Traders (own records); organization administrators (any user in their organization)

Environments: Live

Rate Limit: No endpoint-specific limit

Turn auto-renewal back on for a user’s plugin subscription, reversing a prior cancellation. Pass the pluginName. To act on another user, an organization administrator also passes that user’s userId; omit userId to act on your own subscription. On success, the response returns the updated entitlementSubscription.

Common Failure Scenarios

  • The user has no unexpired, unarchived subscription to pluginName whose auto-renewal is turned off (here, a subscription that expires today in Central Time counts as expired). This returns HTTP 200 with "No plugins found" in errorText.
  • The user has more than one such subscription. This returns HTTP 200 with "Multiple plugins found" in errorText, and nothing changes.
  • The request includes userId and the caller isn’t an organization administrator. This returns HTTP 401 even when userId is the caller’s own ID, so omit userId to act on your own subscription.
  • No user matches userId, or you can’t access that user. Both return HTTP 404 with an empty body. Most organization administrators can’t access users outside their organization.
  • The caller’s user type, or the API key’s permissions, don’t include full access to the Users resource. This returns HTTP 401 with "Access is denied".
  • pluginName is empty or longer than 64 characters, or userId isn’t greater than 0. These return HTTP 400.
  • The request is sent to Demo. This endpoint runs on Live only, so Demo returns HTTP 501.

To turn auto-renewal off, call cancelPluginAutorenewal.

This endpoint returns HTTP 200 for both successful and rejected requests, so check the errorText field to confirm the result. Other failures, such as denied access or an invalid request, return their own HTTP status.

Error Messages

MessageResponseTrigger
"Plugin Name should be specified"400pluginName is empty or null.
"Plugin Name should be no longer than 64"400pluginName is longer than 64 characters.
"User Id should be greater than 0"400userId is included and isn’t greater than 0.
"mustBeOrganizationAdmin"401The request includes userId and the caller isn’t an organization administrator.
"Access is denied"401The caller’s user type, or the API key’s permissions, don’t include full access to the Users resource.
(no message text)404No user matches userId, or you can’t access that user (most organization administrators can’t access users outside their organization).
"This endpoint should be called on live.tradovateapi.com"501Called on the Demo environment.
"No plugins found"200 (in errorText)The user has no unexpired, unarchived subscription to pluginName whose auto-renewal is turned off.
"Multiple plugins found"200 (in errorText)The user has more than one unexpired, unarchived subscription to pluginName whose auto-renewal is turned off.
"Internal Error. Error ID: {id}"200 (in errorText)The restore failed unexpectedly. The error ID is generated per request.
"Request timeout. Error ID: {id}"200 (in errorText)The restore didn’t respond in time. The error ID is generated per request.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
pluginNamestringRequired<=64 characters
userIdlongOptional

Response

EntitlementSubscriptionResponse
errorTextstringOptional<=8192 characters

Non-empty if the request failed

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