Skip to content

Usage

View as Markdown

Each business has a monthly document allowance and a limit on how far back Lazy scans its email. Your contract with Lazy sets both. You can read a business’s usage at any time and raise either limit for one business. Purchases are billed to your platform in its next monthly bill.

  • Usage object: documents used this period, and the two limits.
Endpoint Request
Get usage GET /v1/businesses/{biz_id}/usage
Top up documents POST /v1/businesses/{biz_id}/upgrade/top-up
Extend the scan period POST /v1/businesses/{biz_id}/upgrade/scan-period

Purchases are not safe to send twice. Before you build a retry around them, read Retries and idempotency.