User limit
Definition
A User limit caps the total amount Aria will finance for a single User at a given time. It is the User-level equivalent of a Credit limit, which caps financing for a single Debtor.
User limits are only used for some Aria clients. Whether you need them is decided during your onboarding with Aria. If User limits were not enabled for you at onboarding, you can ignore this feature and the related webhooks.
Creation
You cannot create User limits through the API. Aria creates a User limit automatically every time a new User is created on your company, provided User limits are enabled for you.
A new User limit starts with:
status:PROCESSINGamount:null
Aria then decides the User limit asynchronously. When the decision is made, the status changes to ACCEPTED (with an amount) or REFUSED. The amount of an ACCEPTED User limit can also evolve over time as Aria re-decides the limit.
Because everything happens asynchronously, you should subscribe to the User limit webhooks to be notified when a User limit is created and when its status or amount changes.
Statuses
PROCESSING: The User limit has been created but Aria has not assigned an amount yet.ACCEPTED: Aria has accepted the User limit and set anamount.REFUSED: Aria has refused to set a positive amount for this User.refusalReasonsis populated.
How User limits affect Quotes and Loans
When User limits are enabled for you, every Quote and every Loan is checked against the relevant User limit, in addition to the Credit limit check on the Debtor.
The check is the same as for Credit limits: a Quote or a Loan is refused if accepting it would push the User limit's reservedAmount above its amount.
How this plays out in practice:
- Quote creation: the User limit is checked synchronously, at the same time as the Credit limit. If either limit is insufficient, the Quote is refused.
- Loan created from an accepted Quote: the User limit was already checked when the Quote was accepted, and the Quote's amount is already part of
reservedAmount. No further check is needed. - Loan created without a Quote: the User limit is checked synchronously at Loan creation, against its current
reservedAmount.
If the User limit is still PROCESSING at the time a Quote or Loan is created, that Quote or Loan cannot be approved until the User limit reaches a final status.
Outstanding and reserved amounts
outstandingAmount: total Aria has advanced for this User and that remains unpaid.reservedAmount: total currently booked for this User. Includes unpaid Loans and unconsumed accepted Quotes. This is the value compared againstamountwhen evaluating new Quotes and Loans.
Webhooks
If User limits are enabled for you, subscribe to the User limit webhooks to track creation, status changes, and amount updates. See the full event list in our Webhooks guide.
| Event | When it fires |
|---|---|
user-limit.created | A new User limit was created. At this point its status is PROCESSING and amount is null. |
user-limit.updated | The User limit status or amount changed (decision made, amount revised, etc.). |
user-limit.outstanding-amount.updated | The User limit outstandingAmount changed. |
user-limit.reserved-amount.updated | The User limit reservedAmount changed (new Quote accepted, Loan created or repaid, etc.). |
