> ## Documentation Index
> Fetch the complete documentation index at: https://docs.amlok.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Credit reporting

> Read available and spent credits without payment controls.

Each workspace has one CAD credit balance shared by Insights and Signal. Paid and promotional top-ups join the same balance with no consumption priority.

## Available and spent credits

| Field | Meaning |
| - | - |
| `available_credits` | Credits available to spend now. Successful top-ups add credits; actual product charges and final refunds reduce them. |
| `spent_credits` | Cumulative product charges since the account opened, less corrections that reverse an erroneous charge. |

There are no reserved credits, held balances or separate posted-credit balances. A payment still in progress is visible in funding history, but it becomes credit only after successful completion. An unfinished underwriting has not spent credits. A final cancellation refund is a return of unused credits, not product spend.

`available credits = successful funding + corrections - product charges - cancellation refunds`

Read [the credit balance](https://docs.amlok.io/api-reference/endpoints/billing/retrieve-credit-balance.md) and [consumption reports](https://docs.amlok.io/api-reference/consumption-reporting.md). Transaction timestamps such as `posted_at` identify when a historical entry was recorded; they do not describe another kind of credit.

## Automatic top-ups

The trigger uses **available credits**. With auto-pay enabled, a balance strictly below the configured threshold triggers the selected payment. The threshold is at least **CAD 200.00** and the customer-funded top-up is at least **CAD 500.00**. At exactly the threshold, no below-threshold trigger has occurred.

The [billing account](https://docs.amlok.io/api-reference/endpoints/billing/retrieve-billing-account.md) reports the actual `auto_top_up_enabled`, `auto_top_up_threshold` and `auto_top_up_amount` settings. Only the portal changes them. Payment attempts are deduplicated while the same top-up is in progress; every usage debit must not launch another duplicate collection. Failed collections leave credits unchanged and follow the portal's payment handling, without allowing a negative balance.

Processing can use credits below CAD 200.00 if the balance covers its cost. Read-only reports remain accessible without a new product charge. See [processing lifecycle](https://docs.amlok.io/api-reference/processing-lifecycle.md) for insufficient-credit handling.

## Portal and API responsibilities

The client portal manages card/bank payment methods, top-ups, automatic-payment settings and cancellation. Enterprise clients can also request cancellation through their account manager. The public API provides reports and exports only. There are no wallet-management, payment, top-up, refund-request, transfer or cancellation commands.

## Cancellation

Cancellation immediately stops processing, deductions, and upcoming top-ups. Unfinished work creates no charge. Full account closure occurs at the end of the request month. AMLOK immediately refunds all remaining available credits, including promotional top-ups, to the saved portal bank account. Correctly spent credits are non-refundable. Bank receipt can take 7-10 business days after issuance.

Data is deleted after that month closes and necessary final information is generated. Export needed evidence before deletion. Necessary final billing and refund records are retained separately, without borrower data or continuing workspace API access. See [cancellation and refunds](https://docs.amlok.io/pricing/refunds-and-payouts.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.