Billing

Get credit usage history

Returns credit-consuming activity for the team's organization, newest first - what each charge was for, when, which brand, and how many credits. Filter with q, teams, categories (snowy | ai-visibility | content | seo-audit | knowledge-base | other), creditMin/creditMax and startDate/endDate (inclusive calendar days, resolved in timeZone). Returns one page plus a nextCursor; pass it back as cursor to keep reading, and keep going before concluding a total. Use for questions like 'what did I spend credits on' or 'why did my balance drop'.

get/v3/billing/usage-history

Query parameters

teamIdstring

Active team (membership only)

limitstring

Max number of entries (default 30, max 100), or "all" for the full filtered history in one response (CSV export)

cursorstring

Keyset pagination cursor from a prior response

qstring

Free-text search over title/description

teamsstring

Comma-separated teamIds to narrow within the org

categoriesstring

Comma-separated: snowy | ai-visibility | content

creditMinnumber

Min credits per row

creditMaxnumber

Max credits per row

startDatestring

Only entries on/after this calendar day (YYYY-MM-DD)

endDatestring

Only entries on/before this calendar day (YYYY-MM-DD)

timeZonestring

IANA zone the day bounds are calendar days in, e.g. Asia/Kolkata. Defaults to UTC

Changes

Changed in 4 of the 47 revisions of this API.25

  • e0163b1c37cb11See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    • ○

      endpoint added

      endpoint-added

    • ○

      added the new optional query request parameter timeZone

      new-optional-request-parameter

    • ○

      added the new optional query request parameter endDate

      new-optional-request-parameter

    • ○

      added the new optional query request parameter startDate

      new-optional-request-parameter

    • ▲

      added the pattern ^(all|[1-9][0-9]*)$ to the query request parameter limit

      request-parameter-pattern-added

    • ○

      for the query request parameter limit, the type was generalized from integer to string

      request-parameter-type-generalized