Subscriptions

List Subscriptions by User

Retrieves all User's Subscriptions by User

This API is now deprecated as the Subscriptions product is no longer supported.

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

Path parameters

userIDstring required

sensitive The User's unique identifier.

Response

Retrieving all User's Subscription was Successful.

idstring

The unique identifier that identifies the user's subscription.

Example response

[
  {
    "id": "subscription_123e4567-e89b-12d3-a456-00000000005b",
    "accountDetails": {
      "accountID": "123e4567-e89b-12d3-a456-000000000004.1234567890125",
      "accountNo": "FFFF000005",
      "accountType": "LIVE",
      "accountManagementType": {
        "name": "SELF",
        "description": "Self Directed Account"
      },
      "status": "ACTIVE",
      "paymentSource": {
        "sourceType": "bank_123e4567-e89b-12d3-a456-00000000004a"
      },
      "plan": {
        "planID": "plan_123e4567-e89b-12d3-a456-00000000005f",
        "name": "Monthly Subscription",
        "interval": "MONTH",
        "intervalCount": 1,
        "amount": 4.99,
        "currency": "USD"
      },
      "created": "2022-12-11T22:28:21.810Z",
      "started": "2022-12-11T22:28:21.810Z",
      "expires": "2022-12-11T22:28:21.810Z",
      "transactionHistory": []
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.