Cancel Plugin Autorenewal
Cancel 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 off auto-renewal for a user’s plugin subscription. The subscription stays active through its current term but doesn’t renew at the end of it.
Pass the pluginName and, optionally, a cancelReason. To act on another user, an organization administrator also passes that user’s userId; omit userId to act on your own subscription.
Every renewing subscription the user has to pluginName is cancelled. The response returns the last one cancelled in entitlementSubscription.
Common Failure Scenarios
- The user has no unexpired, unarchived subscription to
pluginNamethat’s set to renew (a subscription that expires today counts as unexpired until 19:00 Central Time). The call still succeeds (HTTP 200with noerrorText), but the response has noentitlementSubscriptionbecause nothing was cancelled. If the subscription is already cancelled and you send a non-blankcancelReason, the reason is recorded, and the response still has noentitlementSubscription. - 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,cancelReasonis longer than 8,192 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 back on, call restorePluginAutorenewal.
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