---
title: "Subscribe to Statement Updates"
method: POST
path: "/v1/users/{userId}/liabilities/subscriptions"
tags: ["Alerts & Monitoring"]
---

# Subscribe to Statement Updates

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

## Request

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

API will create subscriptions for liabilities given in the POST body.This process is asynchronous and you can get results by registering  for a webhooks

## Path parameters

- `userId` string, required

## Request body

- CreateLiabilitySubscriptionsRequest
  - `creditCards` LiabilitySubscriptionDefinition[]: The list of credit cards that will be subscribed.
    - `id` string, required: The ID of the liability
    - `subscriptions` LiabilitySubscription[], required: The list of capabilities to be subscribed for this liability.
      - `capability` 'STATEMENT_SUMMARY', required
  - `homeLoans` LiabilitySubscriptionDefinition[]: The list of home loans that will be subscribed.
    - `id` string, required: The ID of the liability
    - `subscriptions` LiabilitySubscription[], required: The list of capabilities to be subscribed for this liability.
      - `capability` 'STATEMENT_SUMMARY', required
  - `autoLoans` LiabilitySubscriptionDefinition[]: The list of auto loans that will be subscribed.
    - `id` string, required: The ID of the liability
    - `subscriptions` LiabilitySubscription[], required: The list of capabilities to be subscribed for this liability.
      - `capability` 'STATEMENT_SUMMARY', required
  - `studentLoans` LiabilitySubscriptionDefinition[]: The list of student loans that will be subscribed.
    - `id` string, required: The ID of the liability
    - `subscriptions` LiabilitySubscription[], required: The list of capabilities to be subscribed for this liability.
      - `capability` 'STATEMENT_SUMMARY', required
  - `personalLoans` LiabilitySubscriptionDefinition[]: The list of personal loans that will be subscribed.
    - `id` string, required: The ID of the liability
    - `subscriptions` LiabilitySubscription[], required: The list of capabilities to be subscribed for this liability.
      - `capability` 'STATEMENT_SUMMARY', required
  - `miscellaneousLiabilities` LiabilitySubscriptionDefinition[]: The list of miscellaneous liabilities that will be subscribed.
    - `id` string, required: The ID of the liability
    - `subscriptions` LiabilitySubscription[], required: The list of capabilities to be subscribed for this liability.
      - `capability` 'STATEMENT_SUMMARY', required

## Response `201`

Response for credit card subscription

- CreateLiabilitySubscriptionsResponse
  - `status` ResponseStatus, required
    - `code` number
    - `desc` string
    - `messages` Message[]
      - `desc` string, required
      - `type` 'ERROR' | 'WARN' | 'INFO'
  - `data` LiabilitySubscriptionResponse[], required
    - `subscriptionId` string, required: Id of the liability subscription
    - `creditCardId` string: If applicable, the id of the credit card liability
    - `autoLoanId` string: If applicable, the id of the auto loan liability
    - `homeLoanId` string: If applicable, the id of the home loan liability
    - `studentLoanId` string: If applicable, the id of the student loan liability
    - `personalLoanId` string: If applicable, the id of the personal loan liability
    - `miscellaneousLiabilityId` string: If applicable, the id of the miscellaneous liability id
    - `subscriptionType` 'STATEMENT_SUMMARY', required: Type of subscription
    - `userId` string, required: User id
    - `createdOn` number, required
    - `updatedOn` number, required

## Other responses

- `400`: Bad request — missing liabilities, duplicate ids, or unknown liability id
- `401`: Unauthorized response
- `404`: User not found error response to create subscription
- `409`: Conflict error response for credit card subscription
- `500`: Internal server error response

---

[API](https://skmtc.dev/spinwheel/apis/optimize.md) - [All operations](https://skmtc.dev/spinwheel/apis/optimize/llms.txt) - [OpenAPI document](https://skmtc.dev/spinwheel/apis/optimize/revisions/6222309663d2?raw)