Credit ledger

Request#

Authenticate with your API key in the x-api-key header (see Authentication).

Parameters#

• limitintegerdefault 50min 1, max 200
• beforeinteger | nullmin 1

  Return entries with an id below this.

Example request#

curl "https://api.scrapercompany.com/v1/billing/ledger?limit=20" \
  -H "x-api-key: $SCRAPERCOMPANY_API_KEY"

Response#

200 — Credit movements, newest first.

{
  "entries": [
    {
      "id": 912,
      "kind": "usage",
      "amount": -5,
      "balance_after": 48210,
      "route": "/v1/calendar",
      "request_id": "req_0123456789abcdef0123456789abcdef",
      "detail": {},
      "created_at": "2026-10-14T09:12:44.120000+00:00"
    },
    {
      "id": 3,
      "kind": "grant",
      "amount": 50000,
      "balance_after": 50000,
      "detail": {
        "plan": "starter",
        "reason": "plan change"
      },
      "created_at": "2026-10-01T00:00:03.000000+00:00"
    }
  ]
}

Response fields#

Fields marked required are always present; others appear when they apply.

• entriesarray of objectrequired

  Newest first.

  Show 8 child fieldsHide child fields

  • entries[].idintegerrequired

    Entry id; pass the last one as before to page.

  • entries[].kindstringrequired

    usage, grant, expiry, refund, adjustment, ...

  • entries[].amountintegerrequired

    Signed credit change (negative for usage).

  • entries[].balance_afterintegerrequired
  • entries[].routestring

    Route template for usage entries.

  • entries[].request_idstring

    x-request-id of the charged request.

  • entries[].detailobject
  • entries[].created_atstring (date-time)required
• next_beforeinteger | nullrequired

  Pass as before for the next page; null on the last page.

Errors#

Errors return a JSON body with a detail field. Failed requests are not charged. See Errors for the full list and retry advice.

Try it#

1. Export your key: export SCRAPERCOMPANY_API_KEY=sk_... (no key yet? request access).
2. Copy the cURL example above and run it in a terminal.
3. Or open the interactive playground on api.scrapercompany.com, paste your key and pick this endpoint.