🚧

Debt Profile Subscription Billing

Please be aware that establishing a subscription for a user via this endpoint will initiate billable events whenever a new credit report is fetched. Utilize your best judgement when calling this endpoint given that information.

Overview

To support the most up-to-date information for a user, we provide a function that will refresh the Debt Profile data that is provided back with each /v1/users endpoint call. This endpoint is typically leveraged to evaluate if there are new tradelines for a user or to fetch the latest information set, such as statementBalance, credit limit, credit score, etc.

Requesting a Debt Profile Subscription

To establish recurring Debt Profile Refreshes, there are two endpoints you should be aware of. One to subscribe a user, and one to determine the details of a user's subscription.

1. Subscribe a User to Debt Profile Refreshes - This endpoint will allow you to subscribe to weekly or monthly refreshes of a user's Debt Profile utilizing the bureau of your choice. This will help keep the user's Profile information up to date with the latest details from the bureau.
2. Get User Refresh Subscriptions - To check if a user is subscribed to Debt Profile Refreshes, you can get the subscription specifics with this endpoint.
3. Retrieve a User - Once the refresh request has been completed for an individual user, you will call the retrieve user endpoint and any data that was available to be updated will be updated at that point. Be aware that creditors typically only report once per month to the credit bureaus.

📘

Please subscribe the following webhooks:

• SUBSCRIPTION_ACTIVATED
• SUBSCRIPTION_FAILED
• USER_CREDIT_PROFILE_TRANSACTION
• USER_CREDIT_PROFILE_TRANSACTION_FAILED

Webhooks guide

Webhooks API reference

Recommended Refresh Cadence

As a general rule, we recommend refreshing the user once per month for use cases with an ongoing need for up-to-date user liabilities. As noted, the creditors only report to the bureaus once per month and at different intervals.

A weekly cadence is also available if agreed upon contractually. If your use case has a need for more frequent ad-hoc refreshes intra-month, this can be supported but please reach out to your Spinwheel contact to review best practices before you proceed with this.

If users are already subscribed to Debt Profile Refreshes and you would like to make an update to the cadence, you will need to delete the existing subscription, and then create a new subscription.