Skip to content
API docs
Sign inOpen app

Credits

List credit history

GET/v1/workspaces/{workspaceId}/credits/history

Every change to the workspace's credits, newest first, a page at a time. Any member or API key can read it.

Path parameters

  • workspaceIdstringrequired

    The workspace's id. An API key can only use its own workspace.

Query parameters

  • cursorstring

    The cursor from the previous page. Leave it out for the first page.

  • limitinteger

    How many entries per page, from 1 to 100. Defaults to 50.

    1–100

Response

  • entriesarray of objectrequired
    Show 9 fields
    • kindenumrequired

      What changed the credits: use, topUp, refund, grant or settle. settle is last month's overage, repaid from this month's free credits.

      One of "use", "topUp", "refund", "grant", "settle"

    • amountUsdnumberrequired
    • fromAllowanceUsdnumberrequired

      How much came from the month's free credits. Set for use and settle.

    • balanceChangeUsdnumberrequired

      How much was added to the topped-up balance, or taken from it when negative.

    • atnumberrequired

      When it happened, in milliseconds since the epoch.

    • meterenum

      The check that was charged. Set for use.

      One of "phoneVerification", "emailValidation", "telegramCheck", "aiAutocomplete"

    • countrystring

      The ISO country code of a phone check.

    • formIdstring

      The form that ran the check. Set when you can see its brand.

    • notestring
  • cursorstring or nullrequired

    Pass it back as cursor to get the next page. Null on the last page. See Pagination.

Errors answer with a status and the error shape.