verae-zapier-middleware.store.usage

Generated API sheet for verae-zapier-middleware/store/usage.

# `verae-zapier-middleware/store/usage`

**Package:** `verae-zapier-middleware`  
**Source:** `packages/verae-zapier-middleware/src/store/usage.js`  
**Lines:** 103

## What this module is

Implementation module in `verae-zapier-middleware`. The tables below are extracted from the source (signatures + JSDoc).

## Exports

`getUsage`, `getUsageSummary`, `incrementUsage`

## Types / interfaces / classes

_None extracted._

## Functions

| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|------|------------|---------------------|---------|-----------------------------|
| `currentPeriod` | `(none)` | — | `string` — YYYY-MM period key | see Call graph |
| `emptyUsage` | `tenantId` | tenantId: `string` | `{ period: string, timestamps: number, verifications: number, statusChecks: number, batchTimestamps: number, overage: object ` — } | see Call graph |
| `getUsage` | `tenantId` | tenantId: `string` | `ReturnType<typeof emptyUsage>` | see Call graph |
| `getUsageSummary` | `tenantId` | tenantId: `string` | `object` | see Call graph |
| `incrementUsage` | `tenantId, metric, amount = 1` | tenantId: `string`, metric: `string`, amount: `number` | `void` | see Call graph |

## Methods (class / object)

| Name | Parameters |
|------|------------|
| `getStore` | `(none)` |
| `persist` | `(none)` |

## What it imports / requires

- `./db.js`
- `./tenants.js`
- `../debug/logger.js`

## Call graph (identifiers invoked)

`createDebugger`, `currentPeriod`, `getUTCFullYear`, `getUTCMonth`, `padStart`, `emptyUsage`, `getUsage`, `getStore`, `getUsageSummary`, `getTenant`, `resolveLimits`, `incrementUsage`, `startsWith`, `slice`, `persist`, `debug`

Each identifier is a call site in this file. Follow the import list to see the defining module; open that module’s MD for parameter and return types.

## Return values (how to read this)

- HTTP route handlers return Express `res.json(...)` bodies (see route docs).
- Zapier `perform` functions return a **single object** (creates) or an **array** (triggers/searches).
- Pricing functions return integer **cents** on `Quote.totalCents`.