Cancel Tradovate Subscription

View as Markdown
### Cancel a Tradovate Trader membership plan. **Available to:** All authenticated users **Environments:** Live **[Rate Limit](/api/authentication#request-rate-limits-and-time-penalties):** No endpoint-specific limit Cancels a user's Tradovate Trader membership subscription. Identify the subscription with `tradovateSubscriptionId` (the integer entity ID). Optionally provide a `cancelReason` for record-keeping, and set `expire` to control whether the subscription is canceled immediately or allowed to lapse at the end of its current period. This is a Live-only endpoint; calling it on Demo returns an environment error directing you to the Live host. The request is forwarded to the license service, which performs the cancellation and returns the result. On success, the response returns the updated `tradovateSubscription` with an empty `errorText`. On a handled failure, the response carries a non-empty `errorText` (and may include an `errorCode`) describing the problem. **Common Failure Scenarios** - The endpoint is called on Demo rather than Live (returns an environment error). - The `tradovateSubscriptionId` doesn't exist or isn't accessible to the caller. - The license service is unavailable or returns an error during cancellation. - The access token is missing or invalid (returns `HTTP 401`). **Error Messages** | `errorText` | Trigger | |-------------|---------| | `"This endpoint should be called on live.tradovateapi.com"` | The request was sent to the Demo host. | | Non-empty `errorText` | The request failed; the field describes the reason. |

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
tradovateSubscriptionIdlongRequired
cancelReasonstringOptional<=8192 characters
expirebooleanOptional

Response

TradovateSubscriptionResponse
errorTextstring<=8192 characters

Non-empty if the request failed

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