--- title: "List Subscriptions by User" method: GET path: "/users/{userID}/subscriptions" tags: ["Subscriptions"] deprecated: true --- # List Subscriptions by User `GET /users/{userID}/subscriptions` ## Request - Base URL: `https://bo-api.drivewealth.io/back-office` - URL: `https://bo-api.drivewealth.io/back-office/users/{userID}/subscriptions` - Auth: HTTP bearer > **Deprecated.** Retrieves all User's Subscriptions by User This API is now deprecated as the Subscriptions product is no longer supported. ## Path parameters - `userID` string, required ## Response `200` Retrieving all User's Subscription was Successful. - UserSubscription[]: A list of the user's current subscriptions. - `id` string: The unique identifier that identifies the user's subscription. - `accountDetails` object - `accountID` string: ![sensitive](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NSIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDg1IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtU0VOU0lUSVZFIiB4MT0iMCIgeTE9IjAiIHgyPSIwIiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2I0NTMwOSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iIzkyNDAwZSIvPjwvbGluZWFyR3JhZGllbnQ+PGZpbHRlciBpZD0iZ2xvdy1TRU5TSVRJVkUiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iODMiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjOTI0MDBlIiBmaWx0ZXI9InVybCgjZ2xvdy1TRU5TSVRJVkUpIiBvcGFjaXR5PSIwLjU1Ii8+PHJlY3QgeD0iMC41IiB5PSIwLjUiIHdpZHRoPSI4NCIgaGVpZ2h0PSIxOSIgcng9IjEwIiBmaWxsPSJ1cmwoI2dyYWQtU0VOU0lUSVZFKSIgc3Ryb2tlPSIjOTI0MDBlIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNMTAgNC44TDE0IDYuMlYxMEMxNCAxMi43IDEyLjMgMTQuNCAxMCAxNS40QzcuNyAxNC40IDYgMTIuNyA2IDEwVjYuMloiIGZpbGw9IiNmZmZmZmYiIGZpbHRlcj0idXJsKCNnbG93LVNFTlNJVElWRSkiIG9wYWNpdHk9IjAuNSIvPjxwYXRoIGQ9Ik0xMCA0LjhMMTQgNi4yVjEwQzE0IDEyLjcgMTIuMyAxNC40IDEwIDE1LjRDNy43IDE0LjQgNiAxMi43IDYgMTBWNi4yWiIgZmlsbD0iI2ZmZmZmZiIvPjx0ZXh0IHg9IjE4IiB5PSIxMy41IiBmb250LWZhbWlseT0iSGVsdmV0aWNhLCBBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMCIgZm9udC13ZWlnaHQ9IjcwMCIgbGV0dGVyLXNwYWNpbmc9IjAuNiIgZmlsbD0iI2ZmZmZmZiI+U0VOU0lUSVZFPC90ZXh0Pjwvc3ZnPg==) The user's unique account identifier. - `accountNo` string: ![sensitive](data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4NSIgaGVpZ2h0PSIyMCIgdmlld0JveD0iMCAwIDg1IDIwIj48ZGVmcz48bGluZWFyR3JhZGllbnQgaWQ9ImdyYWQtU0VOU0lUSVZFIiB4MT0iMCIgeTE9IjAiIHgyPSIwIiB5Mj0iMSI+PHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2I0NTMwOSIvPjxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iIzkyNDAwZSIvPjwvbGluZWFyR3JhZGllbnQ+PGZpbHRlciBpZD0iZ2xvdy1TRU5TSVRJVkUiIHg9Ii02MCUiIHk9Ii02MCUiIHdpZHRoPSIyMjAlIiBoZWlnaHQ9IjIyMCUiPjxmZUdhdXNzaWFuQmx1ciBzdGREZXZpYXRpb249IjIuMiIvPjwvZmlsdGVyPjwvZGVmcz48cmVjdCB4PSIxIiB5PSIxIiB3aWR0aD0iODMiIGhlaWdodD0iMTgiIHJ4PSI5IiBmaWxsPSIjOTI0MDBlIiBmaWx0ZXI9InVybCgjZ2xvdy1TRU5TSVRJVkUpIiBvcGFjaXR5PSIwLjU1Ii8+PHJlY3QgeD0iMC41IiB5PSIwLjUiIHdpZHRoPSI4NCIgaGVpZ2h0PSIxOSIgcng9IjEwIiBmaWxsPSJ1cmwoI2dyYWQtU0VOU0lUSVZFKSIgc3Ryb2tlPSIjOTI0MDBlIiBzdHJva2Utd2lkdGg9IjEiLz48cGF0aCBkPSJNMTAgNC44TDE0IDYuMlYxMEMxNCAxMi43IDEyLjMgMTQuNCAxMCAxNS40QzcuNyAxNC40IDYgMTIuNyA2IDEwVjYuMloiIGZpbGw9IiNmZmZmZmYiIGZpbHRlcj0idXJsKCNnbG93LVNFTlNJVElWRSkiIG9wYWNpdHk9IjAuNSIvPjxwYXRoIGQ9Ik0xMCA0LjhMMTQgNi4yVjEwQzE0IDEyLjcgMTIuMyAxNC40IDEwIDE1LjRDNy43IDE0LjQgNiAxMi43IDYgMTBWNi4yWiIgZmlsbD0iI2ZmZmZmZiIvPjx0ZXh0IHg9IjE4IiB5PSIxMy41IiBmb250LWZhbWlseT0iSGVsdmV0aWNhLCBBcmlhbCwgc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMCIgZm9udC13ZWlnaHQ9IjcwMCIgbGV0dGVyLXNwYWNpbmc9IjAuNiIgZmlsbD0iI2ZmZmZmZiI+U0VOU0lUSVZFPC90ZXh0Pjwvc3ZnPg==) The user's unique account number, that is human readable. - `accountType` 'LIVE': The type of account that has been created. - `accountManagementType` AccountManagementTypeObject - `name` 'SELF' | 'ADVISORY' | 'RIA_MANAGED' | 'CUSTODIAL' | 'CUSTODIAL_MANAGED' | 'RESERVE' | 'RETIREMENT_TRADITIONAL_SELF' | 'RETIREMENT_TRADITIONAL_ADVISORY' | 'RETIREMENT_TRADITIONAL_RIA_MANAGED' | 'RETIREMENT_ROTH_SELF' | 'RETIREMENT_ROTH_ADVISORY' | 'RETIREMENT_ROTH_RIA_MANAGED' | 'TRUST_SELF' | 'TRUST_ADVISORY' | 'TRUST_RIA_MANAGED' | 'HSA_SELF' | 'HSA_ADVISORY' | 'HSA_RIA_MANAGED' | 'BUSINESS_SELF' | 'BUSINESS_ADVISORY' | 'BUSINESS_RIA_MANAGED' | 'TRUMP_SELF': The type of account who has trading authority. - `description` string: A custom description of the account management type. - `status` 'ACTIVE' | 'CANCELLED': The current status of the user's subscription. - `paymentSource` object - `source` string - `sourceType` string: The unique DriveWealth identifier that identifies each linked bank account. - `plan` object - `planID` string: The unique identifier that identifies the plan schedule. - `name` string: The name of the global name of the planned subscription. - `interval` 'MONTHLY' | 'QUARTERLY': The interval in which the user's linked bank account will be charged. - `intervalCount` 1 | 3: The interval in which the user's linked bank account will be charged represented as an integer value. - `amount` number: The amount the user's linked bank account will be charged. - `currency` 'USD': The name of the currency in abbreviation form. - `created` string - `started` string: The date and time that the subscription started. - `expires` string: The date and time that the subscription will expire; and stop charging the user's linked bank account. - `transactionHistory` TransactionRes[]: A list of all this historical subscriptions transactions charged to the user's linked bank account. - Transaction[]: A list of transactions. - `accountAmount` number: The amount of the transaction. - `accountBalance` number: The cash balance of the account at the time of the transaction. - `accountType` 'LIVE': The type of account that has been created. - `dividend` Dividend - `type` 'CASH' | 'STOCK' | 'RETURN_OF_CAPITAL' | 'DISTRIBUTION_LONG' | 'DISTRIBUTION_SHORT' | 'OTHER': The dividend type, whether a cash or stock dividend. - `amountPerShare` number: The amount of the dividend issued, per share. - `taxCode` 'FULLY_TAXABLE' | 'NON_TAXABLE' | 'TAX_EXEMPT' | 'null': Whether the dividend is taxable or not. - `dividendTax` object: An object containing details of a dividend withholding. - `rate` number: The Witholding rate associated with the dividend payment. - `type` 'FOREIGN_TAX' | 'NON_RESIDENTIAL_ALIEN' | 'OTHER': The type of tax associated with the withholding - `dnb` boolean: If false, the transaction was sent to inteliclear. Default is false. - `comment` string: A comment describing the transaction - `finTranID` string: The internal and unique transaction identification number. - `finTranTypeID` 'CSR' | 'CSD' | 'FEE' | 'JNLC' | 'CADJ' | 'INT' | 'SPUR' | 'SSAL' | 'MERGER_ACQUISITION' | 'DIV' | 'DIVTAX' | 'DIVNRA' | 'STCK' | 'COMM' | 'SPINOFF' | 'STOCK_SPLIT' | 'ACATS_CASH' | 'ACATS_STOCK' | 'CCPUR' | 'CCSAL' | 'SLIP' | 'DIVM' | 'PTP_WITHHOLDING': The abbreviated transaction type identifier. - `feeSec` number: The sec fee charged to an applicable sell order. Reference your fee schedule for SEC fee amounts per share. - `feeTaf` number: Trading activity fee (TAF) for an applicable sell order. Reference your fee schedule for TAF fee amounts per share. - `feeBase` number: The net fee amount of TAF and SEC Fees for a given sell order. - `feeXtraShares` number: Commission charged when the share quantity is greater than the base share amount. Reference your commission schedule for more info. - `feeExchange` number: An Exchange Fee applied to an order. - `fillQty` number: The quantity of shares filled for a transaction. - `fillPx` number: The fill price of the order for the given transaction. - `orderID` string: A unique DriveWealth order identifier created when an order is placed. - `mergerAcquisition` object: An object containing details of a corporate event, such as a merger or an acquisition. - `type` 'EXCHANGE_STOCK_CASH' | 'ADD_SHARES' | 'ADD_SHARES_CASH' | 'ADD_SHARES_REMOVE_CASH' | 'REMOVE_SHARES' | 'REMOVE_SHARES_CASH' | 'REMOVE_SHARES_ADD_CASH': The transaction result of the corporate event - `acquirer` object: Object containing details of the acquiring company - `id` string, uuid: A unique ID created by DriveWealth to identify a specific instrument. - `symbol` string: The instrument ticker symbol. - `name` string: The name of the acquiring company - `acquiree` object: Object containing details of the company being acquired - `id` string, uuid: A unique ID created by DriveWealth to identify a specific instrument. - `symbol` string: The instrument ticker symbol. - `name` string: The name of the company being acquired - `positionDelta` number: The delta in the number of shares due to the corporate action. --- [API](https://skmtc.dev/drivewealth/apis/money-movement-apis.md) - [All operations](https://skmtc.dev/drivewealth/apis/money-movement-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/drivewealth/apis/money-movement-apis/revisions/c94fbd154054?raw)