Restore Plugin Autorenewal
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
pluginNamewhose auto-renewal is turned off (here, a subscription that expires today in Central Time counts as expired). This returnsHTTP 200with"No plugins found"inerrorText. - The user has more than one such subscription. This returns
HTTP 200with"Multiple plugins found"inerrorText, and nothing changes. - The request includes
userIdand the caller isn’t an organization administrator. This returnsHTTP 401even whenuserIdis the caller’s own ID, so omituserIdto act on your own subscription. - No user matches
userId, or you can’t access that user. Both returnHTTP 404with 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
Usersresource. This returnsHTTP 401with"Access is denied". pluginNameis empty or longer than 64 characters, oruserIdisn’t greater than 0. These returnHTTP 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
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
Response
Non-empty if the request failed