---
title: "Subscribe to Debt Profile Refresh"
method: POST
path: "/v1/users/{userId}/subscriptions"
tags: ["Debt Profile"]
---

# Subscribe to Debt Profile Refresh

`POST /v1/users/{userId}/subscriptions`

Subscribe to updates for a user.

## Path parameters

- `userId` string, required

## Request body

- CreateSubscriptionsRequest
  - `subscriptions` SubscriptionCreationItem[], required — Array of subscriptions to create.
    - `subscriptionType` 'DEBT_PROFILE.REFRESH', required — The type of subscription
    - `configuration` DebtProfileRefreshSubscriptionConfiguration, required
      - `refreshFrequency` 'MONTHLY' | 'WEEKLY', required — Refresh frequency
      - `creditReport` CreditReportConfiguration
        - `type` '1_BUREAU.FULL', required — Credit report type
        - `sourceBureau` 'Equifax' | 'TransUnion' — Source credit bureau
      - `creditScore` CreditScoreConfiguration
        - `model` 'VANTAGE_SCORE_3_0', required — Credit score model
        - `sourceBureau` 'Equifax' | 'TransUnion' — Source credit bureau

## Response `201`

List of subscription creation results

- union[]
  - union
    - SubscriptionCreatedResponse
      - `subscriptionId` string, uuid, required — Unique identifier for the subscription
      - `subscriptionType` 'DEBT_PROFILE.REFRESH', required — The type of subscription
      - `userId` string, uuid, required — User identifier
      - `status` 'PENDING' | 'ACTIVE' | 'INACTIVE', required — Subscription status
      - `configuration` DebtProfileRefreshSubscriptionConfiguration, required
        - `refreshFrequency` 'MONTHLY' | 'WEEKLY', required — Refresh frequency
        - `creditReport` CreditReportConfiguration
          - `type` '1_BUREAU.FULL', required — Credit report type
          - `sourceBureau` 'Equifax' | 'TransUnion' — Source credit bureau
        - `creditScore` CreditScoreConfiguration
          - `model` 'VANTAGE_SCORE_3_0', required — Credit score model
          - `sourceBureau` 'Equifax' | 'TransUnion' — Source credit bureau
      - `createdOn` number, required — Timestamp when the subscription was created
      - `updatedOn` number, required — Timestamp when the subscription was last updated
    - SubscriptionCreationFailedResponse
      - `subscriptionType` 'DEBT_PROFILE.REFRESH', required — The type of subscription
      - `userId` string, uuid, required — User identifier
      - `status` 'FAILED', required — Subscription status indicating the operation result
      - `configuration` DebtProfileRefreshSubscriptionConfiguration, required
        - `refreshFrequency` 'MONTHLY' | 'WEEKLY', required — Refresh frequency
        - `creditReport` CreditReportConfiguration
          - `type` '1_BUREAU.FULL', required — Credit report type
          - `sourceBureau` 'Equifax' | 'TransUnion' — Source credit bureau
        - `creditScore` CreditScoreConfiguration
          - `model` 'VANTAGE_SCORE_3_0', required — Credit score model
          - `sourceBureau` 'Equifax' | 'TransUnion' — Source credit bureau
      - `error` 'CONNECTION_NOT_FOUND' | 'BUREAU_SOURCE_CONFLICT' | 'SUBSCRIPTION_ALREADY_EXISTS' | 'INTERNAL_ERROR' | 'NO_DEFAULT_BUREAU' | 'UNSUPPORTED_BUREAU', required — Error code if subscription creation failed
      - `errorMessage` string, required — Error message if subscription creation failed

## Other responses

- `400` — Bad request response
- `401` — Unauthorized response
- `404` — Not found response
- `500` — Internal server error response

---

[API](https://skmtc.net/spinwheel/apis/discover.md) · [All operations](https://skmtc.net/spinwheel/apis/discover/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/spinwheel/discover/versions/55b90a2e1dd4/schema)