Skip to content
User

Auto Billing Reset

Configure automatic billing cycle resets when credit usage crosses a threshold

The v1 API, for batchesSquids, tasks and runs: many calls on a schedule, delivered where you work. For one call that answers in seconds, use the API v2.
GEThttps://api.lobstr.io/v1/plans/auto-reset

Automatically reset your billing cycle when credit usage crosses a configurable threshold — so your scrapers never stall waiting for a manual reset. A rolling 24-hour cap protects against runaway spending.

How it works

When Auto Billing Reset is enabled, a background poller checks your credit usage periodically. Once your usage exceeds threshold_pct, it triggers a billing cycle reset: your plan renews immediately (charging your card on file) and your credits are restored to zero consumed. The max_resets_per_24h cap limits how many times this can happen in any rolling 24-hour window.

If the payment fails (including 3D Secure cards, which cannot complete authentication unattended), the reset is suppressed for the rest of the current billing cycle and you receive a failure email.

Get settings

Authorizationstringheaderrequired

Your API authentication token. Value: Token YOUR_API_KEY

Returns your current Auto Billing Reset configuration and live usage status.

Response fields

enabledboolean

Whether Auto Billing Reset is currently active.

threshold_pctinteger

Credit usage percentage that triggers a reset. Example: 80 (reset when 80% of credits are consumed).

max_resets_per_24hinteger

Maximum number of automatic resets allowed in any rolling 24-hour window (1–10).

resets_used_in_windowinteger

Number of resets that have already fired in the current 24-hour window.

window_resets_atstring | null

UTC timestamp when the current 24-hour window expires and the counter resets, or null if no window is active.

current_usage_pctnumber | null

Your current credit usage as a percentage of your plan's allowance, or null if no active subscription.

Update settings

https://api.lobstr.io/v1/plans/auto-reset
Authorizationstringheaderrequired

Your API authentication token. Value: Token YOUR_API_KEY

Content-Typestringheaderrequired

Must be application/json. Value: application/json

enabledbooleanrequired

Enable or disable Auto Billing Reset.

threshold_pctinteger

Credit usage percentage that triggers a reset. Must be between 1 and 100. Defaults to your current setting.

max_resets_per_24hinteger

Maximum automatic resets in any rolling 24-hour window. Must be between 1 and 10. Defaults to your current setting.

If you POST with enabled: true and your usage is already above threshold_pct, an immediate reset is triggered.

Auto Billing Reset charges your card on file each time it fires. Ensure max_resets_per_24h is set to a value you're comfortable with before enabling.

Code Examples

curl -X GET "https://api.lobstr.io/v1/plans/auto-reset" \
  -H "Authorization: Token YOUR_API_KEY"

GET Response

200
{
  "enabled": true,
  "threshold_pct": 80,
  "max_resets_per_24h": 2,
  "resets_used_in_window": 1,
  "window_resets_at": "2026-08-02T14:30:00Z",
  "current_usage_pct": 73.4
}

POST Response

200
{
  "enabled": true,
  "threshold_pct": 80,
  "max_resets_per_24h": 2,
  "resets_used_in_window": 0,
  "window_resets_at": null,
  "current_usage_pct": 73.4
}