SPspinwheel
Debt Profile

Get Refresh Subscriptions

Changed on

Get a list of all subscriptions for a user. Optional query parameters allow filtering by status or subscription type.

get/v1/users/{userId}/subscriptions

Request

  • Base URL
    https://sandbox-api.spinwheel.io
  • URL
    https://sandbox-api.spinwheel.io/v1/users/{userId}/subscriptions
  • Auth
    API key in header Authorization

Path parameters

userIdstring required

Query parameters

status'PENDING' | 'ACTIVE' | 'INACTIVE'

Filter subscriptions by status.

Response

List of subscriptions for the user

Example response

{
  "status": {
    "code": 200,
    "desc": "success",
    "messages": [
      {
        "desc": "Example description"
      }
    ]
  },
  "data": [
    {
      "subscriptionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "subscriptionType": "DEBT_PROFILE.REFRESH",
      "userId": "1c9d0f64-1234-4562-b3fc-2c963f66afad",
      "status": "ACTIVE",
      "configuration": {
        "refreshFrequency": "MONTHLY",
        "creditReport": {
          "type": "1_BUREAU.FULL",
          "sourceBureau": "TransUnion"
        },
        "creditScore": {
          "model": "VANTAGE_SCORE_3_0",
          "sourceBureau": "TransUnion"
        }
      },
      "createdOn": 1757055616000,
      "updatedOn": 1757055616000
    }
  ]
}

Changes

  • aa032469622fRevision changes
    • breaking

      the response's body type changed from array to object for status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status