- Preview The endpoint can change without advance notice, including breaking changes.
- Beta Breaking changes are announced on the Upcoming Changes page before they ship.
- GA Changes follow the commitments on Versioning and Backwards Compatibility.
User Credit Balance Terms Block
Why We Made This Change
An API standards review found names in the User Credit Balance API that repeat their block’s name, or that don’t say what a block holds. Thedetails block holds the loan’s terms, and the rates describe those same terms. The API is in preview, so these changes ship without a new API version.What Changed
The
interest block no longer exists. amount_breakdown.interest is unchanged. The expected_ names inside terms are unchanged.What You Need To Do
- Send the three rates and
structureinsidetermswhen you create a user credit balance, and read them fromtermsin responses. - Use
terms.durationinstead ofdetails.term. - When you update a user credit balance with
PATCH, useterms.interest_rate,terms.effective_interest_rate, andpast_due.days.
Who This Affects
Partners who started building against the User Credit Balance API from the preview docs.User Credit Balance Status Endpoints Return 422 When Nothing Changes
Why We Made This Change
A200 from an action endpoint used to mean either “the status changed” or “it was already in that status”, so you had to compare the response with what you knew to tell whether your call did anything. The API is in preview, so this change ships without a new API version.What Changed
A retry with the same
Idempotency-Key still returns the original response. A 200 now always means the status changed.What You Need To Do
If your code treats a repeated status call as success, handleobject_status_unchanged the same way. It means the user credit balance is already in the status you asked for.Who This Affects
Partners who started building against the User Credit Balance API from the preview docs.User Credit Balance Field and Value Changes
Why We Made This Change
An API standards review found three names and formats in the User Credit Balance API that didn’t match Lead’s API standards. The API is in preview, so these changes ship without a new API version.What Changed
What You Need To Do
- Send
interest.effective_aprwith exactly 6 decimals when you create a user credit balance. If your code reads or compares this value, expect 6 decimals in responses. - Send
partner_closedinstead ofclient_closedas thestatus_reasonwhen you close a user credit balance. If your code readsstatus_reason, handlepartner_closed. - Use
details.repaymentinstead ofdetails.repayment_detailswhen you create, update, or read a user credit balance.

