v1

latestOpenAPI 3.0.02026-07-2459256884.4 KB

Debt Profile

Get Refresh Subscriptions

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

get/v1/users/{userId}/subscriptions

Path parameters

userIdstring required

Query parameters

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

Filter subscriptions by status.

Response

List of subscriptions for the user

subscriptionIdstring uuid required

Unique identifier for the subscription

subscriptionType'DEBT_PROFILE.REFRESH' required

The type of subscription

userIdstring uuid required

User identifier

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

Subscription status

createdOnnumber required

Timestamp when the subscription was created

updatedOnnumber required

Timestamp when the subscription was last updated

Example response

[
  {
    "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
  }
]