Billing

Sync closed billing ledger overage to Stripe

Admin-only endpoint that scans closed billing period ledgers with overage credits and sends one Stripe Billing Meter Event per eligible ledger. Only overage credits are synced; included credits remain covered by the subscription price.

post/admin/billing/stripe/sync-overage

Request

  • Base URL: https://api.crawlora.net/api/v1
  • URL: https://api.crawlora.net/api/v1/admin/billing/stripe/sync-overage
  • Auth: API key in header x-api-key

Query parameters

limitinteger

Maximum ledgers to scan. Defaults to 500 and clamps to 5000.

Headers

x-api-keystring required

Admin API key required unless an Admin JWT is already present

Response

Stripe overage sync summary

codeinteger
msgstring

Example response

{
  "code": 200,
  "data": {
    "errors": [
      {
        "error": "stripe customer id is required",
        "period_key": "2026-04",
        "user_id": "user-1"
      }
    ],
    "failed": 1,
    "scanned": 500,
    "skipped": 1,
    "synced": 498
  },
  "msg": "OK"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.